1. Docs
  2. API Reference
  3. Get the Account's policy for its administrators' second factor

Get the Account's policy for its administrators' second factor

GET/portal/v1/accounts/{accountSlug}/admin-mfa-policy

Returns the Account's policy for its administrators' second factor, with defaults for anything never set: required (false), grace_period_days (7), after_sso (exempt) and trusted_device_days (30). Requires account.manage, the Workspace's Administrator Sign-In settings. 404 when the Account is unknown.

Authentication

Bearer TokenAuthorization

JWT access token. Never send alongside X-API-Key: a request carrying both is refused.

Requires capability account.manageAccount

Edit account profile and general settings, including how administrators sign in. Granted through an administrator role in the Admin Workspace; a valid token without it is refused with 403.

Path Parameters

accountSlugstring Required

The Account's slug. An unknown one answers 404.

Responses

application/json

  • dataAdminMfaPolicyResponseDto*

application/json

  • errorApiErrorBodyDto*

application/json

  • errorApiErrorBodyDto*

application/json

  • errorApiErrorBodyDto*

Errors

When the request can't be completed, the response body includes a stable error code you can branch on, and a correlation_id (also sent as the X-Correlation-Id header). Quote the correlation id when you contact support: it identifies the exact request in Canopy's logs.

403account.capability_requiredForbidden
When it happens

The signed-in user's administrator roles do not grant the capability this endpoint requires.

Remediation

Ask an account administrator to grant a role carrying the capability named in the Authentication section, then retry.

Returned object

AdminMfaPolicyResponseDtoView all properties on this resource
Request
curl -X GET "https://auth.canopy-io.com/portal/v1/accounts/value/admin-mfa-policy" \
  -H "Authorization: Bearer $CANOPY_TOKEN"
Response
{
  "data": {
    "required": false,
    "grace_period_days": 0,
    "after_sso": "exempt",
    "trusted_device_days": 0
  }
}
 Related endpoints
GETGet the current Account
PATCHUpdate the Account name or settings
DELETEDelete the Account (owner only)
GETGet the Account's hosted-page settings
PATCHUpdate the Account's hosted-page settings
PATCHUpdate the Account's policy for its administrators' second factor
 Was this page helpful?

Tell us how we can improve this guide.

Canopy