# Oauth Connections SDK Methods

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

# Oauth Connections

SDK methods for the Oauth Connections module, accessed via `soat.oauthConnections`. See the [Oauth Connections module docs](/docs/modules/oauth-connections) for permissions and data model, and each method's REST page for the full request/response schema.

### `soat.oauthConnections.listOauthConnections()`

List OAuth connections

- Method: `GET`
- Path: `/api/v1/oauth-connections`

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

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

### `soat.oauthConnections.createOauthConnection()`

Start an OAuth connection

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

```ts
await soat.oauthConnections.createOauthConnection({
  body: { oauth_client_id, actor_id, /* + optional */ },
});
```

→ [Request & response schema](/docs/api/oauth-connections/create-oauth-connection)

### `soat.oauthConnections.completeOauthConnection()`

Complete an OAuth connection

- Method: `GET`
- Path: `/api/v1/oauth-connections/callback`

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

→ [Request & response schema](/docs/api/oauth-connections/complete-oauth-connection)

### `soat.oauthConnections.getOauthConnection()`

Get an OAuth connection

- Method: `GET`
- Path: `/api/v1/oauth-connections/{oauth_connection_id}`

```ts
await soat.oauthConnections.getOauthConnection();
```

→ [Request & response schema](/docs/api/oauth-connections/get-oauth-connection)

### `soat.oauthConnections.deleteOauthConnection()`

Delete an OAuth connection

- Method: `DELETE`
- Path: `/api/v1/oauth-connections/{oauth_connection_id}`

```ts
await soat.oauthConnections.deleteOauthConnection();
```

→ [Request & response schema](/docs/api/oauth-connections/delete-oauth-connection)
