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.
CERTIFICATE
The CertificateCredentials object
A set of credentials for synthetic monitors.
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 |
type | string |
Defines the actual set of fields depending on the value. See one of the following objects:
|
optional |
certificate | string |
The certificate in the string format. |
required |
password | string |
The password of the credential. |
required |
certificateFormat | string |
The certificate format.
|
required |
{
"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.
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 |
type | string |
Defines the actual set of fields depending on the value. See one of the following objects:
|
optional |
token | string |
Token in the string format. |
required |
{
"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.
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 |
type | string |
Defines the actual set of fields depending on the value. See one of the following objects:
|
optional |
user | string |
The username of the credentials set. |
required |
password | string |
The password of the credential. |
required |
{
"name": "string",
"id": "string",
"description": "string",
"password": "string",
"ownerAccessOnly": true,
"type": "USERNAME_PASSWORD",
"user": "string"
}