Platform API reference

Platform API · Workspaces

get/v1/workspaces/{workspace_slug}/securityAuth

Get the workspace security policy

Whether members must use two-step sign-in, since when, and the grace period. Callers holding `workspace.member.read` also get each member's status (enabled, deadline, blocked).

Path parameters

workspace_slug*string

Slug of the workspace. Platform routes name the workspace by slug, positionally in the SDK (`platform.workspaces.retrieve("acme")`); the product APIs bind `workspace_id` instead.

Response · 200

mfa_required*boolean

Whether members must use two-step sign-in.

mfa_required_since*string · date-time

When the requirement was turned on.

grace_period_days*number

Days a member has to turn it on.

membersarray

Per-member status; only for callers holding `workspace.member.read`.

Example

Request

GET https://api.platform-auth.productcraft.co/v1/workspaces/{workspace_slug}/security
Authorization: Bearer YOUR_TOKEN

Response

{
  "mfa_required": false,
  "mfa_required_since": "2026-01-01T00:00:00.000Z",
  "grace_period_days": 0,
  "members": [
    {
      "account_id": "00000000-0000-0000-0000-000000000000",
      "username": "string",
      "display_name": "string",
      "email": "user@example.com",
      "mfa_enabled": false,
      "deadline": "2026-01-01T00:00:00.000Z",
      "blocked": false
    }
  ]
}