AM/FA/Inv - Create OAuth Client

Details

/external/v1/oauth/client

Synopsis

Create OAuth Client

post

This route is used to create a new OAuth client. This new client will be linked to the same organization as the client that is making the current request.

This route will typically be used by the primary OAuth client of the organization to register other clients to be used by different back-office apps to execute a subset of actions.

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

Authorizations

Body

passwordstring · min: 8 · max: 72Required

The password of this OAuth client

Example: u7/JvJ+:X?Wc]6}.

applicationstringRequired

The name of application that this client is associated with.

Example: TEST1234 App

Responses

201

Successfully registered the OAuth client

application/json

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

409

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

application/json

post

HTTPcURLJavaScriptPython

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

{
  "extraData": {
    "externalId": "123456789",
    "some": "Custom Property"
  },
  "accessScopes": [
    "createSubscription",
    "readSubscription"
  ],
  "password": "u7/JvJ+:X?Wc]6}.",
  "application": "TEST1234 App"
}

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