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. |
| password | string | The password of the credential (Base64 encoded). |
| certificateFormat | string | The certificate format. The element can hold these values
|
json{
"name": "string",
"id": "string",
"description": "string",
"password": "string",
"ownerAccessOnly": true,
"type": "CERTIFICATE",
"certificate": "string"
}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. |
| password | string | The password of the credential (not supported). |
| certificateFormat | string | The certificate format. The element can hold these values
|
json{
"name": "string",
"id": "string",
"description": "string",
"password": "string",
"ownerAccessOnly": true,
"type": "CERTIFICATE",
"certificate": "string"
}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 |
|---|---|---|
| token | string | Token in the string format. |
| externalVault | External | Information for synchronization credentials with external vault |
The ExternalVault object
Information for synchronization credentials with external vault
| Element | Type | Description |
|---|---|---|
| sourceAuthMethod | string | Defines the actual set of fields depending on the value. See one of the following objects:
The element can hold these values
|
| vaultUrl | string | External vault URL. |
| usernameSecretName | string | The name of the secret saved in external vault where username is stored. |
| passwordSecretName | string | The name of the secret saved in external vault where password is stored. |
| tokenSecretName | string | The name of the secret saved in external vault where token is stored. |
| locationForSynchronizationId | string | Id of a location used by the synchronizing monitor |
json{
"name": "string",
"id": "string",
"description": "string",
"password": "string",
"ownerAccessOnly": true,
"type": "TOKEN",
"token": "string"
}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 |
|---|---|---|
| user | string | The username of the credentials set. |
| password | string | The password of the credential. |
| externalVault | External | Information for synchronization credentials with external vault |
The ExternalVault object
Information for synchronization credentials with external vault
| Element | Type | Description |
|---|---|---|
| sourceAuthMethod | string | Defines the actual set of fields depending on the value. See one of the following objects:
The element can hold these values
|
| vaultUrl | string | External vault URL. |
| usernameSecretName | string | The name of the secret saved in external vault where username is stored. |
| passwordSecretName | string | The name of the secret saved in external vault where password is stored. |
| tokenSecretName | string | The name of the secret saved in external vault where token is stored. |
| locationForSynchronizationId | string | Id of a location used by the synchronizing monitor |
json{
"name": "string",
"id": "string",
"description": "string",
"password": "string",
"ownerAccessOnly": true,
"type": "USERNAME_PASSWORD",
"user": "string"
}