Skip to main content

AuthSessionStateResponse

errCodeintegerrequired
Constant value: 0
errMessagestringrequired
Constant value:
data objectrequired
authenticatedbooleanrequired
principal object
kindAuthPrincipalKindrequired

Possible values: [admin_key, admin_session, user_session, api_key]

userIdstring
displayNamestring
emailstring<email>
permissionsPermissionKey[]

Possible values: [system.admin, users.read, users.manage, roles.read, roles.manage, api_keys.manage_self, api_keys.manage_all, projects.create, projects.read_public, projects.read_all, projects.manage_own, projects.manage_all, projects.delete, projects.upload, projects.publish, projects.download_source, storage.write, kv.read, kv.manage, knowledge.manage, audit.read, audit.export]

apiKeyIdstring
expiresAtstring<date-time>

The current API Key expiration. A successfully authenticated Desktop Key uses sliding renewal.

roleNamesstring[]
accessTokenstring

The API Key plaintext returned when a non-Web client requests source=desktop or source=cli; it is returned only once.

apiKey object
idstringrequired
userIdstringrequired
namestringrequired
prefixstringrequired
sourcestringrequired
scopesstring[]required
createdByUserIdstring
createdAtstring<date-time>required
expiresAtstring<date-time>
revokedAtstring<date-time>
lastUsedAtstring<date-time>
lastUsedIpstring
userAgentstring
user object
userIdstringrequired
emailstring<email>required
displayNamestringrequired
expiresAtstring<date-time>
AuthSessionStateResponse
{
  "errCode": 0,
  "errMessage": "string",
  "data": {
    "authenticated": true,
    "principal": {
      "kind": "admin_key",
      "userId": "string",
      "displayName": "string",
      "email": "user@example.com",
      "permissions": [
        "system.admin"
      ],
      "apiKeyId": "string",
      "expiresAt": "2024-07-29T15:51:28.071Z",
      "roleNames": [
        "string"
      ]
    },
    "accessToken": "string",
    "apiKey": {
      "id": "string",
      "userId": "string",
      "name": "string",
      "prefix": "string",
      "source": "string",
      "scopes": [
        "string"
      ],
      "createdByUserId": "string",
      "createdAt": "2024-07-29T15:51:28.071Z",
      "expiresAt": "2024-07-29T15:51:28.071Z",
      "revokedAt": "2024-07-29T15:51:28.071Z",
      "lastUsedAt": "2024-07-29T15:51:28.071Z",
      "lastUsedIp": "string",
      "userAgent": "string"
    },
    "user": {
      "userId": "string",
      "email": "user@example.com",
      "displayName": "string"
    },
    "expiresAt": "2024-07-29T15:51:28.071Z"
  }
}