Credential vault API - JSON models

Parameters JSON model

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..	required
ownerAccessOnly	boolean	The credentials set is available to every user (`false`) or to owner only (`true`).	optional
type	string	Defines the actual set of fields depending on the value. See one of the following objects: `CERTIFICATE` -> CertificateCredentials `USERNAME_PASSWORD` -> UserPasswordCredentials `TOKEN` -> TokenCredentials The type element can hold these values.	optional
certificate	string	The certificate in the string format.	required
password	string	The password of the credential.	required
certificateFormat	string	The certificate format. The certificateFormat element can hold these values.	required

Possible values

Possible values for the certificateFormat element:

PEM
PKCS12
UNKNOWN

Possible values for the type element:

CERTIFICATE
TOKEN
USERNAME_PASSWORD

{
  "name": "string",
  "id": "string",
  "description": "string",
  "password": "string",
  "ownerAccessOnly": true,
  "type": "CERTIFICATE",
  "certificate": "string"
}

TokenCredentials

Parameters JSON model

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..	required
ownerAccessOnly	boolean	The credentials set is available to every user (`false`) or to owner only (`true`).	optional
type	string	Defines the actual set of fields depending on the value. See one of the following objects: `CERTIFICATE` -> CertificateCredentials `USERNAME_PASSWORD` -> UserPasswordCredentials `TOKEN` -> TokenCredentials The type element can hold these values.	optional
token	string	Token in the string format.	required

Possible values

Possible values for the type element:

CERTIFICATE
TOKEN
USERNAME_PASSWORD

{
  "name": "string",
  "id": "string",
  "description": "string",
  "password": "string",
  "ownerAccessOnly": true,
  "type": "TOKEN",
  "token": "string"
}

UserPasswordCredentials

Parameters JSON model

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..	required
ownerAccessOnly	boolean	The credentials set is available to every user (`false`) or to owner only (`true`).	optional
type	string	Defines the actual set of fields depending on the value. See one of the following objects: `CERTIFICATE` -> CertificateCredentials `USERNAME_PASSWORD` -> UserPasswordCredentials `TOKEN` -> TokenCredentials The type element can hold these values.	optional
user	string	The username of the credentials set.	required
password	string	The password of the credential.	required

Possible values

Possible values for the type element:

CERTIFICATE
TOKEN
USERNAME_PASSWORD

{
  "name": "string",
  "id": "string",
  "description": "string",
  "password": "string",
  "ownerAccessOnly": true,
  "type": "USERNAME_PASSWORD",
  "user": "string"
}