Organization API: Customers: Oauth clients

The 3 Organization API operations for oauth clients.

View as Markdown

Operations

Method	Path	Summary
GET	`/api/v1/orgs/{org_slug}/oauth-clients`	List OAuth clients
POST	`/api/v1/orgs/{org_slug}/oauth-clients`	An OAuth client that signs the brand's customers in elsewhere
DELETE	`/api/v1/orgs/{org_slug}/oauth-clients/{client_id}`	Delete OAuth client

List OAuth clients

Section titled List OAuth clients

GET /api/v1/orgs/{org_slug}/oauth-clients

Parameters

Section titled Parameters

Name	In	Type	Required
`org_slug`	path	string	yes

Responses

Section titled Responses

Status	Meaning
`200`	Success.
`422`	The request is not valid. `detail` lists each problem.

A 200 response is a list; each item has these fields:

Field	Type
`[].id`	integer
`[].org_id`	integer
`[].client_id`	string
`[].name`	string
`[].redirect_uris`	array of any
`[].allowed_scopes`	array of any or null
`[].grant_types`	array of any or null
`[].is_active`	boolean
`[].created_at`	string (date-time) or null

An OAuth client that signs the brand's customers in elsewhere

Section titled An OAuth client that signs the brand's customers in elsewhere

POST /api/v1/orgs/{org_slug}/oauth-clients

An OAuth client that signs the brand's customers in elsewhere. The answer is the only one that carries client_secret. Admins and the owner; audited as oauth_client.created.

Parameters

Section titled Parameters

Name	In	Type	Required
`org_slug`	path	string	yes

Request body

Section titled Request body

application/json (required)

Field	Type	Required
`name`	string	yes
`redirect_uris`	array of string	yes
`allowed_scopes`	array of string or null	no
`grant_types`	array of string or null	no

Responses

Section titled Responses

Status	Meaning
`201`	Success.
`422`	The request is not valid. `detail` lists each problem.

Fields of a 201 response:

Field	Type
`id`	integer
`org_id`	integer
`client_id`	string
`name`	string
`redirect_uris`	array of any
`allowed_scopes`	array of any or null
`grant_types`	array of any or null
`is_active`	boolean
`created_at`	string (date-time) or null
`client_secret`	string

Delete OAuth client

Section titled Delete OAuth client

DELETE /api/v1/orgs/{org_slug}/oauth-clients/{client_id}

Delete an OAuth client: its client_id stops working and every customer session it opened ends. Admins and the owner; 404 for another organization's client.

Parameters

Section titled Parameters

Name	In	Type	Required	Description
`client_id`	path	string	yes	The client's `id`, or its `client_id`.
`org_slug`	path	string	yes

Responses

Section titled Responses

Status	Meaning
`204`	Success.
`422`	The request is not valid. `detail` lists each problem.