Get organization roles

GET /api/organization-roles

Get organization roles with pagination.

Query parameters

  • page integer

    Page number (starts from 1).

    Minimum value is 1. Default value is 1.

  • page_size integer

    Entries per page.

    Minimum value is 1. Default value is 20.

Responses

  • 200 application/json

    A list of organization roles.

    Hide response attributes Show response attributes object
    • id string Required

      Minimum length is 1, maximum length is 21.

    • name string Required

      Minimum length is 1, maximum length is 128.

    • description string | null Required

      Maximum length is 256.

    • scopes array[object] Required
      Hide scopes attributes Show scopes attributes object
  • 401

    Unauthorized

  • 403

    Forbidden

GET /api/organization-roles
curl \
 -X GET https://[tenant_id].logto.app/api/organization-roles
Response examples (200)
[
  {
    "id": "string",
    "name": "string",
    "description": "string",
    "scopes": [
      {
        "id": "string",
        "name": "string"
      }
    ]
  }
]