User Management API

Endpoint Index

ActionEndpoint
Create a UserPOST /auth/users
Fetch My User DetailsGET /auth/users/whoami
Fetch a User by NameGET /auth/users/username/{username}
Fetch a User by LocatorGET /auth/users/{locator}
Fetch Multiple UsersGET /auth/users/list
Fetch Multiple Basic UsersGET /auth/users/basic/list
Update a UserPATCH /auth/users/{locator}
Reset a User's PasswordPATCH /auth/users/{locator}/passwordreset
Delete a UserDELETE /auth/users/{locator}
Create a RolePOST /auth/roles
Fetch a RoleGET /auth/roles/{locator}
Update a RolePATCH /auth/roles/{locator}
Fetch Multiple RolesGET /auth/roles/list
Delete a RoleDELETE /auth/roles/{locator}
Fetch Available PermissionsGET /auth/roles/permissions
Fetch User PermissionsGET /auth/users/{locator}/permissions
Update User RolesPATCH /auth/users/{locator}/roles
Update a User's Tenant AssignmentsPATCH /auth/users/{locator}/tenants

Users

Create a User
createUser
POST /auth/users
    Request Parameters:
    NamePositionTypeRequired
    enableUserqueryboolean?optional
    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
serviceAccount boolean
temporaryPassword boolean

optional
email string?
roles string[]?
tenants string[]?
UserResponse
required
locator uuid
firstName string
lastName string
userName string
serviceAccount boolean
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:
    NamePositionTypeRequired
    usernamepathstringrequired
    Response:UserResponse[]
    Security Group:users   Permission:read
Fetch a User by Locator
fetchUserByLocator
GET /auth/users/{locator}
    Request Parameters:
    NamePositionTypeRequired
    locatorpathuuidrequired
    Response:UserResponse
    Security Group:users   Permissions:custom,read
Fetch Multiple Users
fetchMultipleUsers
GET /auth/users/list
    Request Parameters:
    NamePositionTypeRequired
    offsetqueryint?optional
    countqueryint?optional
    extendedqueryboolean?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:
    NamePositionTypeRequired
    offsetqueryint?optional
    countqueryint?optional
    extendedqueryboolean?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:
    NamePositionTypeRequired
    locatorpathuuidrequired
    Request:UserUpdateRequest
    Response:UserResponse
    Security Group:users   Permissions:update,custom
UserUpdateRequest
required
firstName string
lastName string
tenants string[]

optional
email string?
permissions string[]?
roles string[]?
Reset a User's Password
resetUserPassword
PATCH /auth/users/{locator}/passwordreset
    Request Parameters:
    NamePositionTypeRequired
    locatorpathuuidrequired
    Request:string
    Response:void
    Security Group:users   Permission:password-reset
Delete a User
deleteUser
DELETE /auth/users/{locator}
    Request Parameters:
    NamePositionTypeRequired
    locatorpathuuidrequired
    Response:void
    Security Group:users   Permission:delete

Roles

Create a Role
createRole
POST /auth/roles
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:
    NamePositionTypeRequired
    locatorpathstringrequired
    Response:RoleResponse
    Security Group:roles   Permission:read
Update a Role
updateRole
PATCH /auth/roles/{locator}
    Request Parameters:
    NamePositionTypeRequired
    locatorpathstringrequired
    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:
    NamePositionTypeRequired
    offsetqueryint?optional
    countqueryint?optional
    extendedqueryboolean?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:
    NamePositionTypeRequired
    locatorpathstringrequired
    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:
    NamePositionTypeRequired
    locatorpathuuidrequired
    Response:string[]
    Security Group:users   Permissions:read,custom

User Role Assignments

Update User Roles
updateUserRoles
PATCH /auth/users/{locator}/roles
UserRolesUpdateRequest
required
addRoles string[]
removeRoles string[]

User Tenant Assignments

Update a User's Tenant Assignments
updateUserTenantAssignments
PATCH /auth/users/{locator}/tenants
UserTenantsAssignmentsUpdateRequest
required
addTenants string[]
removeTenants string[]