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

CertificateCredentials

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

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

TOKEN

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

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

Variations of the Credentials object

CERTIFICATE

The CertificateCredentials object

TOKEN

The TokenCredentials object

USERNAME_PASSWORD

The UserPasswordCredentials object

Variations of the `Credentials` object