Get the environment's end-user auth settings
GET /v1/user_management/settings: Get the environment's end-user auth settings.
GET /
- Scope
users:read- Auth
- Secret key (
sk_…) - Since
- 1.0
Headers
Section titled “Headers”
Minor version; defaults to the environment’s pin.OhAuthCat-Versionstring
Responses
Section titled “Responses”- 200 OK UserManagementSettings
- 401 Codes: authentication_required, api_key_invalid. Error
- 403 Codes: api_key_scope_missing, ip_not_allowed, plan_limit_reached. Error
- 429 Code: rate_limited. Retry-After is set. Error
- 503 Code: service_unavailable. Retry-After is set; writes are paused. Error
- default Any other error, including internal_error. Every code is in the error catalogue. Error
Errors share one shape; see the error code catalogue.
curl -X GET \ "https://api.ohauthcat.com/v1/user_management/settings" \ -H "Authorization: Bearer $OHAUTHCAT_API_KEY"const response = await fetch("https://api.ohauthcat.com/v1/user_management/settings", { method: "GET", headers: { Authorization: `Bearer ${process.env.OHAUTHCAT_API_KEY}`, },});const data = await response.json();import osimport requests
response = requests.get( "https://api.ohauthcat.com/v1/user_management/settings", headers={"Authorization": f"Bearer {os.environ['OHAUTHCAT_API_KEY']}"},)data = response.json(){ "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" } ]}