OAuth clients
List, create, update and delete OAuth clients, and rotate their secrets.
list_clients
List an organization’s OAuth clients. Maps to GET /organizations/:org/clients.
| Name | Type | Required | Description |
|---|---|---|---|
org | string | Yes | Organization id (org_…) or slug |
Returns the list of clients.
create_client
Create an OAuth client. Maps to POST /organizations/:org/clients.
| Name | Type | Required | Description |
|---|---|---|---|
org | string | Yes | Organization id (org_…) or slug |
name | string | Yes | Client name, e.g. Acme web |
redirect_uris | array of string (URL) | No | https, or http on loopback |
confidential | boolean | No | Whether the client gets a secret |
ip_allowlist | array of string | No |
Returns the created client. A confidential client’s secret is in this result once, and only here.
update_client
Change a client’s name, logo, redirect URIs, confidential flag or IP allowlist.
The fields you pass are the fields that change. Maps to
PATCH /organizations/:org/clients/:client_id.
| Name | Type | Required | Description |
|---|---|---|---|
org | string | Yes | Organization id (org_…) or slug |
client_id | string | Yes | The client to update |
name | string | No | |
logo | string (URL) | No | |
redirect_uris | array of string (URL) | No | |
confidential | boolean | No | |
ip_allowlist | array of string | No |
Returns the updated client.
rotate_client_secret
Mint a new secret for a confidential client, invalidating the old one. Maps to
POST /organizations/:org/clients/:client_id/secret.
| Name | Type | Required | Description |
|---|---|---|---|
org | string | Yes | Organization id (org_…) or slug |
client_id | string | Yes | The confidential client |
Returns the new secret, once, and only here.
delete_client
Delete an OAuth client. Maps to DELETE /organizations/:org/clients/:client_id.
| Name | Type | Required | Description |
|---|---|---|---|
org | string | Yes | Organization id (org_…) or slug |
client_id | string | Yes | The client to delete |
Returns OK (no content).