Get organization roles

GET /api/organization-roles
OAuth2

Get organization roles with pagination.

Query parameters

  • q string
  • 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
    • tenantId string Required

      Maximum length is 21.

    • 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.

    • type string Required

      Values are User or MachineToMachine.

    • scopes array[object] Required
      Hide scopes attributes Show scopes attributes object
    • resourceScopes array[object] Required
      Hide resourceScopes attributes Show resourceScopes attributes object
      • id string Required
      • name string Required
      • resource object Required

        Additional properties are allowed.

        Hide resource attributes Show resource attributes object
  • 400

    Bad Request

  • 401

    Unauthorized

  • 403

    Forbidden

GET /api/organization-roles 
curl \
 -X GET https://[tenant_id].logto.app/api/organization-roles \
 -H "Authorization: Bearer $ACCESS_TOKEN"
Response examples (200) 
[
  {
    "tenantId": "string",
    "id": "string",
    "name": "string",
    "description": "string",
    "type": "User",
    "scopes": [
      {
        "id": "string",
        "name": "string"
      }
    ],
    "resourceScopes": [
      {
        "id": "string",
        "name": "string",
        "resource": {
          "id": "string",
          "name": "string"
        }
      }
    ]
  }
]