# IAM SDK Methods

> The soat.iam methods of the SOAT TypeScript SDK for the IAM module, each linked to its REST operation.

# IAM

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

### `soat.iam.checkIamPermission()`

Check a permission of the calling credential

- Method: `POST`
- Path: `/api/v1/iam/check`

```ts
await soat.iam.checkIamPermission({
  body: { action, resource, /* + optional */ },
});
```

→ [Request & response schema](/docs/api/iam/check-iam-permission)

### `soat.iam.createIamToken()`

Issue an IAM token

- Method: `POST`
- Path: `/api/v1/iam/tokens`

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

→ [Request & response schema](/docs/api/iam/create-iam-token)

### `soat.iam.revokeIamPrincipal()`

Revoke a principal

- Method: `POST`
- Path: `/api/v1/iam/principal-revocations`

```ts
await soat.iam.revokeIamPrincipal({
  body: { principal, /* + optional */ },
});
```

→ [Request & response schema](/docs/api/iam/revoke-iam-principal)
