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 Credentials 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 | Required |
|---|---|---|---|
| name | string | The name of the credentials set. | required |
| id | string | The ID of the credentials set. | optional |
| description | string | A short description of the credentials set. | optional |
| ownerAccessOnly | boolean | The credentials set is available to every user ( | optional |
| scope | string | The scope of the credentials set. The element can hold these values
| required |
| type | string | Defines the actual set of fields depending on the value. See one of the following objects:
The element can hold these values
| optional |
json{
"name": "string",
"id": "string",
"description": "string",
"password": "string",
"ownerAccessOnly": true,
"type": "CERTIFICATE",
"certificate": "string"
}TOKEN
The Credentials 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 | Required |
|---|---|---|---|
| name | string | The name of the credentials set. | required |
| id | string | The ID of the credentials set. | optional |
| description | string | A short description of the credentials set. | optional |
| ownerAccessOnly | boolean | The credentials set is available to every user ( | optional |
| scope | string | The scope of the credentials set. The element can hold these values
| required |
| type | string | Defines the actual set of fields depending on the value. See one of the following objects:
The element can hold these values
| optional |
json{
"name": "string",
"id": "string",
"description": "string",
"password": "string",
"ownerAccessOnly": true,
"type": "TOKEN",
"token": "string"
}USERNAME_PASSWORD
The Credentials 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 | Required |
|---|---|---|---|
| name | string | The name of the credentials set. | required |
| id | string | The ID of the credentials set. | optional |
| description | string | A short description of the credentials set. | optional |
| ownerAccessOnly | boolean | The credentials set is available to every user ( | optional |
| scope | string | The scope of the credentials set. The element can hold these values
| required |
| type | string | Defines the actual set of fields depending on the value. See one of the following objects:
The element can hold these values
| optional |
The ExternalVault object
Information for synchronization credentials with external vault
| Element | Type | Description | Required |
|---|---|---|---|
| sourceAuthMethod | string | Defines the actual set of fields depending on the value. See one of the following objects:
The element can hold these values
| required |
| vaultUrl | string | External vault URL. | required |
| usernameSecretName | string | The name of the secret saved in external vault where username is stored. | required |
| passwordSecretName | string | The name of the secret saved in external vault where password is stored. | required |
json{
"name": "string",
"id": "string",
"description": "string",
"password": "string",
"ownerAccessOnly": true,
"type": "USERNAME_PASSWORD",
"user": "string"
}