Skip to main content

Oauth Clients

SDK methods for the Oauth Clients module, accessed via soat.oauthClients. See the Oauth Clients module docs for permissions and data model, and each method's REST page for the full request/response schema.

soat.oauthClients.listOauthClients()​

List OAuth clients

  • Method: GET
  • Path: /api/v1/oauth-clients
await soat.oauthClients.listOauthClients({
query: { /* + optional */ },
});

→ Request & response schema

soat.oauthClients.createOauthClient()​

Create an OAuth client

  • Method: POST
  • Path: /api/v1/oauth-clients
await soat.oauthClients.createOauthClient({
body: { name, authorize_url, token_url, client_id, scopes, /* + optional */ },
});

→ Request & response schema

soat.oauthClients.getOauthClient()​

Get an OAuth client

  • Method: GET
  • Path: /api/v1/oauth-clients/{oauth_client_id}
await soat.oauthClients.getOauthClient();

→ Request & response schema

soat.oauthClients.updateOauthClient()​

Update an OAuth client

  • Method: PATCH
  • Path: /api/v1/oauth-clients/{oauth_client_id}
await soat.oauthClients.updateOauthClient({
body: { /* + optional */ },
});

→ Request & response schema

soat.oauthClients.deleteOauthClient()​

Delete an OAuth client

  • Method: DELETE
  • Path: /api/v1/oauth-clients/{oauth_client_id}
await soat.oauthClients.deleteOauthClient();

→ Request & response schema