BeyondTrust · Schema

SessionResponse

Authenticated user session details.

AccessAccess ManagementComplianceCredentialsPrivileged AccessSecuritySecretsZero Trust

Properties

Name Type Description
UserId integer Internal user ID.
EmailAddress string Email address of the authenticated user.
UserName string Username of the authenticated user.
Name string Display name of the authenticated user.
View JSON Schema on GitHub

JSON Schema

beyondtrust-session-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-session-response-schema.json",
  "title": "SessionResponse",
  "description": "Authenticated user session details.",
  "type": "object",
  "properties": {
    "UserId": {
      "type": "integer",
      "description": "Internal user ID.",
      "example": 42
    },
    "EmailAddress": {
      "type": "string",
      "format": "email",
      "description": "Email address of the authenticated user.",
      "example": "[email protected]"
    },
    "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"
    }
  }
}