跳至主要内容

Users & Roles Management

Overview

This chapter covers user account management, role-based access control, and organizational hierarchies, forming a complete users and roles management system.

Dependencies with Other Modules

Users & Roles Management is closely integrated with Organization Management, as user permissions and access are scoped within organizational boundaries.

Basic Operations

OperationAPIDescription
Add Users to OrgPOST https://{domain}/{tenantPath}/{srp}/api/v1/orgs/{orgId}/usersAdd multiple existing users to an organization
List Org UsersGET https://{domain}/{tenantPath}/{srp}/api/v1/orgs/{orgId}/usersGet paginated list of users in a specific organization
Update Org UserPUT https://{domain}/{tenantPath}/{srp}/api/v1/orgs/{orgId}/users/{userId}Update user's role or attributes in an organization
Remove User from OrgDELETE https://{domain}/{tenantPath}/{srp}/api/v1/orgs/{orgId}/users/{userId}Remove user from an organization

Constraints & Limitations

General

  • API access requires authentication with a valid token
  • Organization must exist before adding users
  • User must exist in the system before being added to an organization

Create

  • orgRole must be admin

Delete

  • Only admins of the target organization can remove members.
  • An admin cannot remove their own membership.

Advanced Features

Role Types

RolePermissions
adminFull control: create/update/delete organizations, manage users, manage devices

Additional User Queries

OperationAPIDescription
Get Org UserGET https://{domain}/{tenantPath}/{srp}/api/v1/orgs/{orgId}/users/{userId}Get user details within organization context
List UsersGET https://{domain}/{tenantPath}/{srp}/api/v1/usersGet paginated and sorted list of all application users
Get User by IDGET https://{domain}/{tenantPath}/{srp}/api/v1/users/{userId}Get detailed information of a specific user
Get User's Orgs & RolesGET https://{domain}/{tenantPath}/{srp}/api/v1/users/{userId}/orgsGet all organizations and roles assigned to a specific user

Last updated on Apr-8, 2026 | Version 1.0.0