v1

latestOpenAPI 3.0.02026-08-064311,0881.3 MB

oauthManagement

List the OAuth clients.

List all OAuth clients.

get/v1/oauth/clients

Query parameters

limitinteger

Limit the number of OAuth clients returned in the response. The number of OAuth clients returned may be less than the limit.

tokenstring

Continuation token to get the next page of results. A page object with the next continuation token is returned in the response body. Subsequent GET requests should specify the continuation token to get the next page of results. token is set to null when no more pages are left.

runAsIdstring

Identifier of the service account that the OAuth Client runs as.

clientIdstring

Filter clients by exact client ID. When specified, returns only the client matching this ID. Supports URL-based client identifiers (URL-encode the value).

Response

A list of all OAuth clients within the organization.

nextstring

Next continuation token.

Example response

{
  "data": [
    {
      "id": "0000000006743FDE",
      "clientId": "zVplCFHcpTDwtktBIQmFI2K6s9HEo4HAtcQD1f1M5eQ",
      "createdAt": "2018-10-16T09:10:00Z",
      "createdBy": "0000000006743FDD",
      "modifiedAt": "2018-10-16T09:10:00Z",
      "modifiedBy": "0000000006743FDD",
      "name": "My OAuth Client",
      "description": "OAuth client for data ingestion",
      "scopes": [
        "manageUsersAndRoles",
        "viewCollectors"
      ]
    }
  ],
  "next": "GDCiRv4vebF3UWFJQ1kySXBOR3Bzh69GR0RyWm9vCtc"
}