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
| Operation | API | Description |
|---|---|---|
| Add Users to Org | POST https://{domain}/{tenantPath}/{srp}/api/v1/orgs/{orgId}/users | Add multiple existing users to an organization |
| List Org Users | GET https://{domain}/{tenantPath}/{srp}/api/v1/orgs/{orgId}/users | Get paginated list of users in a specific organization |
| Update Org User | PUT https://{domain}/{tenantPath}/{srp}/api/v1/orgs/{orgId}/users/{userId} | Update user's role or attributes in an organization |
| Remove User from Org | DELETE 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
orgRolemust be admin
Delete
- Only admins of the target organization can remove members.
- An admin cannot remove their own membership.
Advanced Features
Role Types
| Role | Permissions |
|---|---|
| admin | Full control: create/update/delete organizations, manage users, manage devices |
Additional User Queries
| Operation | API | Description |
|---|---|---|
| Get Org User | GET https://{domain}/{tenantPath}/{srp}/api/v1/orgs/{orgId}/users/{userId} | Get user details within organization context |
| List Users | GET https://{domain}/{tenantPath}/{srp}/api/v1/users | Get paginated and sorted list of all application users |
| Get User by ID | GET https://{domain}/{tenantPath}/{srp}/api/v1/users/{userId} | Get detailed information of a specific user |
| Get User's Orgs & Roles | GET https://{domain}/{tenantPath}/{srp}/api/v1/users/{userId}/orgs | Get all organizations and roles assigned to a specific user |
Last updated on Apr-8, 2026 | Version 1.0.0