Skip to main content
GET
/
api
/
svc
/
v1
/
role-bindings
List role bindings
curl --request GET \
  --url https://{controlPlaneURL}/api/svc/v1/role-bindings \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "name": "<string>",
      "accountId": "<string>",
      "manifest": {
        "type": "role-binding",
        "name": "<string>",
        "subjects": [
          {
            "name": "<string>"
          }
        ],
        "permissions": [
          {
            "resourceType": "<string>",
            "resourceFqn": "<string>",
            "role": "<string>"
          }
        ]
      },
      "createdBySubject": {
        "subjectId": "<string>",
        "subjectSlug": "<string>",
        "subjectDisplayName": "<string>",
        "subjectPatName": "<string>",
        "subjectControllerName": "<string>",
        "subjectExternalIdentitySlug": "<string>"
      },
      "id": "<string>",
      "metadata": {},
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z"
    }
  ],
  "pagination": {
    "total": 100,
    "offset": 0,
    "limit": 10
  }
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

​
limit
integer | null
default:100

Number of items per page

Required range: 1 <= x <= 1000
Example:

10

​
offset
integer | null
default:0

Number of items to skip

Required range: x >= 0
Example:

0

​
id
string | null

Filter by system-generated unique identifier for the role binding.

​
name
string | null

Filter by human-readable name of the role binding (exact match).

Response

200 - application/json

Paginated list of role bindings.

​
data
RoleBinding · object[]
required

List of role bindings.

​
pagination
Pagination · object
required

Pagination metadata.