Users - Roles
Retrieve roles assigned to a specific user
Overview
Retrieve all roles currently assigned to a specific user.
Use Cases
- Security Audits: Verify that users only have the permissions necessary for their current function.
- Troubleshooting: Check if a user's lack of access to a feature is due to missing roles.
Identification
The {userId} is a unique numerical identifier.
Getting User ID
- To find users and their numerical IDs, use the Users Management API:
- GET /public/v1/users - Retrieve all users with their id field.
- The id field in the user response is the {userId} used in this endpoint's path parameter.
Related Operations
- Discover Valid Roles: GET /public/v1/users/roles/available
- Add Roles to User: POST /public/v1/users/{userId}/roles
- Remove Specific Role: DELETE /public/v1/users/{userId}/roles/{roleName}
Required Permission
access_public_users
get/public/v1/users/{userId}/roles
Path parameters
userIdinteger required
The unique numerical identifier of the target user. If you do not have this ID, you can find it by searching for the user via GET /public/v1/users.
Response
User roles retrieved successfully.