v4

latestOpenAPI 3.1.1Apache 2.02026-07-31107278570.4 KB
Roles

Retrieve user count for role

Retrieves the total number of users currently assigned to the specified role within the environment. Use this endpoint to monitor role usage, enforce user limits, or understand the scope of role assignments. Provide the role's unique name as a path parameter, and the response will include the current user count for that role. This operation is read-only and does not modify any data or user assignments. The count reflects all users who have the role either directly assigned or inherited through organization membership. This information is useful for capacity planning, security auditing, or understanding the impact of role changes across your user base.

get/api/v1/roles/{role_name}/users:count

Path parameters

role_namestring required

Unique name of the role

Response

Successfully retrieved user count for the specified role. Returns the total number of users currently assigned to the role, including both direct assignments and inherited assignments.

countstring int64

Number of users associated with the role