v1

latestOpenAPI 3.0.02026-07-141,4077,1665.2 MB

Org Authorized Clients

List org authorized clients

Get a list of all OAuth2 clients authorized for the current organization.

get/api/v2/org_authorized_clients

Query parameters

page[size]integer

Example:10

Size for a given page. The maximum allowed value is 100.

page[number]integer

Specific page number to return.

sortstring

Example:oauth2_client.name

Field to sort results by. Options include oauth2_client.name.

filterstring

Filter results by client name, app title, or app description.

filter[oauth2_client][name]string

Filter results by the OAuth2 client name.

filter[disabled]string

Filter results by the org-level disabled status.

includestring

Comma-separated list of related resources to include. Options: oauth2_client, oauth2_client.app, user_authorized_clients.user.

Response

Example response

{
  "data": [
    {
      "attributes": {
        "last_exercised": "2024-01-15T10:30:00+00:00",
        "user_count": 2
      },
      "id": "00000000-0000-0000-0000-000000000001",
      "relationships": {
        "oauth2_client": {
          "data": {
            "id": "00000000-0000-0000-0000-000000000010",
            "type": "oauth2_clients"
          }
        },
        "user_authorized_clients": {
          "data": [
            {
              "id": "00000000-0000-0000-0000-000000000020",
              "type": "user_authorized_clients"
            }
          ],
          "links": {
            "related": "/api/v2/org_authorized_clients/00000000-0000-0000-0000-000000000001/user_authorized_clients"
          }
        }
      },
      "type": "org_authorized_clients"
    }
  ]
}