AM/TA/Inv - Get All OAuth Clients for Current Organization

Details

/external/v1/oauth/client/current

Synopsis

Get All OAuth clients for the current organization

get

This route is to be used by an OAuth client to get all the OAuth clients that are linked to the same organization as the current client. The client should be authenticated and a valid access token provided. This endpoint can be called by applications with access to scope "manageExternalClients".

Required scopes

This endpoint requires the following scopes:

• : manageExternalClients

Authorizations

oauth2

OAuth2clientCredentialsRequired

Token URL:

Responses

200

Successfully obtained the data

application/json

clientIdstring · min: 5 · max: 50Required

The unique identifier of the OAuth client. Must be alphanumeric

Example: TEST1234Pattern: ^[a-zA-Z0-9-]*$

applicationstringRequired

The name of application that this API client is associated with.

Example: TEST1234 App

primarybooleanRequired

True if the OAuth client is a primary client for the organization, false otherwise

Example: true

401

The following error codes can be returned: - AU0001 Please refer to the error code dictionary for the details of each error code.

application/json

404

The following error codes can be returned: - AU0006 Please refer to the error code dictionary for the details of each error code.

application/json

get

/external/v1/oauth/client

HTTPcURLJavaScriptPython

GET /external/v1/oauth/client HTTP/1.1
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

[
  {
    "extraData": {
      "externalId": "123456789",
      "some": "Custom Property"
    },
    "clientId": "TEST1234",
    "accessScopes": [
      "createSubscription",
      "readSubscription"
    ],
    "application": "TEST1234 App",
    "primary": true
  }
]