v1

latestOpenAPI 3.0.02026-07-141,4077,1665.2 MB

Org Authorized Clients

List user authorizations for a client

Get a list of user authorizations for the specified OAuth2 client in the current organization.

get/api/v2/org_authorized_clients/{org_authorized_client_id}/user_authorized_clients

Path parameters

org_authorized_client_idstring required

Example:00000000-0000-0000-0000-000000000001

The ID of the org authorized client.

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.

sort'user.name' | 'user.email' | 'oauth2_client.name'

Field to sort user authorizations by.

Example:user.name

Field to sort results by. Options: user.name, user.email, oauth2_client.name.

filter[disabled]string

Filter results by the user authorization disabled status.

filter[user][name]string

Filter results by user name.

filter[user][email]string

Filter results by user email.

filter[user][disabled]string

Filter results by whether the user is disabled.

Response

Example response

{
  "data": [
    {
      "attributes": {
        "created_at": "2024-01-10T08:00:00+00:00",
        "last_exercised": "2024-01-15T10:30:00+00:00",
        "modified_at": "2024-01-10T08:00:00+00:00"
      },
      "id": "00000000-0000-0000-0000-000000000001",
      "relationships": {
        "oauth2_client": {
          "data": {
            "id": "00000000-0000-0000-0000-000000000010",
            "type": "oauth2_clients"
          }
        },
        "scopes": {
          "data": [
            {
              "id": "example_scope",
              "type": "scopes"
            }
          ]
        },
        "user": {
          "data": {
            "id": "00000000-0000-9999-0000-000000000001",
            "type": "users"
          }
        }
      },
      "type": "user_authorized_clients"
    }
  ]
}