Sign in

v44

latestOpenAPI 3.1.0raw.githubusercontent.com2026-05-20129390589.6 KB
Roles

List roles

⚠️ This endpoint is in public preview.

List all role definitions. Built-in roles appear first, followed by custom roles sorted by creation date (newest first).

get/preview/v2/roles

Query parameters

idSfcApiResourcePathOrIdRoleId[]

Filter by role ID, resource path, or name (repeatable).

[
  "role_k3R-nX9vLm7Qp2Yw5Jd8F"
]

Response

List of roles.

object'list' required

Example response

{
  "object": "list",
  "data": [
    {
      "id": "role_k3R-nX9vLm7Qp2Yw5Jd8F",
      "resource_path": "sfc:role:<account_id>:<name>",
      "owner": "my-resource-name",
      "name": "my-resource-name",
      "object": "role",
      "created_at": 1738972800,
      "updated_at": 1738972800
    }
  ]
}