User Management API
Endpoint Index
Action | Endpoint |
---|---|
Create a User | POST /auth/users |
Fetch My User Details | GET /auth/users/whoami |
Fetch a User by Name | GET /auth/users/username/{username} |
Fetch a User by Locator | GET /auth/users/{locator} |
Fetch Multiple Users | GET /auth/users/list |
Fetch Multiple Basic Users | GET /auth/users/basic/list |
Update a User | PATCH /auth/users/{locator} |
Reset a User's Password | PATCH /auth/users/{locator}/passwordreset |
Delete a User | DELETE /auth/users/{locator} |
Create a Role | POST /auth/roles |
Fetch a Role | GET /auth/roles/{locator} |
Update a Role | PATCH /auth/roles/{locator} |
Fetch Multiple Roles | GET /auth/roles/list |
Delete a Role | DELETE /auth/roles/{locator} |
Fetch Available Permissions | GET /auth/roles/permissions |
Fetch User Permissions | GET /auth/users/{locator}/permissions |
Update User Roles | PATCH /auth/users/{locator}/roles |
Update a User's Tenant Assignments | PATCH /auth/users/{locator}/tenants |
Users
POST /auth/users
Request:UserCreateRequest
Response:UserResponse
Security Group:users  Permission:add
UserCreateRequest
¶requiredfirstName stringlastName stringuserName string
A user name in email formatpassword stringtemporaryPassword booleanoptionalroles string[]?tenants string[]?
UserResponse
¶requiredlocator uuidfirstName stringlastName stringuserName stringtenants string[]optionalpermissions string[]?roles string[]?
GET /auth/users/whoami
Response:UserResponse
Security Group:users  Permission:custom
GET /auth/users/username/{username}
Request Parameters:
Name | Position | Type | Required |
---|---|---|---|
username | path | string | required |
Response:UserResponse[]
Security Group:users  Permission:read
GET /auth/users/{locator}
Request Parameters:
Name | Position | Type | Required |
---|---|---|---|
locator | path | uuid | required |
Response:UserResponse
Security Group:users  Permissions:custom,read
GET /auth/users/list
Request Parameters:
Name | Position | Type | Required |
---|---|---|---|
offset | query | int? | optional |
count | query | int? | optional |
extended | query | boolean? | optional |
Response:UserListResponse
Security Group:users  Permissions:read,list
UserListResponse
¶requiredlistCompleted booleanitems UserResponse[]
This endpoint returns a simplified response and therefore has a higher count limit compared to 'fetchMultipleUsers'.
GET /auth/users/basic/list
Request Parameters:
Name | Position | Type | Required |
---|---|---|---|
offset | query | int? | optional |
count | query | int? | optional |
extended | query | boolean? | optional |
Response:BasicUserResponse
Security Group:users  Permissions:read,list
BasicUserListResponse
¶requiredlistCompleted booleanitems BasicUserResponse[]
BasicUserResponse
¶requiredlocator locatoruserName stringoptionalfirstName string?lastName string?
PATCH /auth/users/{locator}
Request Parameters:
Name | Position | Type | Required |
---|---|---|---|
locator | path | uuid | required |
Request:UserUpdateRequest
Response:UserResponse
Security Group:users  Permissions:update,custom
UserUpdateRequest
¶requiredfirstName stringlastName stringpermissions string[]roles string[]tenants string[]
PATCH /auth/users/{locator}/passwordreset
Request Parameters:
Name | Position | Type | Required |
---|---|---|---|
locator | path | uuid | required |
Request:string
Response:void
Security Group:users  Permission:password-reset
DELETE /auth/users/{locator}
Request Parameters:
Name | Position | Type | Required |
---|---|---|---|
locator | path | uuid | required |
Response:void
Security Group:users  Permission:delete
Roles
POST /auth/roles
Request:RoleCreateRequest
Response:RoleResponse
Security Group:roles  Permission:add
RoleCreateRequest
¶requiredname stringdescription stringpermissions string[]
RoleResponse
¶requiredlocator locatorname stringdescription stringversion intcreatedAt datetimecreatedBy uuidpermissions string[]
GET /auth/roles/{locator}
Request Parameters:
Name | Position | Type | Required |
---|---|---|---|
locator | path | locator | required |
Response:RoleResponse
Security Group:roles  Permission:read
PATCH /auth/roles/{locator}
Request Parameters:
Name | Position | Type | Required |
---|---|---|---|
locator | path | locator | required |
Request:RoleUpdateRequest
Response:RoleResponse
Security Group:roles  Permission:update
RoleUpdateRequest
¶requiredname stringdescription stringversion intaddPermissions string[]removePermissions string[]
GET /auth/roles/list
Request Parameters:
Name | Position | Type | Required |
---|---|---|---|
offset | query | int? | optional |
count | query | int? | optional |
extended | query | boolean? | optional |
Response:RoleListResponse
Security Group:roles  Permissions:read,list
RoleListResponse
¶requiredlistCompleted booleanitems RoleResponse[]
DELETE /auth/roles/{locator}
Request Parameters:
Name | Position | Type | Required |
---|---|---|---|
locator | path | locator | required |
Response:void
Security Group:roles  Permission:delete
Permissions
GET /auth/roles/permissions
Response:string[]
Security Group:roles  Permission:read
GET /auth/users/{locator}/permissions
Request Parameters:
Name | Position | Type | Required |
---|---|---|---|
locator | path | uuid | required |
Response:string[]
Security Group:users  Permissions:read,custom
User Role Assignments
PATCH /auth/users/{locator}/roles
Request Parameters:
Name | Position | Type | Required |
---|---|---|---|
locator | path | uuid | required |
Request:UserRolesUpdateRequest
Response:UserResponse
Security Group:users  Permission:update-roles
UserRolesUpdateRequest
¶requiredaddRoles string[]removeRoles string[]
User Tenant Assignments
PATCH /auth/users/{locator}/tenants
Request Parameters:
Name | Position | Type | Required |
---|---|---|---|
locator | path | uuid | required |
Response:UserResponse
Security Group:users  Permission:update-tenants
UserTenantsAssignmentsUpdateRequest
¶requiredaddTenants string[]removeTenants string[]