AM/FA/Inv - Update OAuth Client

Details

/external/v1/oauth/client

Synopsis

Update OAuth Client

put

This route is used to update an existing OAuth client.

This route would typically be used to grant or revoke access scopes to a specific client.

This endpoint can be called by applications with access to scope "manageExternalClients".

Authorizations

oauth2

Body

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

Responses

204

Successfully updated OAuth client

No content

400

The following error codes can be returned:

• GN0002

Please refer to the error code dictionary for the details of each error code.

application/json

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

403

The following error codes can be returned:

• AU0002

• AU0008

Please refer to the error code dictionary for the details of each error code.

application/json

404

The following error codes can be returned:

• AU0005

• AU0006

Please refer to the error code dictionary for the details of each error code.

application/json

put

HTTPcURLJavaScriptPython

PUT /external/v1/oauth/client HTTP/1.1
Host: 
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 173

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

No content