Get an organization's authentication policy

GET

/api/v1/organizations/{id}/policy

Returns the organization's own authentication policy (null fields inherit the Environment) alongside the effective policy its members sign in under. Requires the hierarchy.view permission at the organization.

Authentication

Bearer TokenAuthorization Option A

JWT access token

API KeyX-API-Key Option B

API key for management-tier access

Path Parameters

idstring Required

Responses

application/json

dataOrganizationPolicyResponseDto*

application/json

errorApiErrorBodyDto*

application/json

errorApiErrorBodyDto*

application/json

errorApiErrorBodyDto*

Returned object

OrganizationPolicyResponseDtoView all properties on this resource

Request

curl -X GET "https://auth.canopy-io.com/api/v1/organizations/value/policy" \
  -H "X-API-Key: $CANOPY_API_KEY"

Response

{
  "data": {
    "organization_id": "string",
    "mfa_required": false,
    "mfa_factor_allowlist": [
      "totp"
    ],
    "mfa_after_sso": "exempt",
    "require_sso": false,
    "environment": {
      "mfa_required": false,
      "mfa_factor_allowlist": [
        "totp"
      ],
      "mfa_after_sso": "exempt",
      "require_sso": false
    },
    "effective": {
      "mfa_required": false,
      "mfa_factor_allowlist": [
        "totp"
      ],
      "mfa_after_sso": "exempt",
      "require_sso": false
    },
    "version": 0
  }
}

GETList organizations
POSTCreate an organization
DELETEDelete every organization
GETGet an organization
PATCHUpdate an organization
DELETEDelete an organization
PATCHUpdate an organization's authentication policy
GETList an organization's SSO connections
POSTBind an SSO connection to an organization
DELETEUnbind an SSO connection from an organization
GETList an organization's members
POSTAdd a member to an organization
PATCHChange a member's role
DELETERemove a member from an organization
GETList an organization's invitations
POSTInvite a member into an organization
DELETERevoke an organization invitation

Was this page helpful?

Tell us how we can improve this guide.