1. Docs
  2. API Reference
  3. Get an Environment's sign-in settings

Get an Environment's sign-in settings

GET/portal/v1/accounts/{accountSlug}/applications/{appSlug}/environments/{envSlug}/auth-settings

Returns the sign-in settings of the Environment named by :envSlug: MFA enforcement (hydrated with platform defaults), self-signup and CAPTCHA controls, login-method switches, token lifetimes, allowed browser origins, SSO return URLs, and the origin auth-email links point at (auth_links_base_url). Keys the customer never set are omitted except the hydrated MFA bundle. Returns 404 when the slug does not exist.

Authentication

Bearer TokenAuthorization

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

Requires capability auth_settings.viewDeveloper Console

View Environment sign-in settings. 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.

appSlugstring Required

The Application's slug within the Account.

envSlugstring Required

Responses

application/json

  • dataEnvironmentAuthSettingsResponseDto*

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

EnvironmentAuthSettingsResponseDtoView all properties on this resource
Request
curl -X GET "https://auth.canopy-io.com/portal/v1/accounts/value/applications/value/environments/value/auth-settings" \
  -H "Authorization: Bearer $CANOPY_TOKEN"
Response
{
  "data": {
    "environment_slug": "string",
    "mfa_required": false,
    "mfa_grace_period_days": 0,
    "mfa_trusted_device_days": 0,
    "mfa_factor_allowlist": [
      "string"
    ],
    "mfa_after_sso": "exempt",
    "webauthn_rp_id": "string",
    "webauthn_origins": [
      "string"
    ],
    "allow_self_signup": false,
    "self_signup_require_captcha": false,
    "login_require_captcha": false,
    "password_login_enabled": false,
    "email_otp_login_enabled": false,
    "self_signup_daily_cap": 0,
    "access_token_ttl_seconds": 0,
    "refresh_token_ttl_days": 0,
    "m2m_access_token_ttl_seconds": 0,
    "m2m_default_audience": "string",
    "organization_integrations_enabled": false,
    "organization_integration_role_ids": [
      "string"
    ],
    "allowed_web_origins": [
      "string"
    ],
    "sso_return_urls": [
      "string"
    ],
    "idp_arrival_roles": {
      "role_ids": [
        "string"
      ],
      "default_role_id": "string"
    },
    "auth_links_base_url": "string",
    "initiate_login_uri": "string",
    "organizations_create_on_signup": false,
    "organizations_signup_member_role_id": "string",
    "organizations_membership_required": false,
    "identities_without_organization_count": 0
  }
}
 Related endpoints
GETList Environments in an Application
POSTCreate a new Environment in an Application
GETGet a single Environment by slug
PATCHRename or re-slug an Environment
DELETEDelete an Environment
PATCHChange an Environment's sign-in settings
GETGet an Environment's branding
PATCHChange an Environment's branding
GETExport an Environment's configuration as JSON
POSTReplace an Environment's configuration from a JSON payload (destructive)
GETGet the Environment's access model
PUTSwitch the Environment's access model
PUTSwitch the Environment's organizations container on or off
GETGet hierarchy schema for the active Environment
PATCHUpdate hierarchy schema for the active Environment
GETList hierarchy node types with existing nodes
POSTRevert this Environment from hierarchy to flat
 Was this page helpful?

Tell us how we can improve this guide.

Canopy