Skip to main content
GET
Get a tenant's authentication policy

Authorizations

Authorization
string
header
required

A machine-client token from POST /v1/auth/client-token. Reads need the pulse.read scope; provisioning and tenant updates need pulse.write, which the token only carries when requested_scopes asks for it. Creating, changing, disabling and resetting MFA for users, and the tenant sign-in policy, need a signed-in user's token instead: they reject API-key tokens.

Path Parameters

tenantId
string<uuid>
required

The tenant: a tenant_id from List tenants (GET /v1/msp/admin/tenants). Must be your own tenant or one beneath it.

Response

OK

How users of one tenant sign in. The policy applies to that tenant only; tenants beneath it keep their own.

tenant_id
string<uuid>
required

The tenant the policy belongs to.

mfa_requirement
string
required

Whether users must use multi-factor authentication: disabled | required. New tenants start with disabled.

allowed_mfa_methods
enum<string>[]
required

The MFA methods users may use: email, totp (an authenticator app), or both. New tenants allow both.

Available options:
email,
totp
version
required

The policy's version. Send it as expected_version when you update the policy.

updated_at
string<date-time>
required

When the policy last changed: an ISO 8601 timestamp in UTC (offset +00:00).

require_sso
boolean
default:false

True when users must sign in with the tenant's single sign-on.