Users

Get all users in the tenant

get

Authorizations

ApiKey

AuthorizationstringRequired

Responses

200

OK

application/json

Represents a user in the tenant

Uidstring · nullableOptional

Unique identifier for the user

Emailstring · nullableOptional

Email address for the user

Firstnamestring · nullableOptional

Firstname of the user

Lastnamestring · nullableOptional

Lastname of the user

Statusinteger · enumOptional

Represents a status for a user

• 0 = Invited: User has been invited but not yet activated
• 1 = Active: User is active and can log in
• 2 = Disabled: User is disabled and cannot log in

Possible values:

UserGroupsstring · uuid[] · nullableOptional

Groups the user is a member of

Rolesstring · uuid[] · nullableOptional

Roles the user is a member of

404

Not Found

application/json

get

/v1/users

HTTPcURLJavaScriptPython

GET /v1/users HTTP/1.1
Authorization: YOUR_API_KEY
Accept: */*

{
  "Uid": "text",
  "Email": "text",
  "Firstname": "text",
  "Lastname": "text",
  "Status": 0,
  "UserGroups": [
    "123e4567-e89b-12d3-a456-426614174000"
  ],
  "Roles": [
    "123e4567-e89b-12d3-a456-426614174000"
  ]
}

Invites a user to the tenant

post

Authorizations

ApiKey

AuthorizationstringRequired

Body

application/json

Model for inviting a user to a tenant

UserEmailstring · nullableOptional

Email of the user to invite

TenantRoleUidsstring · uuid[] · nullableOptional

Roles to assign to the user

TenantUserGroupUidsstring · uuid[] · nullableOptional

User groups to assign to the user

Messagestring · nullableOptional

Message to include in the invitation

Responses

200

OK

No content

404

Not Found

application/json

post

/v1/users

HTTPcURLJavaScriptPython

POST /v1/users HTTP/1.1
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 158

{
  "UserEmail": "text",
  "TenantRoleUids": [
    "123e4567-e89b-12d3-a456-426614174000"
  ],
  "TenantUserGroupUids": [
    "123e4567-e89b-12d3-a456-426614174000"
  ],
  "Message": "text"
}

No content

put

Authorizations

ApiKey

AuthorizationstringRequired

Body

application/json

Represents a model for updating a user

UserUidstring · nullableOptional

The unique identifier of the user

Rolesstring · uuid[] · nullableOptional

The roles to assign to the user

UserGroupsstring · uuid[] · nullableOptional

The user groups to assign to the user

Responses

200

OK

No content

404

Not Found

application/json

put

/v1/users

HTTPcURLJavaScriptPython

PUT /v1/users HTTP/1.1
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 121

{
  "UserUid": "text",
  "Roles": [
    "123e4567-e89b-12d3-a456-426614174000"
  ],
  "UserGroups": [
    "123e4567-e89b-12d3-a456-426614174000"
  ]
}

No content

Returns a single user from the tenant

get

Authorizations

ApiKey

AuthorizationstringRequired

Path parameters

uidstringRequired

Responses

200

OK

application/json

Represents a user in the tenant

Uidstring · nullableOptional

Unique identifier for the user

Emailstring · nullableOptional

Email address for the user

Firstnamestring · nullableOptional

Firstname of the user

Lastnamestring · nullableOptional

Lastname of the user

Statusinteger · enumOptional

Represents a status for a user

• 0 = Invited: User has been invited but not yet activated
• 1 = Active: User is active and can log in
• 2 = Disabled: User is disabled and cannot log in

Possible values:

UserGroupsstring · uuid[] · nullableOptional

Groups the user is a member of

Rolesstring · uuid[] · nullableOptional

Roles the user is a member of

404

Not Found

application/json

get

/v1/users/{uid}

HTTPcURLJavaScriptPython

GET /v1/users/{uid} HTTP/1.1
Authorization: YOUR_API_KEY
Accept: */*

{
  "Uid": "text",
  "Email": "text",
  "Firstname": "text",
  "Lastname": "text",
  "Status": 0,
  "UserGroups": [
    "123e4567-e89b-12d3-a456-426614174000"
  ],
  "Roles": [
    "123e4567-e89b-12d3-a456-426614174000"
  ]
}

delete

Authorizations

ApiKey

AuthorizationstringRequired

Path parameters

uidstringRequired

Responses

200

OK

No content

404

Not Found

application/json

delete

/v1/users/{uid}

HTTPcURLJavaScriptPython

DELETE /v1/users/{uid} HTTP/1.1
Authorization: YOUR_API_KEY
Accept: */*

No content