SuccessResponse_AuthenticatedUser

successboolean

Constant value: true

data object

The authenticated user with current-organization context and role assignments.

idinteger

emailstring<email>

usernamestring | nullnullable

firstNamestring | nullnullable

lastNamestring | nullnullable

fullNamestring | nullnullable

userTypeUserType (string)

Whether the user is a human end-user or a client-managed service account.

Possible values: [human, client-managed]

currentOrganizationIdinteger | nullnullable

ID of the user's active organization; set via POST /organizations/{id}/switch

currentOrganization object

The hydrated active organization, or null

oneOf

• Organization
• null

idinteger

namestring

slugstring

descriptionstring | nullnullable

logoUrlstring,null<uri>nullable

websiteUrlstring,null<uri>nullable

contactEmailstring,null<email>nullable

locationstring | nullnullable

companySizestring | nullnullable

domainstring | nullnullable

accountTypestring

Organization account tier. Enterprise organizations are required for managed-user / service-account provisioning.

Possible values: [individual, team, enterprise]

isVerifiedboolean

memberCountstring

Member count (serialized as a string)

createdAtstring<date-time>

updatedAtstring<date-time>

canWriteToCurrentOrganizationboolean | nullnullable

canModifyCurrentOrganizationboolean | nullnullable

ownsCurrentOrganizationboolean | nullnullable

organizationUserPermissionstring | nullnullable

Derived permission level of the user within their current organization

currentAccessToken object

Metadata about the token used for this request (the raw value is never echoed)

oneOf

• object
• null

typestring

namestring | nullnullable

abilitiesstring[]

lastUsedAtstring,null<date-time>nullable

expiresAtstring,null<date-time>nullable

roles object[]

All role assignments. Inspect for an entry whose organizationId matches the target org to determine the user's org role (e.g. org-client for gating).

Array [

idinteger

namestring

Human-readable role name (e.g. 'Organization Owner')

slugstring

Role slug — org-scoped: org-owner, org-admin, org-member, org-client; platform-level: admin, user, stealth

descriptionstring | nullnullable

organizationIdinteger | nullnullable

Organization this role applies to; null for platform-level roles

]

SuccessResponse_AuthenticatedUser

{
  "success": true,
  "data": {
    "id": 0,
    "email": "user@example.com",
    "username": "string",
    "firstName": "string",
    "lastName": "string",
    "fullName": "string",
    "userType": "human",
    "currentOrganizationId": 0,
    "currentOrganization": {
      "id": 0,
      "name": "string",
      "slug": "string",
      "description": "string",
      "logoUrl": "string",
      "websiteUrl": "string",
      "contactEmail": "user@example.com",
      "location": "string",
      "companySize": "string",
      "domain": "string",
      "accountType": "individual",
      "isVerified": true,
      "memberCount": "string",
      "createdAt": "2024-07-29T15:51:28.071Z",
      "updatedAt": "2024-07-29T15:51:28.071Z"
    },
    "canWriteToCurrentOrganization": true,
    "canModifyCurrentOrganization": true,
    "ownsCurrentOrganization": true,
    "organizationUserPermission": "string",
    "currentAccessToken": {
      "type": "string",
      "name": "string",
      "abilities": [
        "string"
      ],
      "lastUsedAt": "2024-07-29T15:51:28.071Z",
      "expiresAt": "2024-07-29T15:51:28.071Z"
    },
    "roles": [
      {
        "id": 0,
        "name": "string",
        "slug": "string",
        "description": "string",
        "organizationId": 0
      }
    ]
  }
}