BeyondTrust · JSON Structure

Beyondtrust Session Response Structure

Authenticated user session details.

Type: object Properties: 4
AccessAccess ManagementComplianceCredentialsPrivileged AccessSecuritySecretsZero Trust

SessionResponse is a JSON Structure definition published by BeyondTrust, describing 4 properties. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

UserId EmailAddress UserName Name

Meta-schema: https://json-structure.org/meta/core/v0/#

JSON Structure

Raw ↑ 
{
  "$schema": "https://json-structure.org/meta/core/v0/#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/beyondtrust/refs/heads/main/json-structure/beyondtrust-session-response-structure.json",
  "name": "SessionResponse",
  "description": "Authenticated user session details.",
  "type": "object",
  "properties": {
    "UserId": {
      "type": "int32",
      "description": "Internal user ID.",
      "example": 42
    },
    "EmailAddress": {
      "type": "string",
      "format": "email",
      "description": "Email address of the authenticated user.",
      "example": "apiuser@example.com"
    },
    "UserName": {
      "type": "string",
      "description": "Username of the authenticated user.",
      "example": "api-service-account"
    },
    "Name": {
      "type": "string",
      "description": "Display name of the authenticated user.",
      "example": "API Service Account"
    }
  }
}