v5

latestOpenAPI 3.0.3Apache 2.0raw.githubusercontent.com2026-02-283466592.5 MB

OAuth2 Clients

Patch client by ID

Patch an existing OAuth 2.0 client by client ID. Updating an OAuth2 client uses a JSON patch representation of the desired changes. To learn more, read Updates. Only name, description, and redirectUri may be patched.

patch/api/v2/oauth/clients/{clientId}

Path parameters

clientIdstring string required

The client ID

Request body

opstring required

The type of operation to perform

pathstring required

A JSON Pointer string specifying the part of the document to operate on

valuestring

A JSON value used in "add", "replace", and "test" operations

Example request

[
  {
    "op": "replace",
    "path": "/exampleField",
    "value": "new example value"
  }
]

Response

OAuth 2.0 client response

_linksobject required

The location and content type of related resources

namestring required

Client name

descriptionstring

Client description

_accountIdstring required

The account ID the client is registered under

_clientIdstring required

The client's unique ID

_clientSecretstring

The client secret. This will only be shown upon creation.

redirectUristring required

The client's redirect URI

_creationDateinteger required

Example response

{
  "_links": {
    "parent": {
      "href": "/api/v2/oauth/clients",
      "type": "application/json"
    },
    "self": {
      "href": "/api/v2/oauth/clients/50666563-9144-4125-b822-33f308227e45",
      "type": "application/json"
    }
  }
}