ZITADEL Docs
APIsCore ResourcesV2Settings

GetLoginSettings

Get Login Settings

Get the login settings for the requested context. This can be the instance or an organization. In case of an organization, the returned settings will fall back to the instance settings if not explicitly set on the organization.

Required permissions:

  • policy.read
GET
/v2/settings/login

Query Parameters

ctx.orgId?string
ctx.instance?boolean

Response Body

application/json

application/json

curl -X GET "https://loading/v2/settings/login"
{
  "details": {
    "sequence": 0,
    "changeDate": "1s",
    "resourceOwner": "string",
    "creationDate": "1s"
  },
  "settings": {
    "allowUsernamePassword": true,
    "allowLocalAuthentication": true,
    "allowRegister": true,
    "allowExternalIdp": true,
    "forceMfa": true,
    "passkeysType": "PASSKEYS_TYPE_NOT_ALLOWED",
    "hidePasswordReset": true,
    "ignoreUnknownUsernames": true,
    "defaultRedirectUri": "string",
    "passwordCheckLifetime": "string",
    "externalLoginCheckLifetime": "string",
    "mfaInitSkipLifetime": "string",
    "secondFactorCheckLifetime": "string",
    "multiFactorCheckLifetime": "string",
    "secondFactors": [
      "SECOND_FACTOR_TYPE_UNSPECIFIED"
    ],
    "multiFactors": [
      "MULTI_FACTOR_TYPE_UNSPECIFIED"
    ],
    "allowDomainDiscovery": true,
    "disableLoginWithEmail": true,
    "disableLoginWithPhone": true,
    "resourceOwnerType": "RESOURCE_OWNER_TYPE_UNSPECIFIED",
    "forceMfaLocalOnly": true
  }
}
{
  "code": "not_found",
  "message": "string",
  "detail": {
    "type": "string",
    "value": "string",
    "debug": {}
  }
}

Was this page helpful?