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

Create a User

createUser

POST /auth/users

Request:UserCreateRequest
Response:UserResponse
Security Group:users   Permission:add

UserCreateRequest

required
firstName string
lastName string
userName string
A user name in email format
password string
temporaryPassword boolean

optional
email string?
roles string[]?
tenants string[]?

UserResponse

required
locator uuid
firstName string
lastName string
userName string
tenants string[]

optional
email string?
permissions string[]?
roles string[]?

Fetch My User Details

fetchMyUserDetails

GET /auth/users/whoami

Response:UserResponse
Security Group:users   Permission:custom

Fetch a User by Name

fetchUserByName

GET /auth/users/username/{username}

Request Parameters:

Name	Position	Type	Required
username	path	string	required

Response:UserResponse[]
Security Group:users   Permission:read

Fetch a User by Locator

fetchUserByLocator

GET /auth/users/{locator}

Request Parameters:

Name	Position	Type	Required
locator	path	uuid	required

Response:UserResponse
Security Group:users   Permissions:custom,read

Fetch Multiple Users

fetchMultipleUsers

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

required
listCompleted boolean
items UserResponse[]

Fetch Multiple Basic Users

fetchMultipleBasicUsers

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

required
listCompleted boolean
items BasicUserResponse[]

BasicUserResponse

required
locator locator
userName string

optional
firstName string?
lastName string?

Update a User

updateUser

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

required
firstName string
lastName string
permissions string[]
roles string[]
tenants string[]

optional
email string?

Reset a User's Password

resetUserPassword

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 a User

deleteUser

DELETE /auth/users/{locator}

Request Parameters:

Name	Position	Type	Required
locator	path	uuid	required

Response:void
Security Group:users   Permission:delete

Roles

Create a Role

createRole

POST /auth/roles

Request:RoleCreateRequest
Response:RoleResponse
Security Group:roles   Permission:add

RoleCreateRequest

required
name string
description string
permissions string[]

RoleResponse

required
locator string
name string
description string
version int
createdAt datetime
createdBy uuid
permissions string[]

Fetch a Role

getRole

GET /auth/roles/{locator}

Request Parameters:

Name	Position	Type	Required
locator	path	string	required

Response:RoleResponse
Security Group:roles   Permission:read

Update a Role

updateRole

PATCH /auth/roles/{locator}

Request Parameters:

Name	Position	Type	Required
locator	path	string	required

Request:RoleUpdateRequest
Response:RoleResponse
Security Group:roles   Permission:update

RoleUpdateRequest

required
name string
description string
version int
addPermissions string[]
removePermissions string[]

Fetch Multiple Roles

fetchMultipleRoles

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

required
listCompleted boolean
items RoleResponse[]

Delete a Role

deleteRole

DELETE /auth/roles/{locator}

Request Parameters:

Name	Position	Type	Required
locator	path	string	required

Response:void
Security Group:roles   Permission:delete

Permissions

Fetch Available Permissions

fetchAvailablePermissions

GET /auth/roles/permissions

Response:string[]
Security Group:roles   Permission:read

Fetch User Permissions

fetchUserPermissions

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

Update User Roles

updateUserRoles

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

required
addRoles string[]
removeRoles string[]

User Tenant Assignments

Update a User's Tenant Assignments

updateUserTenantAssignments

PATCH /auth/users/{locator}/tenants

Request Parameters:

Name	Position	Type	Required
locator	path	uuid	required

Request:UserTenantsAssignmentsUpdateRequest
Response:UserResponse
Security Group:users   Permission:update-tenants

UserTenantsAssignmentsUpdateRequest

required
addTenants string[]
removeTenants string[]