# Oauth Clients SDK Methods

> The soat.oauthClients methods of the SOAT TypeScript SDK for the Oauth Clients module, each linked to its REST operation.

# Oauth Clients

SDK methods for the Oauth Clients module, accessed via `soat.oauthClients`. See the [Oauth Clients module docs](/docs/modules/oauth-clients) 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`

```ts
await soat.oauthClients.listOauthClients({
  query: { /* + optional */ },
});
```

→ [Request & response schema](/docs/api/oauth-clients/list-oauth-clients)

### `soat.oauthClients.createOauthClient()`

Create an OAuth client

- Method: `POST`
- Path: `/api/v1/oauth-clients`

```ts
await soat.oauthClients.createOauthClient({
  body: { name, authorize_url, token_url, client_id, scopes, /* + optional */ },
});
```

→ [Request & response schema](/docs/api/oauth-clients/create-oauth-client)

### `soat.oauthClients.getOauthClient()`

Get an OAuth client

- Method: `GET`
- Path: `/api/v1/oauth-clients/{oauth_client_id}`

```ts
await soat.oauthClients.getOauthClient();
```

→ [Request & response schema](/docs/api/oauth-clients/get-oauth-client)

### `soat.oauthClients.updateOauthClient()`

Update an OAuth client

- Method: `PATCH`
- Path: `/api/v1/oauth-clients/{oauth_client_id}`

```ts
await soat.oauthClients.updateOauthClient({
  body: { /* + optional */ },
});
```

→ [Request & response schema](/docs/api/oauth-clients/update-oauth-client)

### `soat.oauthClients.deleteOauthClient()`

Delete an OAuth client

- Method: `DELETE`
- Path: `/api/v1/oauth-clients/{oauth_client_id}`

```ts
await soat.oauthClients.deleteOauthClient();
```

→ [Request & response schema](/docs/api/oauth-clients/delete-oauth-client)
