API V2 Route: Role Assignments

General Details:

Endpoint	/api/v2/role-assignments/<id>
Headers	Authorization: <JWT>
HTTP Methods	GET
Request Body Format	N/A
Response Body Format	JSON
Required Scopes	ROLES_ASSIGNMENTS_GET

 

API Response:

Field Name	Data Type	Notes
id	string	Globally unique identifier
name	string	Unique name of Role
profileAssignments	ProfileThin array	List of users with the Role

 

Example Response:

{
    "entity": {
        "id": "1",
        "name": "RD-test",
        "profileAssignments": [
            {
                "id": "12",
                "name": "Myron Bashirian",
                "sisId": "rxvd6"
            }
        ]
    },
    "metaData": {
        "params": {
            "id": "1"
        },
        "agentId": "634afe7e-b41d-470e-98c1-c9fb147e7226",
        "rateLimits": {
            "tenant": {
                "limit": 50,
                "remaining": 49,
                "reset": 1761660685000
            },
            "agent": {
                "limit": 10,
                "remaining": 9,
                "reset": 1761660686000
            }
        }
    }
}