Skip to main content
POST
Create 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.

Body

application/json

Request body of create_oauth_client.

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

Exact-match https allow-list (at least one entry).

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

Unified permission ceiling the client may request.

Maximum string length: 128
grant_types
enum<string>[]

Default: [authorization_code, refresh_token].

Minimum array length: 1
Available options:
authorization_code,
refresh_token
platform
boolean

Admin only: register a platform client (team_sid = null) instead of a team client.

Response

create success envelope.

success
enum<boolean>
required
Available options:
true
operation
enum<string>
required
Available options:
create
item
object
required
already_exists
boolean
required
meta
object
required