Retrieve authentication options
Retrieves the current authentication configuration, including enabled authenticators, sign-in and sign-up behavior, and external identity provider settings.
API-KeyX-API-KEY<token>MonoCloud APIs require authentication with an API key. Retrieve your key from the Tenant Settings section of the MonoCloud dashboard and include it in the request header as: X-API-Key: <your_api_key>
Response Body
application/json
The authentication options were retrieved successfully
TypeScript Definitions
Use the response body type in TypeScript.
Authentication Options Response: Represents the current authentication configuration for the tenant.
Errors
curl -X GET "https://your-domain.us.monocloud.com/api/options/authentication" \ -H "X-API-KEY: <token>"{ "pushed_authorization": { "enable_pushed_authorization_requests": true, "require_pushed_authorization_requests": true }, "account_protection": { "user_lockout": { "enabled": true, "max_failed_access_attempts": 0, "user_lockout_time_span": 0, "ip_lockout_time_span": 0, "allowed_ips": [ "string" ], "lockout_type": "ip", "user_unblock": { "email": { "expiry": 0 } } } }, "authenticators": { "external_sign_in_methods_first": true, "password": { "enable_sign_in": true, "enable_sign_up": true, "prompt_password_on_initial_screen": true, "expiry": null, "strength": { "minimum_length": 0, "require_non_alphanumeric_character": true, "require_digit": true, "require_lowercase_character": true, "require_uppercase_character": true, "required_unique_characters_count": 0 }, "reuse": { "restriction_mode": "off", "restriction_period": 0, "restriction_count": 0 } }, "passkey": { "enable_sign_in": true, "enable_sign_up": true, "prompt_enrollment": true, "prompt_device_enrollment": true, "enable_auto_complete": true, "show_passkey_button": true }, "email": { "enable_sign_in": true, "enable_sign_up": true, "enable_jit_provisioning": true, "verification_type": "link", "allow_cross_browser": true, "expiry": 0, "code_length": 0 }, "phone": { "enable_sign_in": true, "enable_sign_up": true, "enable_jit_provisioning": true, "expiry": 0, "code_length": 0 } }, "identifiers": { "email": { "enable_sign_in": true, "show_at_sign_up": true, "required_at_sign_up": true, "verification": { "verify_at_sign_up": true, "verification_type": "link", "allow_cross_browser": true, "expiry": 0, "code_length": 0 } }, "phone": { "enable_sign_in": true, "show_at_sign_up": true, "required_at_sign_up": true, "verification": { "verify_at_sign_up": true, "expiry": 0, "code_length": 0 } }, "username": { "enable_sign_in": true, "show_at_sign_up": true, "required_at_sign_up": true, "minimum_length": 0 } }, "recovery_methods": { "email": { "enabled": true, "verification_type": "link", "allow_cross_browser": true, "expiry": 0, "code_length": 0 }, "phone": { "enabled": true, "expiry": 0, "code_length": 0 } }, "session": { "persistence_mode": "user_selected", "expiration_type": "sliding", "sliding_session_lifetime": 0, "absolute_session_lifetime": 0 }, "logout": { "automatic_redirect_after_logout": true, "show_logout_prompt": true }, "sign_up": { "show_terms_and_privacy_policy": true, "require_explicit_user_agreement": true, "privacy_url": null, "terms_url": null, "allowlist": { "enabled": true, "identifiers": [ "string" ] }, "blocklist": { "enabled": true, "identifiers": [ "string" ] } }}Revoke a key PUT
Revokes the specified cryptographic key, marking it as untrusted and immediately preventing it from being used for token signing or validation.
Update authentication options PATCH
Applies a partial update to the authentication configuration, including internal and external authenticators, sign-in behavior, and provider-specific settings. Only fields included in the request are updated.