Set an organization's end-user auth overrides
PUT /v1/organizations/{org}/user_management_settings: Set an organization's end-user auth overrides.
Business and above.
PUT /
- Scope
users:write- Auth
- Secret key (
sk_…) - Since
- 1.0
Path parameters
Section titled “Path parameters”orgstring Required
Headers
Section titled “Headers”
Minor version; defaults to the environment’s pin.OhAuthCat-Versionstring
Request body
Section titled “Request body”mfa_requiredboolean Requiredmethodsarray of string or null
End users whose email is on one of the organization’s verified domains must sign in with SSO. The hosted login routes them to the organization’s SSO when it can (an active, tested connection and a flow started by an app) and otherwise refuses withsso_requiredbooleanend_user_sso_required; password, magic-code, passkey and social first factors (hosted and headless) are refused withend_user_sso_requiredfor them. Domains without the policy answer exactly as before, so the identify step reveals nothing about a domain that does not route to SSO. Default false; omitted on update keeps false.
Responses
Section titled “Responses”- 200 OK OrganizationUserManagementSettings
- 400 Invalid request. Codes: parameter_invalid, parameter_missing, version_unsupported and resource-specific codes from the catalogue. Error
- 401 Codes: authentication_required, api_key_invalid. Error
- 403 Codes: api_key_scope_missing, ip_not_allowed, plan_limit_reached. Error
- 404 Code: resource_not_found (also returned for other tenants’ IDs); a path no endpoint serves answers route_not_found. A browser GET or HEAD of an unknown path whose Accept ranks text/html above JSON gets an HTML 404 page instead, with the same status; every other client gets this JSON body. 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 PUT \ "https://api.ohauthcat.com/v1/organizations/org_01J9Z3K5V7W8X9Y0Z1A2B3C4D5/user_management_settings" \ -H "Authorization: Bearer $OHAUTHCAT_API_KEY" \ -H "Content-Type: application/json" \ -d '{ "mfa_required": true}'const response = await fetch("https://api.ohauthcat.com/v1/organizations/org_01J9Z3K5V7W8X9Y0Z1A2B3C4D5/user_management_settings", { method: "PUT", headers: { Authorization: `Bearer ${process.env.OHAUTHCAT_API_KEY}`, "Content-Type": "application/json", }, body: JSON.stringify({ "mfa_required": true }),});const data = await response.json();import osimport requests
response = requests.put( "https://api.ohauthcat.com/v1/organizations/org_01J9Z3K5V7W8X9Y0Z1A2B3C4D5/user_management_settings", headers={"Authorization": f"Bearer {os.environ['OHAUTHCAT_API_KEY']}"}, json={ "mfa_required": True, },)data = response.json(){ "mfa_required": true, "methods": [ "password" ], "sso_required": true}