Credential vault API - JSON models
JSON models of the Credential vault API vary depending on the type of the object. Here you can find JSON models for each variation.
Variations of the Credentials object
The Credentials object is the base for all credentials. The actual set of fields depends on the type of the credentials.
CERTIFICATE
The CertificateCredentials object
A set of credentials for synthetic monitors.
The actual set of fields depends on the type of credentials. Find the list of actual objects in the description of the type field or see Credential vault API - JSON models.
| Element | Type | Description |
|---|---|---|
| certificate | string | The certificate in the string format. |
| certificateFormat | string | The certificate format.
|
| password | string | The password of the credential (Base64 encoded). |
PUBLIC_CERTIFICATE
The PublicCertificateCredentials object
A set of credentials for synthetic monitors.
The actual set of fields depends on the type of credentials. Find the list of actual objects in the description of the type field or see Credential vault API - JSON models.
| Element | Type | Description |
|---|---|---|
| certificate | string | The certificate in the string format. |
| certificateFormat | string | The certificate format.
|
| password | string | The password of the credential (not supported). |
TOKEN
The TokenCredentials object
A set of credentials for synthetic monitors.
The actual set of fields depends on the type of credentials. Find the list of actual objects in the description of the type field or see Credential vault API - JSON models.
| Element | Type | Description |
|---|---|---|
| externalVault | ExternalVault | Information for synchronization credentials with external vault |
| token | string | Token in the string format. |
The ExternalVault object
Information for synchronization credentials with external vault
| Element | Type | Description |
|---|---|---|
| locationForSynchronizationId | string | Id of a location used by the synchronizing monitor |
| passwordSecretName | string | The name of the secret saved in external vault where password is stored. |
| sourceAuthMethod | string | Defines the actual set of fields depending on the value. See one of the following objects:
|
| tokenSecretName | string | The name of the secret saved in external vault where token is stored. |
| usernameSecretName | string | The name of the secret saved in external vault where username is stored. |
| vaultUrl | string | External vault URL. |
USERNAME_PASSWORD
The UserPasswordCredentials object
A set of credentials for synthetic monitors.
The actual set of fields depends on the type of credentials. Find the list of actual objects in the description of the type field or see Credential vault API - JSON models.
| Element | Type | Description |
|---|---|---|
| externalVault | ExternalVault | Information for synchronization credentials with external vault |
| password | string | The password of the credential. |
| user | string | The username of the credentials set. |
The ExternalVault object
Information for synchronization credentials with external vault
| Element | Type | Description |
|---|---|---|
| locationForSynchronizationId | string | Id of a location used by the synchronizing monitor |
| passwordSecretName | string | The name of the secret saved in external vault where password is stored. |
| sourceAuthMethod | string | Defines the actual set of fields depending on the value. See one of the following objects:
|
| tokenSecretName | string | The name of the secret saved in external vault where token is stored. |
| usernameSecretName | string | The name of the secret saved in external vault where username is stored. |
| vaultUrl | string | External vault URL. |