Users

Get all users in the tenant

get
Authorizations
Responses
200
OK
get
GET /v1/users HTTP/1.1
Host: 
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
Body

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

InvitedBystring | nullableOptional

Who invited the user

Messagestring | nullableOptional

Message to include in the invitation

Responses
200
OK
post
POST /v1/users HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Content-Type: application/json-patch+json
Accept: */*
Content-Length: 177

{
  "UserEmail": "text",
  "TenantRoleUids": [
    "123e4567-e89b-12d3-a456-426614174000"
  ],
  "TenantUserGroupUids": [
    "123e4567-e89b-12d3-a456-426614174000"
  ],
  "InvitedBy": "text",
  "Message": "text"
}
No content
put
Authorizations
Body

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
put
PUT /v1/users HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Content-Type: application/json-patch+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
Path parameters
uidstringRequired
Responses
200
OK
get
GET /v1/users/{uid} HTTP/1.1
Host: 
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
Path parameters
uidstringRequired
Responses
200
OK
delete
DELETE /v1/users/{uid} HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

No content
PreviousUserRolesNextVariantGroups