AUTH.SETTINGS

POST 

Returns the public settings for authentication

Request

application/json

Body

action stringrequired

Default value: auth.settings

The action

Responses

200

Settings response

application/json

Schema

Schema

data object
allow_email_signup boolean
allow_oauth_signup boolean
email_settings object
account_update_verification_method string
authentication_method string
enabled boolean
password_policy object
LENGTH integer[]
LOWERCASE boolean
NUMBERS boolean
SYMBOLS boolean
UPPERCASE boolean
password_policy_name string
password_recovery_method string
verify_email_on_signup boolean
enable_email_provider boolean
enable_oauth_providers boolean
enabled boolean
oauth_providers object

Example (from schema)

{
  "data": {
    "allow_email_signup": true,
    "allow_oauth_signup": true,
    "email_settings": {
      "account_update_verification_method": "string",
      "authentication_method": "string",
      "enabled": true,
      "password_policy": {
        "LENGTH": [
          0
        ],
        "LOWERCASE": true,
        "NUMBERS": true,
        "SYMBOLS": true,
        "UPPERCASE": true
      },
      "password_policy_name": "string",
      "password_recovery_method": "string",
      "verify_email_on_signup": true
    },
    "enable_email_provider": true,
    "enable_oauth_providers": true,
    "enabled": true,
    "oauth_providers": {}
  }
}

Loading...