v1

latestOpenAPI 3.1.0Apache 2.02026-07-245981,1853.0 MB

System Credentials

Update System Credential

Use this API to update details for an existing credential.

put/v2/credentials/{type}

Path parameters

type'HTTP' required

Specify the connector type.

Query parameters

namestring required

Name of the credential to update.

Request body

namestring required

Unique name that identifies this credential.

authType'BASIC' | 'API_KEY' | 'BEARER_TOKEN' | 'OAUTH2_TOKEN' | 'CUSTOM' required

Authentication type represented by this credential.

descriptionstring

Human‚Äëreadable purpose for this credential.

integrationNamestring required

Name of the integration associated with this credential.

Example request

{
  "name": "my-prod-credentials",
  "authType": "OAUTH2_TOKEN",
  "authContext": {
    "headers": {
      "Content-Type": "application/x-www-form-urlencoded"
    },
    "type": "BASIC",
    "hostName": "example.com",
    "testUrl": "https://example.com/sample/test",
    "connectorType": "HTTP",
    "mtlsEnabled": true,
    "clientCertificate": "-----BEGIN CERTIFICATE-----\nMIIDazCCAlOgAwIBAgIUJlq+zz4...\n-----END CERTIFICATE-----",
    "privateKey": "-----BEGIN PRIVATE KEY-----\nMIIEvQIBADANBgkqhkiG9w0...\n-----END PRIVATE KEY-----",
    "privateKeyPassword": "keypassword",
    "serverRootCACertificate": "-----BEGIN CERTIFICATE-----\nMIIDazCCAlOgAwIBAgIUJlq+zz4...\n-----END CERTIFICATE-----",
    "userName": "Credential_Username",
    "password": "Credential_Password"
  },
  "description": "Used for authenticating with the production environment",
  "integrationName": "systemName"
}

Response

Accepted