v1

latestOpenAPI 3.0.02026-07-141,4077,1665.2 MB

Org Authorized Clients

Get an org authorized client

Get a single OAuth2 client authorized for the current organization.

get/api/v2/org_authorized_clients/{org_authorized_client_id}

Path parameters

org_authorized_client_idstring required

Example:00000000-0000-0000-0000-000000000001

The ID of the org authorized client.

Query parameters

includestring

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

filter[user_authorized_clients][disabled]string

Filter included user authorized clients by disabled status.

filter[user_authorized_clients][user][disabled]string

Filter included user authorized clients by user disabled status.

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"
  }
}