Skip to main content

Policies

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

soat.policies.listPolicies()​

List all policies

  • Method: GET
  • Path: /api/v1/policies
await soat.policies.listPolicies({
  query: { /* + optional */ },
});

→ Request & response schema

soat.policies.createPolicy()​

Create a policy

  • Method: POST
  • Path: /api/v1/policies
await soat.policies.createPolicy({
  body: { document, /* + optional */ },
});

→ Request & response schema

soat.policies.getPolicy()​

Get a policy

  • Method: GET
  • Path: /api/v1/policies/{policy_id}
await soat.policies.getPolicy({
  path: { policy_id },
});

→ Request & response schema

soat.policies.updatePolicy()​

Update a policy

  • Method: PUT
  • Path: /api/v1/policies/{policy_id}
await soat.policies.updatePolicy({
  path: { policy_id },
  body: { document, /* + optional */ },
});

→ Request & response schema

soat.policies.deletePolicy()​

Delete a policy

  • Method: DELETE
  • Path: /api/v1/policies/{policy_id}
await soat.policies.deletePolicy({
  path: { policy_id },
});

→ Request & response schema