Skip to content
Authrim

List role assignments

GET
/api/admin/roles/{id}/assignments
Code sample: Shell / cURL 
curl --request GET \
  --url 'https://auth.example.com/api/admin/roles/example/assignments?page=1&limit=20' \
  --header 'Authorization: Bearer <token>'

Lists active user assignments for a tenant role with offset-style page metadata.

Authorizations

Section titled “Authorizations ”

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “Path Parameters ”
id
required
string

Query Parameters

Section titled “Query Parameters ”
page
integer
default: 1 >= 1

Page number.

limit
integer
default: 20 >= 1

Page size.

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Role assignment list response.

Media type application/json
object
role_id
required
string
role_name
required
string
assignments
required
Array<object>
object
assignment_id
required
string
user_id
required
string
user_email
required
string | null
user_name
required
string | null
scope
required
string
scope_target
required
string
assigned_by
required
string | null
expires_at
required
integer | null
assigned_at
required
integer format: int64
key
additional properties
pagination
required
object
page
required
integer
limit
required
integer
total
required
integer
totalPages
required
integer
hasNext
required
boolean
hasPrev
required
boolean
key
additional properties
key
additional properties
Example 
{
  "role_id": "role_viewer",
  "role_name": "viewer",
  "assignments": [
    {
      "assignment_id": "assign_123",
      "user_id": "user_123",
      "user_email": "[email protected]",
      "user_name": "Example User",
      "scope": "tenant",
      "scope_target": "tenant_123",
      "assigned_by": "admin_123",
      "expires_at": null,
      "assigned_at": 1770000000000
    }
  ],
  "pagination": {
    "page": 1,
    "limit": 20,
    "total": 1,
    "totalPages": 1,
    "hasNext": false,
    "hasPrev": false
  }
}

401

Section titled “401 ”

Error response.

Media type application/json
object
error
string
message
string
error_description
string
key
additional properties
Example generated
{
  "error": "example",
  "message": "example",
  "error_description": "example"
}

403

Section titled “403 ”

Error response.

Media type application/json
object
error
string
message
string
error_description
string
key
additional properties
Example generated
{
  "error": "example",
  "message": "example",
  "error_description": "example"
}

404

Section titled “404 ”

Error response.

Media type application/json
object
error
string
message
string
error_description
string
key
additional properties
Example generated
{
  "error": "example",
  "message": "example",
  "error_description": "example"
}

500

Section titled “500 ”

Error response.

Media type application/json
object
error
string
message
string
error_description
string
key
additional properties
Example generated
{
  "error": "example",
  "message": "example",
  "error_description": "example"
}