BeyondTrust · Schema

SignAppInRequest

Authentication credentials for API sign-in.

AccessAccess ManagementComplianceCredentialsPrivileged AccessSecuritySecretsZero Trust

Properties

Name Type Description
ApplicationID string The Application ID registered in BeyondTrust.
APIKey string The API key for the application.
View JSON Schema on GitHub

JSON Schema

beyondtrust-sign-app-in-request-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-sign-app-in-request-schema.json",
  "title": "SignAppInRequest",
  "description": "Authentication credentials for API sign-in.",
  "type": "object",
  "properties": {
    "ApplicationID": {
      "type": "string",
      "description": "The Application ID registered in BeyondTrust.",
      "example": "myapp-api"
    },
    "APIKey": {
      "type": "string",
      "description": "The API key for the application.",
      "example": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
    }
  },
  "required": [
    "ApplicationID",
    "APIKey"
  ]
}