UserApiResponse

successbooleanrequired

messagestring

data object

Endpoint-specific payload.

userIdOpaqueIdrequired

Possible values: <= 128 characters, Value must match regular expression ^[A-Za-z0-9_-]{1,128}$

emailstring<email>required

displayNamestring

roleUserRole

Possible values: [super_admin, admin, agent_admin, agent_user, organization_admin, location_admin, location_user, readonly]

statusUserStatusrequired

Possible values: [ACTIVE, INACTIVE, DISABLED, DELETED]

locationAccess object[]required

Array [

locationIdOpaqueIdrequired

Possible values: <= 128 characters, Value must match regular expression ^[A-Za-z0-9_-]{1,128}$

roleUserRolerequired

Possible values: [super_admin, admin, agent_admin, agent_user, organization_admin, location_admin, location_user, readonly]

organizationIdOpaqueId

Possible values: <= 128 characters, Value must match regular expression ^[A-Za-z0-9_-]{1,128}$

]

organizationAccess object[]required

Array [

organizationIdOpaqueIdrequired

Possible values: <= 128 characters, Value must match regular expression ^[A-Za-z0-9_-]{1,128}$

roleUserRolerequired

Possible values: [super_admin, admin, agent_admin, agent_user, organization_admin, location_admin, location_user, readonly]

]

createdAtstring<date-time>required

UserApiResponse
{
  "success": true,
  "message": "string",
  "data": {
    "userId": "string",
    "email": "user@example.com",
    "displayName": "string",
    "role": "super_admin",
    "status": "ACTIVE",
    "locationAccess": [
      {
        "locationId": "string",
        "role": "super_admin",
        "organizationId": "string"
      }
    ],
    "organizationAccess": [
      {
        "organizationId": "string",
        "role": "super_admin"
      }
    ],
    "createdAt": "2024-07-29T15:51:28.071Z"
  }
}