BeyondTrust · Schema

CredentialResponse

Credentials retrieved for an approved access request.

AccessAccess ManagementComplianceCredentialsPrivileged AccessSecuritySecretsZero Trust

Properties

Name Type Description
Password string The retrieved password. Only present for password-based accounts.
PrivateKey string SSH private key. Only present for SSH key-based accounts.
View JSON Schema on GitHub

JSON Schema

beyondtrust-credential-response-schema.json Raw ↑ 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/beyondtrust/refs/heads/main/json-schema/beyondtrust-credential-response-schema.json",
  "title": "CredentialResponse",
  "description": "Credentials retrieved for an approved access request.",
  "type": "object",
  "properties": {
    "Password": {
      "type": "string",
      "nullable": true,
      "description": "The retrieved password. Only present for password-based accounts.",
      "example": "Xk2!mP9@nQ7#rT5"
    },
    "PrivateKey": {
      "type": "string",
      "nullable": true,
      "description": "SSH private key. Only present for SSH key-based accounts.",
      "example": null
    }
  }
}