Skip to content
Dashboard
Theme
Theme

Replace the environment's end-user auth settings

PUT /v1/user_management/settings: Replace the environment's end-user auth settings.

View Markdown

PUT /v1/user_management/settings

Scope
users:write
Auth
Secret key (sk_…)
Since
1.0
  • OhAuthCat-Version string

    Minor version; defaults to the environment’s pin.

  • app_name string or null

    max length 100

  • methods array of string Required

    min items 1

  • password_min_length integer Required

    min 8 · max 64

  • password_history integer Required

    min 0 · max 24

  • password_check_breached boolean Required

  • password_require_character_types boolean

    Passwords must contain at least one uppercase letter, one lowercase letter, one number and one symbol (any character that is not a letter or digit; Unicode-aware, and a letter of a script without case counts as both upper and lower case). On by default for every environment (D191). A password that lacks one is refused with password_invalid, param: password and one details item per missing type (problem: missing_uppercase, missing_lowercase, missing_number or missing_symbol). Omitted on update means true.

    default true

  • bind_browser boolean Required

    Email codes and reset links work only in the browser that asked for them.

  • mfa_policy string Required

    one of off, optional, required

  • linking_rule string Required

    Whether a social sign-in may join an existing user, and only on an email the provider asserts is verified.

    one of verified_email, never

  • session_absolute_seconds integer Required

    min 300 · max 7776000

  • session_idle_seconds integer Required

    min 300 · max 7776000

  • require_name boolean

    Sign-up on the hosted pages asks for a first and last name. Absent reads as false.

  • native_app_origins array of string

    Native apps whose passkey ceremonies are accepted on the hosted sign-in relying party, as android:apk-key-hash:<base64url SHA-256 of the signing certificate> or ios:<team id>.<bundle id>. Absent reads as none.

    max items 20

  • android_apps array of AndroidAppLink

    Android package names for the sign-in host’s /.well-known/assetlinks.json (passkeys and sign-in credentials shared with the app). Each apk_key_hash must also be listed in native_app_origins as android:apk-key-hash:<hash>. Absent reads as none.

    max items 20

Errors share one shape; see the error code catalogue.

curl -X PUT \
"https://api.ohauthcat.com/v1/user_management/settings" \
-H "Authorization: Bearer $OHAUTHCAT_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"methods": [
"password"
],
"password_min_length": 8,
"password_history": 0,
"password_check_breached": true,
"bind_browser": true,
"mfa_policy": "off",
"linking_rule": "verified_email",
"session_absolute_seconds": 300,
"session_idle_seconds": 300
}'
Response 200
{
"app_name": "example_app_name",
"methods": [
"password"
],
"password_min_length": 8,
"password_history": 0,
"password_check_breached": true,
"password_require_character_types": true,
"bind_browser": true,
"mfa_policy": "off",
"linking_rule": "verified_email",
"session_absolute_seconds": 300,
"session_idle_seconds": 300,
"require_name": true,
"native_app_origins": [
"example_native_app_origin"
],
"android_apps": [
{
"package_name": "example_package_name",
"apk_key_hash": "example_apk_key_hash"
}
]
}