User Management API

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 Multiple Tenant Roles	GET/auth/roles/tenant/{tenantLocator}/list
Fetch a Tenant Role	GET/auth/roles/tenant/{tenantLocator}/{roleLocator}
Create a Tenant Role	POST/auth/roles/tenant/{tenantLocator}/{roleLocator}
Update a Tenant Role	PATCH/auth/roles/tenant/{tenantLocator}/{roleLocator}
Delete a Tenant Role	DELETE/auth/roles/tenant/{tenantLocator}/{roleLocator}
Fetch Available Permissions	GET/auth/roles/permissions
Fetch User Permissions	GET/auth/users/{locator}/permissions
Fetch a User's Tenant Permissions	GET/auth/users/{userLocator}/tenant/{tenantLocator}/permissions
Fetch Grouped Token Permissions	POST/auth/users/tokens/permissions
Update User Roles	PATCH/auth/users/{locator}/roles
Update a User's Tenant Assignments	PATCH/auth/users/{locator}/tenants

Users

Create a User

Create a UsercreateUser

POST/auth/users

Parameters

Name	In	Type	Required	Description
`enableUser`	query	`boolean?`	No	When true, user will be active (enabled) even if password is not set. Useful for SSO since user cannot use any other credentials to log in

Request:UserCreateRequest

Response:UserResponse

Security Group:users

Permission:

add

UserCreateRequest

Required properties

Property	Type	Description
`firstName`	`string`
`lastName`	`string`
`userName`	`string`	A user name in email format
`password`	`string`
`serviceAccount`	`boolean`
`temporaryPassword`	`boolean`

Optional properties

Property	Type	Description
`email`	`string?`
`roles`	`string[]?`
`tenants`	`string[]?`

UserResponse

Required properties

Property	Type	Description
`locator`	`uuid`
`firstName`	`string`
`lastName`	`string`
`userName`	`string`
`serviceAccount`	`boolean`
`tenants`	`string[]`

Optional properties

Property	Type	Description
`email`	`string?`
`permissions`	`string[]?`
`roles`	`string[]?`

Fetch My User Details

Fetch My User DetailsfetchMyUserDetails

GET/auth/users/whoami

Response:UserResponse

Security Group:users

Permission:

custom

Fetch a User by Name

Fetch a User by NamefetchUserByName

GET/auth/users/username/{username}

Parameters

Name	In	Type	Required	Description
`username`	path	`string`	Yes

Response:UserResponse[]

Security Group:users

Permission:

read

Fetch a User by Locator

Fetch a User by LocatorfetchUserByLocator

GET/auth/users/{locator}

Parameters

Name	In	Type	Required	Description
`locator`	path	`uuid`	Yes

Response:UserResponse

Security Group:users

Permissions:

custom,read

Fetch Multiple Users

Fetch Multiple UsersfetchMultipleUsers

GET/auth/users/list

Parameters

Name	In	Type	Required	Description
`offset`	query	`integer?`	No
`count`	query	`integer?`	No
`extended`	query	`boolean?`	No	When false, returns a bare array.

Response:UserListResponse

Security Group:users

Permissions:

read,list

UserListResponse

Required properties

Property	Type	Description
`listCompleted`	`boolean`
`items`	`UserResponse[]`

Fetch Multiple Basic Users

Fetch Multiple Basic UsersfetchMultipleBasicUsers

GET/auth/users/basic/list

This endpoint returns a simplified response and therefore has a higher count limit compared to 'fetchMultipleUsers'.

Parameters

Name	In	Type	Required
`offset`	query	`integer?`	No
`count`	query	`integer?`	No
`extended`	query	`boolean?`	No

Response:BasicUserResponse

Security Group:users

Permissions:

read,list

BasicUserListResponse

Required properties

Property	Type	Description
`listCompleted`	`boolean`
`items`	`BasicUserResponse[]`

BasicUserResponse

Required properties

Property	Type	Description
`locator`	`ulid`
`userName`	`string`

Optional properties

Property	Type	Description
`firstName`	`string?`
`lastName`	`string?`

Update a User

Update a UserupdateUser

PATCH/auth/users/{locator}

Parameters

Name	In	Type	Required	Description
`locator`	path	`uuid`	Yes

Request:UserUpdateRequest

Response:UserResponse

Security Group:users

Permissions:

update,custom

UserUpdateRequest

Required properties

Property	Type	Description
`firstName`	`string`
`lastName`	`string`
`tenants`	`string[]`

Optional properties

Property	Type	Description
`email`	`string?`
`permissions`	`string[]?`
`roles`	`string[]?`

Reset a User's Password

Reset a User's PasswordresetUserPassword

PATCH/auth/users/{locator}/passwordreset

Parameters

Name	In	Type	Required	Description
`locator`	path	`uuid`	Yes

Request:string

Response:void

Security Group:users

Permission:

password-reset

Delete a User

Delete a UserdeleteUser

DELETE/auth/users/{locator}

Parameters

Name	In	Type	Required	Description
`locator`	path	`uuid`	Yes

Response:void

Security Group:users

Permission:

delete

Roles

Create a Role

Create a RolecreateRole

POST/auth/roles

Request:RoleCreateRequest

Response:RoleResponse

Security Group:roles

Permission:

add

RoleCreateRequest

Required properties

Property	Type	Description
`name`	`string`
`description`	`string`
`permissions`	`string[]`

RoleResponse

Required properties

Property	Type	Description
`locator`	`ulid`
`name`	`string`
`description`	`string`
`version`	`integer`
`createdAt`	`datetime`
`createdBy`	`uuid`
`permissions`	`string[]`

Fetch a Role

Fetch a RolegetRole

GET/auth/roles/{locator}

Parameters

Name	In	Type	Required	Description
`locator`	path	`ulid`	Yes

Response:RoleResponse

Security Group:roles

Permission:

read

Update a Role

Update a RoleupdateRole

PATCH/auth/roles/{locator}

Parameters

Name	In	Type	Required	Description
`locator`	path	`ulid`	Yes

Request:RoleUpdateRequest

Response:RoleResponse

Security Group:roles

Permission:

update

RoleUpdateRequest

Required properties

Property	Type	Description
`name`	`string`
`description`	`string`
`version`	`integer`
`addPermissions`	`string[]`
`removePermissions`	`string[]`

Fetch Multiple Roles

Fetch Multiple RolesfetchMultipleRoles

GET/auth/roles/list

Parameters

Name	In	Type	Required	Description
`offset`	query	`integer?`	No
`count`	query	`integer?`	No
`extended`	query	`boolean?`	No	When false, returns a bare array.

Response:RoleListResponse

Security Group:roles

Permissions:

read,list

RoleListResponse

Required properties

Property	Type	Description
`listCompleted`	`boolean`
`items`	`RoleResponse[]`

Delete a Role

Delete a RoledeleteRole

DELETE/auth/roles/{locator}

Parameters

Name	In	Type	Required	Description
`locator`	path	`ulid`	Yes

Response:void

Security Group:roles

Permission:

delete

Tenant Roles

Fetch Multiple Tenant Roles

Fetch Multiple Tenant RoleslistTenantRoles

GET/auth/roles/tenant/{tenantLocator}/list

Parameters

Name	In	Type	Required
`tenantLocator`	path	`uuid`	Yes
`offset`	query	`integer?`	No
`count`	query	`integer?`	No

Response:ListPageResponseRoleDetails

Security Group:roles

Permissions:

read,list

Fetch a Tenant Role

Fetch a Tenant RolegetTenantRole

GET/auth/roles/tenant/{tenantLocator}/{roleLocator}

Parameters

Name	In	Type	Required	Description
`tenantLocator`	path	`uuid`	Yes
`roleLocator`	path	`ulid`	Yes

Response:RoleResponse

Security Group:roles

Permission:

read

Create a Tenant Role

Create a Tenant RolecreateTenantRole

POST/auth/roles/tenant/{tenantLocator}/{roleLocator}

Parameters

Name	In	Type	Required	Description
`tenantLocator`	path	`uuid`	Yes
`roleLocator`	path	`ulid`	Yes

Request:CreateTenantRoleReq

Response:RoleResponse

Security Group:roles

Permission:

add

Update a Tenant Role

Update a Tenant RoleupdateTenantRole

PATCH/auth/roles/tenant/{tenantLocator}/{roleLocator}

Parameters

Name	In	Type	Required	Description
`tenantLocator`	path	`uuid`	Yes
`roleLocator`	path	`ulid`	Yes

Request:PatchTenantRoleReq

Response:RoleResponse

Security Group:roles

Permission:

update

Delete a Tenant Role

Delete a Tenant RoledeleteTenantRole

DELETE/auth/roles/tenant/{tenantLocator}/{roleLocator}

Parameters

Name	In	Type	Required	Description
`tenantLocator`	path	`uuid`	Yes
`roleLocator`	path	`ulid`	Yes

Response:void

Security Group:roles

Permission:

delete

ListPageResponseRoleDetails

Required properties

Property	Type	Description
`listCompleted`	`boolean`
`items`	`RoleResponse[]`

CreateTenantRoleReq

Required properties

Property	Type	Description
`permissions`	`string[]`

Optional properties

Property	Type	Description
`description`	`string?`

PatchTenantRoleReq

Required properties

Property	Type	Description
`version`	`integer`
`addPermissions`	`string[]`
`removePermissions`	`string[]`

Optional properties

Property	Type	Description
`description`	`string?`

Permissions

Fetch Available Permissions

Fetch Available PermissionsfetchAvailablePermissions

GET/auth/roles/permissions

Response:string[]

Security Group:roles

Permission:

read

Fetch User Permissions

Fetch User PermissionsfetchUserPermissions

GET/auth/users/{locator}/permissions

Parameters

Name	In	Type	Required	Description
`locator`	path	`uuid`	Yes

Response:string[]

Security Group:users

Permissions:

read,custom

Fetch a User's Tenant Permissions

Fetch a User's Tenant PermissionsfetchUserTenantPermissions

GET/auth/users/{userLocator}/tenant/{tenantLocator}/permissions

Parameters

Name	In	Type	Required	Description
`userLocator`	path	`uuid`	Yes
`tenantLocator`	path	`uuid`	Yes

Response:string[]

Security Group:users

Permissions:

read,custom

Fetch Grouped Token Permissions

Fetch Grouped Token PermissionsgetGroupedTokenPermissions

POST/auth/users/tokens/permissions

Request:string

Response:map<string, string[]>

Security Group:users

Permissions:

read,custom

User Role Assignments

Update User Roles

Update User RolesupdateUserRoles

PATCH/auth/users/{locator}/roles

Parameters

Name	In	Type	Required	Description
`locator`	path	`uuid`	Yes

Request:UserRolesUpdateRequest

Response:UserResponse

Security Group:users

Permission:

update-roles

UserRolesUpdateRequest

Required properties

Property	Type	Description
`addRoles`	`string[]`
`removeRoles`	`string[]`

User Tenant Assignments

Update a User's Tenant Assignments

Update a User's Tenant AssignmentsupdateUserTenantAssignments

PATCH/auth/users/{locator}/tenants

Parameters

Name	In	Type	Required	Description
`locator`	path	`uuid`	Yes

Request:UserTenantsAssignmentsUpdateRequest

Response:UserResponse

Security Group:users

Permission:

update-tenants

UserTenantsAssignmentsUpdateRequest

Required properties

Property	Type	Description
`addTenants`	`string[]`
`removeTenants`	`string[]`

User Management API

On this page