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 credentials set of the CERTIFICATE type.

Element
Type
Description
certificate
string

The certificate in the string format.

certificateFormat
string

The certificate format.

  • PEM
  • PKCS12
  • UNKNOWN
password
string

The password of the credential (Base64 encoded).

PUBLIC_CERTIFICATE

The PublicCertificateCredentials object

A credentials set of the PUBLIC_CERTIFICATE type.

Element
Type
Description
certificate
string

The certificate in the string format.

certificateFormat
string

The certificate format.

  • PEM
  • PKCS12
  • UNKNOWN
password
string

The password of the credential (not supported).

TOKEN

The TokenCredentials object

A credentials set of the TOKEN type.

Element
Type
Description
externalVault

Information for synchronization credentials with external vault

token
string

Token in the string format.

The ExternalVault object

Information for synchronization credentials with external vault

Element
Type
Description
locationForSynchronizationId
string

Id of a location used by the synchronizing monitor

passwordSecretName
string

The name of the secret saved in external vault where password is stored.

sourceAuthMethod
string

Defines the actual set of fields depending on the value. See one of the following objects:

  • HASHICORP_VAULT_APPROLE -> HashicorpApprole
  • HASHICORP_VAULT_CERTIFICATE -> HashicorpCertificate
  • AZURE_KEY_VAULT_CLIENT_SECRET -> AzureClientSecret
  • CYBERARK_VAULT_USERNAME_PASSWORD -> CyberArkUsernamePassword
  • CYBERARK_VAULT_ALLOWED_LOCATION -> CyberArkAllowedLocationDto
  • AZURE_KEY_VAULT_CLIENT_SECRET
  • CYBERARK_VAULT_ALLOWED_LOCATION
  • CYBERARK_VAULT_USERNAME_PASSWORD
  • HASHICORP_VAULT_APPROLE
  • HASHICORP_VAULT_CERTIFICATE
tokenSecretName
string

The name of the secret saved in external vault where token is stored.

usernameSecretName
string

The name of the secret saved in external vault where username is stored.

vaultUrl
string

External vault URL.

USERNAME_PASSWORD

The UserPasswordCredentials object

A credentials set of the USERNAME_PASSWORD type.

Element
Type
Description
externalVault

Information for synchronization credentials with external vault

password
string

The password of the credential.

user
string

The username of the credentials set.

The ExternalVault object

Information for synchronization credentials with external vault

Element
Type
Description
locationForSynchronizationId
string

Id of a location used by the synchronizing monitor

passwordSecretName
string

The name of the secret saved in external vault where password is stored.

sourceAuthMethod
string

Defines the actual set of fields depending on the value. See one of the following objects:

  • HASHICORP_VAULT_APPROLE -> HashicorpApprole
  • HASHICORP_VAULT_CERTIFICATE -> HashicorpCertificate
  • AZURE_KEY_VAULT_CLIENT_SECRET -> AzureClientSecret
  • CYBERARK_VAULT_USERNAME_PASSWORD -> CyberArkUsernamePassword
  • CYBERARK_VAULT_ALLOWED_LOCATION -> CyberArkAllowedLocationDto
  • AZURE_KEY_VAULT_CLIENT_SECRET
  • CYBERARK_VAULT_ALLOWED_LOCATION
  • CYBERARK_VAULT_USERNAME_PASSWORD
  • HASHICORP_VAULT_APPROLE
  • HASHICORP_VAULT_CERTIFICATE
tokenSecretName
string

The name of the secret saved in external vault where token is stored.

usernameSecretName
string

The name of the secret saved in external vault where username is stored.

vaultUrl
string

External vault URL.