Skip to main content

IAM

SDK methods for the IAM module, accessed via soat.iam. See the IAM module docs 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
await soat.iam.checkIamPermission({
body: { action, resource, /* + optional */ },
});

→ Request & response schema

soat.iam.createIamToken()​

Issue an IAM token

  • Method: POST
  • Path: /api/v1/iam/tokens
await soat.iam.createIamToken({
body: { /* + optional */ },
});

→ Request & response schema

soat.iam.revokeIamPrincipal()​

Revoke a principal

  • Method: POST
  • Path: /api/v1/iam/principal-revocations
await soat.iam.revokeIamPrincipal({
body: { principal, /* + optional */ },
});

→ Request & response schema