Skip to main content
PATCH
Update OAuth client

Authorizations

Authorization
string
header
required

Access token issued by gtm.service.id. Its access_identity claim carries team_sid, actor_sid and actor_type, and that team scope is authoritative.

Team-SID
string
header
required

Team scope for tokens that do not carry one. Ignored when the token already names a team.

Path Parameters

sid
string
required

OAuth client sid (id_oc_…).

Required string length: 18
Pattern: ^id_oc_

Body

application/json

Request body of update_oauth_client.

name
string
Required string length: 1 - 255
redirect_uris
string<uri>[]

FULL replacement of the exact-match https allow-list.

Minimum array length: 1
Maximum string length: 2048
Pattern: ^https:\/\/
permissions
string[]

FULL replacement of the permission ceiling.

Maximum string length: 128
grant_types
enum<string>[]
Minimum array length: 1
Available options:
authorization_code,
refresh_token
status
enum<string>

disabled cascade-revokes the client's grants + issued tokens.

Available options:
active,
disabled

Response

update success envelope.

success
enum<boolean>
required
Available options:
true
operation
enum<string>
required
Available options:
update
item
object
required
updated_fields
string[]
required
previous_values
object
required
meta
object
required