AM/FA/Inv - Reset OAuth Client Password

Details

/external/v1/oauth/client/password-reset

Synopsis

Reset OAuth Client Password

put

This route is used by the primary OAuth client to set a new password for other clients.

This route will typically be used an OAuth client loses their password.

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

Authorizations

oauth2

Body

application/json

passwordstring · min: 8 · max: 72Required

The password of this OAuth client

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

clientIdstring · min: 5 · max: 50Required

The unique identifier of the OAuth client. Must be alphanumeric

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

Responses

204

Successfully updated OAuth client's password

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

• AU0007

• 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/password-reset HTTP/1.1
Host: 
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 53

{
  "password": "u7/JvJ+:X?Wc]6}.",
  "clientId": "TEST1234"
}

No content