JSON models of the Credential vault API vary depending on the type of the object. Here you can find JSON models for each variation.
Credentials objectThe Credentials object is the base for all credentials. The actual set of fields depends on the type of the credentials.
CertificateCredentials objectA credentials set of the CERTIFICATE type.
The certificate in the string format.
The certificate format.
PEMPKCS12UNKNOWNThe password of the credential (Base64 encoded).
{"name": "string","id": "string","description": "string","password": "string","ownerAccessOnly": true,"type": "CERTIFICATE","certificate": "string"}
PublicCertificateCredentials objectA credentials set of the PUBLIC_CERTIFICATE type.
The certificate in the string format.
The certificate format.
PEMPKCS12UNKNOWNThe password of the credential (not supported).
{"name": "string","id": "string","description": "string","password": "string","ownerAccessOnly": true,"type": "CERTIFICATE","certificate": "string"}
TokenCredentials objectA credentials set of the TOKEN type.
Token in the string format.
ExternalVault objectInformation for synchronization credentials with external vault
Id of a location used by the synchronizing monitor
The name of the secret saved in external vault where password is stored.
Defines the actual set of fields depending on the value. See one of the following objects:
HASHICORP_VAULT_APPROLE -> HashicorpApproleHASHICORP_VAULT_CERTIFICATE -> HashicorpCertificateAZURE_KEY_VAULT_CLIENT_SECRET -> AzureClientSecretCYBERARK_VAULT_USERNAME_PASSWORD -> CyberArkUsernamePasswordCYBERARK_VAULT_ALLOWED_LOCATION -> CyberArkAllowedLocationDtoAZURE_KEY_VAULT_CLIENT_SECRETCYBERARK_VAULT_ALLOWED_LOCATIONCYBERARK_VAULT_USERNAME_PASSWORDHASHICORP_VAULT_APPROLEHASHICORP_VAULT_CERTIFICATEThe name of the secret saved in external vault where token is stored.
The name of the secret saved in external vault where username is stored.
External vault URL.
{"name": "string","id": "string","description": "string","password": "string","ownerAccessOnly": true,"type": "TOKEN","token": "string"}
UserPasswordCredentials objectA credentials set of the USERNAME_PASSWORD type.
The password of the credential.
The username of the credentials set.
ExternalVault objectInformation for synchronization credentials with external vault
Id of a location used by the synchronizing monitor
The name of the secret saved in external vault where password is stored.
Defines the actual set of fields depending on the value. See one of the following objects:
HASHICORP_VAULT_APPROLE -> HashicorpApproleHASHICORP_VAULT_CERTIFICATE -> HashicorpCertificateAZURE_KEY_VAULT_CLIENT_SECRET -> AzureClientSecretCYBERARK_VAULT_USERNAME_PASSWORD -> CyberArkUsernamePasswordCYBERARK_VAULT_ALLOWED_LOCATION -> CyberArkAllowedLocationDtoAZURE_KEY_VAULT_CLIENT_SECRETCYBERARK_VAULT_ALLOWED_LOCATIONCYBERARK_VAULT_USERNAME_PASSWORDHASHICORP_VAULT_APPROLEHASHICORP_VAULT_CERTIFICATEThe name of the secret saved in external vault where token is stored.
The name of the secret saved in external vault where username is stored.
External vault URL.
{"name": "string","id": "string","description": "string","password": "string","ownerAccessOnly": true,"type": "USERNAME_PASSWORD","user": "string"}