Skip to main content
POST
Create OAuth client

Authorizations

Authorization
string
header
required

Access token issued by gs.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

The application's name, 1..255 chars.

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

Exact-match https callback allow-list, at least one entry.

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

The permission ceiling the client may request; may be empty.

A permission token of the gs catalog: the ceiling a grant through this client may request.

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

Default: authorization_code and refresh_token.

Minimum array length: 1
Available options:
authorization_code,
refresh_token
actor_kind
enum<string>

integration (default for a hand-made client) or agent (tokens act for an autonomous caller).

Available options:
agent,
integration
platform
boolean

A platform client with team_sid null, writable afterwards by a system actor only (403 platform_client_not_writable): leave it to provisioning.

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