Environment

Used to get and update the current Environment

Get environment

Get the current environment. The environment contains information about the settings and features enabled for the current instance.

SecurityNone or DevBrowser

Responses

200

Returns the environment.

400

Request was not successful

401

Request was not successful

get/v1/environment

Response samples

application/json

{"auth_config": {"object": "auth_config",
"id": "string",
"first_name": "on",
"last_name": "on",
"email_address": "on",
"phone_number": "on",
"username": "on",
"password": "on",
"identification_requirements": [["string"
]
],
"identification_strategies": ["string"
],
"first_factors": ["string"
],
"second_factors": ["string"
],
"email_address_verification_strategies": ["string"
],
"single_session_mode": true,
"enhanced_email_deliverability": true,
"test_mode": true,
"claimed_at": 0,
"cookieless_dev": true,
"url_based_session_syncing": true
},
"display_config": {"object": "display_config",
"id": "string",
"instance_environment_type": "string",
"application_name": "string",
"theme": { },
"preferred_sign_in_strategy": "password",
"logo_image": {"object": "string",
"id": "string",
"name": "string",
"public_url": "string"
},
"logo_url": "string",
"logo_image_url": "string",
"favicon_image": {"object": "string",
"id": "string",
"name": "string",
"public_url": "string"
},
"favicon_url": "string",
"favicon_image_url": "string",
"home_url": "string",
"sign_in_url": "string",
"sign_up_url": "string",
"user_profile_url": "string",
"waitlist_url": "string",
"after_sign_in_url": "string",
"after_sign_up_url": "string",
"after_sign_out_one_url": "string",
"after_sign_out_all_url": "string",
"after_switch_session_url": "string",
"after_join_waitlist_url": "string",
"organization_profile_url": "string",
"create_organization_url": "string",
"after_create_organization_url": "string",
"after_leave_organization_url": "string",
"logo_link_url": "string",
"help_url": "string",
"privacy_policy_url": "string",
"terms_url": "string",
"support_email": "string",
"clerk_js_version": "string",
"branded": true,
"experimental_force_oauth_first": true,
"captcha_public_key": "string",
"captcha_public_key_invisible": "string",
"captcha_widget_type": "smart",
"captcha_provider": "turnstile",
"captcha_oauth_bypass": ["string"
],
"captcha_heartbeat": true,
"google_one_tap_client_id": "string",
"show_devmode_warning": true
},
"user_settings": {"attributes": {"email_address": {"enabled": true,
"required": true,
"used_for_first_factor": true,
"first_factors": ["string"
],
"used_for_second_factor": true,
"second_factors": ["string"
],
"verifications": ["string"
],
"verify_at_sign_up": true
},
"phone_number": {"enabled": true,
"required": true,
"used_for_first_factor": true,
"first_factors": ["string"
],
"used_for_second_factor": true,
"second_factors": ["string"
],
"verifications": ["string"
],
"verify_at_sign_up": true
},
"username": {"enabled": true,
"required": true,
"used_for_first_factor": true,
"first_factors": ["string"
],
"used_for_second_factor": true,
"second_factors": ["string"
],
"verifications": ["string"
],
"verify_at_sign_up": true
},
"password": {"enabled": true,
"required": true,
"used_for_first_factor": true,
"first_factors": ["string"
],
"used_for_second_factor": true,
"second_factors": ["string"
],
"verifications": ["string"
],
"verify_at_sign_up": true
},
"first_name": {"enabled": true,
"required": true,
"used_for_first_factor": true,
"first_factors": ["string"
],
"used_for_second_factor": true,
"second_factors": ["string"
],
"verifications": ["string"
],
"verify_at_sign_up": true
},
"last_name": {"enabled": true,
"required": true,
"used_for_first_factor": true,
"first_factors": ["string"
],
"used_for_second_factor": true,
"second_factors": ["string"
],
"verifications": ["string"
],
"verify_at_sign_up": true
},
"ticket": {"enabled": true,
"required": true,
"used_for_first_factor": true,
"first_factors": ["string"
],
"used_for_second_factor": true,
"second_factors": ["string"
],
"verifications": ["string"
],
"verify_at_sign_up": true
},
"web3_wallet": {"enabled": true,
"required": true,
"used_for_first_factor": true,
"first_factors": ["string"
],
"used_for_second_factor": true,
"second_factors": ["string"
],
"verifications": ["string"
],
"verify_at_sign_up": true
},
"authenticator_app": {"enabled": true,
"required": true,
"used_for_first_factor": true,
"first_factors": ["string"
],
"used_for_second_factor": true,
"second_factors": ["string"
],
"verifications": ["string"
],
"verify_at_sign_up": true
},
"backup_code": {"enabled": true,
"required": true,
"used_for_first_factor": true,
"first_factors": ["string"
],
"used_for_second_factor": true,
"second_factors": ["string"
],
"verifications": ["string"
],
"verify_at_sign_up": true
},
"passkey": {"enabled": true,
"required": true,
"used_for_first_factor": true,
"first_factors": ["string"
],
"used_for_second_factor": true,
"second_factors": ["string"
],
"verifications": ["string"
],
"verify_at_sign_up": true
}
},
"social": {"oauth_atlassian": {"enabled": true,
"required": true,
"authenticatable": true,
"block_email_subaddresses": true,
"strategy": "string",
"not_selectable": true,
"deprecated": true
},
"oauth_bitbucket": {"enabled": true,
"required": true,
"authenticatable": true,
"block_email_subaddresses": true,
"strategy": "string",
"not_selectable": true,
"deprecated": true
},
"oauth_discord": {"enabled": true,
"required": true,
"authenticatable": true,
"block_email_subaddresses": true,
"strategy": "string",
"not_selectable": true,
"deprecated": true
},
"oauth_dropbox": {"enabled": true,
"required": true,
"authenticatable": true,
"block_email_subaddresses": true,
"strategy": "string",
"not_selectable": true,
"deprecated": true
},
"oauth_facebook": {"enabled": true,
"required": true,
"authenticatable": true,
"block_email_subaddresses": true,
"strategy": "string",
"not_selectable": true,
"deprecated": true
},
"oauth_github": {"enabled": true,
"required": true,
"authenticatable": true,
"block_email_subaddresses": true,
"strategy": "string",
"not_selectable": true,
"deprecated": true
},
"oauth_gitlab": {"enabled": true,
"required": true,
"authenticatable": true,
"block_email_subaddresses": true,
"strategy": "string",
"not_selectable": true,
"deprecated": true
},
"oauth_google": {"enabled": true,
"required": true,
"authenticatable": true,
"block_email_subaddresses": true,
"strategy": "string",
"not_selectable": true,
"deprecated": true
},
"oauth_hubspot": {"enabled": true,
"required": true,
"authenticatable": true,
"block_email_subaddresses": true,
"strategy": "string",
"not_selectable": true,
"deprecated": true
},
"oauth_microsoft": {"enabled": true,
"required": true,
"authenticatable": true,
"block_email_subaddresses": true,
"strategy": "string",
"not_selectable": true,
"deprecated": true
},
"oauth_tiktok": {"enabled": true,
"required": true,
"authenticatable": true,
"block_email_subaddresses": true,
"strategy": "string",
"not_selectable": true,
"deprecated": true
},
"oauth_twitch": {"enabled": true,
"required": true,
"authenticatable": true,
"block_email_subaddresses": true,
"strategy": "string",
"not_selectable": true,
"deprecated": true
},
"oauth_twitter": {"enabled": true,
"required": true,
"authenticatable": true,
"block_email_subaddresses": true,
"strategy": "string",
"not_selectable": true,
"deprecated": true
},
"oauth_linkedin": {"enabled": true,
"required": true,
"authenticatable": true,
"block_email_subaddresses": true,
"strategy": "string",
"not_selectable": true,
"deprecated": true
},
"oauth_linkedin_oidc": {"enabled": true,
"required": true,
"authenticatable": true,
"block_email_subaddresses": true,
"strategy": "string",
"not_selectable": true,
"deprecated": true
},
"oauth_notion": {"enabled": true,
"required": true,
"authenticatable": true,
"block_email_subaddresses": true,
"strategy": "string",
"not_selectable": true,
"deprecated": true
},
"oauth_apple": {"enabled": true,
"required": true,
"authenticatable": true,
"block_email_subaddresses": true,
"strategy": "string",
"not_selectable": true,
"deprecated": true
},
"oauth_line": {"enabled": true,
"required": true,
"authenticatable": true,
"block_email_subaddresses": true,
"strategy": "string",
"not_selectable": true,
"deprecated": true
},
"oauth_coinbase": {"enabled": true,
"required": true,
"authenticatable": true,
"block_email_subaddresses": true,
"strategy": "string",
"not_selectable": true,
"deprecated": true
},
"oauth_box": {"enabled": true,
"required": true,
"authenticatable": true,
"block_email_subaddresses": true,
"strategy": "string",
"not_selectable": true,
"deprecated": true
},
"oauth_xero": {"enabled": true,
"required": true,
"authenticatable": true,
"block_email_subaddresses": true,
"strategy": "string",
"not_selectable": true,
"deprecated": true
},
"oauth_spotify": {"enabled": true,
"required": true,
"authenticatable": true,
"block_email_subaddresses": true,
"strategy": "string",
"not_selectable": true,
"deprecated": true
},
"oauth_slack": {"enabled": true,
"required": true,
"authenticatable": true,
"block_email_subaddresses": true,
"strategy": "string",
"not_selectable": true,
"deprecated": true
},
"oauth_linear": {"enabled": true,
"required": true,
"authenticatable": true,
"block_email_subaddresses": true,
"strategy": "string",
"not_selectable": true,
"deprecated": true
},
"oauth_x": {"enabled": true,
"required": true,
"authenticatable": true,
"block_email_subaddresses": true,
"strategy": "string",
"not_selectable": true,
"deprecated": true
},
"oauth_mock": {"enabled": true,
"required": true,
"authenticatable": true,
"block_email_subaddresses": true,
"strategy": "string",
"not_selectable": true,
"deprecated": true
},
"oauth_custom_mock": {"enabled": true,
"required": true,
"authenticatable": true,
"block_email_subaddresses": true,
"strategy": "string",
"not_selectable": true,
"deprecated": true
}
},
"saml": {"enabled": true
},
"sign_in": {"second_factor": {"required": true
}
},
"sign_up": {"captcha_enabled": true,
"captcha_widget_type": "string",
"custom_action_required": true,
"progressive": true,
"mode": "public",
"legal_consent_enabled": true
},
"restrictions": {"allowlist": {"enabled": true
},
"blocklist": {"enabled": true
},
"block_email_subaddresses": {"enabled": true
},
"block_disposable_email_domains": {"enabled": true
},
"ignore_dots_for_gmail_addresses": {"enabled": true
}
},
"username_settings": {"min_length": 0,
"max_length": 0
},
"password_settings": {"disable_hibp": true,
"min_length": 0,
"max_length": 0,
"require_special_char": true,
"require_numbers": true,
"require_uppercase": true,
"require_lowercase": true,
"show_zxcvbn": true,
"min_zxcvbn_strength": 4,
"enforce_hibp_on_sign_in": true,
"allowed_special_characters": "string"
},
"actions": {"delete_self": true,
"create_organization": true,
"create_organizations_limit": true
},
"attack_protection": {"user_lockout": {"enabled": true,
"duration_in_minutes": 0,
"max_attempts": 0
},
"pii": {"enabled": true
},
"email_link": {"require_same_client": true
}
},
"passkey_settings": {"allow_autofill": true,
"show_sign_in_button": true
}
},
"organization_settings": {"enabled": true,
"max_allowed_memberships": 0,
"actions": {"admin_delete": true
},
"domains": {"enabled": true,
"enrollment_modes": ["manual_invitation"
],
"default_role": "string"
},
"creator_role": "string"
},
"maintenance_mode": true
}

Update environment

Update environment using request origin

SecurityNone or DevBrowser

Responses

200

Returns the environment.

400

Request was not successful

patch/v1/environment

Response samples

application/json

{"auth_config": {"object": "auth_config",
"id": "string",
"first_name": "on",
"last_name": "on",
"email_address": "on",
"phone_number": "on",
"username": "on",
"password": "on",
"identification_requirements": [["string"
]
],
"identification_strategies": ["string"
],
"first_factors": ["string"
],
"second_factors": ["string"
],
"email_address_verification_strategies": ["string"
],
"single_session_mode": true,
"enhanced_email_deliverability": true,
"test_mode": true,
"claimed_at": 0,
"cookieless_dev": true,
"url_based_session_syncing": true
},
"display_config": {"object": "display_config",
"id": "string",
"instance_environment_type": "string",
"application_name": "string",
"theme": { },
"preferred_sign_in_strategy": "password",
"logo_image": {"object": "string",
"id": "string",
"name": "string",
"public_url": "string"
},
"logo_url": "string",
"logo_image_url": "string",
"favicon_image": {"object": "string",
"id": "string",
"name": "string",
"public_url": "string"
},
"favicon_url": "string",
"favicon_image_url": "string",
"home_url": "string",
"sign_in_url": "string",
"sign_up_url": "string",
"user_profile_url": "string",
"waitlist_url": "string",
"after_sign_in_url": "string",
"after_sign_up_url": "string",
"after_sign_out_one_url": "string",
"after_sign_out_all_url": "string",
"after_switch_session_url": "string",
"after_join_waitlist_url": "string",
"organization_profile_url": "string",
"create_organization_url": "string",
"after_create_organization_url": "string",
"after_leave_organization_url": "string",
"logo_link_url": "string",
"help_url": "string",
"privacy_policy_url": "string",
"terms_url": "string",
"support_email": "string",
"clerk_js_version": "string",
"branded": true,
"experimental_force_oauth_first": true,
"captcha_public_key": "string",
"captcha_public_key_invisible": "string",
"captcha_widget_type": "smart",
"captcha_provider": "turnstile",
"captcha_oauth_bypass": ["string"
],
"captcha_heartbeat": true,
"google_one_tap_client_id": "string",
"show_devmode_warning": true
},
"user_settings": {"attributes": {"email_address": {"enabled": true,
"required": true,
"used_for_first_factor": true,
"first_factors": ["string"
],
"used_for_second_factor": true,
"second_factors": ["string"
],
"verifications": ["string"
],
"verify_at_sign_up": true
},
"phone_number": {"enabled": true,
"required": true,
"used_for_first_factor": true,
"first_factors": ["string"
],
"used_for_second_factor": true,
"second_factors": ["string"
],
"verifications": ["string"
],
"verify_at_sign_up": true
},
"username": {"enabled": true,
"required": true,
"used_for_first_factor": true,
"first_factors": ["string"
],
"used_for_second_factor": true,
"second_factors": ["string"
],
"verifications": ["string"
],
"verify_at_sign_up": true
},
"password": {"enabled": true,
"required": true,
"used_for_first_factor": true,
"first_factors": ["string"
],
"used_for_second_factor": true,
"second_factors": ["string"
],
"verifications": ["string"
],
"verify_at_sign_up": true
},
"first_name": {"enabled": true,
"required": true,
"used_for_first_factor": true,
"first_factors": ["string"
],
"used_for_second_factor": true,
"second_factors": ["string"
],
"verifications": ["string"
],
"verify_at_sign_up": true
},
"last_name": {"enabled": true,
"required": true,
"used_for_first_factor": true,
"first_factors": ["string"
],
"used_for_second_factor": true,
"second_factors": ["string"
],
"verifications": ["string"
],
"verify_at_sign_up": true
},
"ticket": {"enabled": true,
"required": true,
"used_for_first_factor": true,
"first_factors": ["string"
],
"used_for_second_factor": true,
"second_factors": ["string"
],
"verifications": ["string"
],
"verify_at_sign_up": true
},
"web3_wallet": {"enabled": true,
"required": true,
"used_for_first_factor": true,
"first_factors": ["string"
],
"used_for_second_factor": true,
"second_factors": ["string"
],
"verifications": ["string"
],
"verify_at_sign_up": true
},
"authenticator_app": {"enabled": true,
"required": true,
"used_for_first_factor": true,
"first_factors": ["string"
],
"used_for_second_factor": true,
"second_factors": ["string"
],
"verifications": ["string"
],
"verify_at_sign_up": true
},
"backup_code": {"enabled": true,
"required": true,
"used_for_first_factor": true,
"first_factors": ["string"
],
"used_for_second_factor": true,
"second_factors": ["string"
],
"verifications": ["string"
],
"verify_at_sign_up": true
},
"passkey": {"enabled": true,
"required": true,
"used_for_first_factor": true,
"first_factors": ["string"
],
"used_for_second_factor": true,
"second_factors": ["string"
],
"verifications": ["string"
],
"verify_at_sign_up": true
}
},
"social": {"oauth_atlassian": {"enabled": true,
"required": true,
"authenticatable": true,
"block_email_subaddresses": true,
"strategy": "string",
"not_selectable": true,
"deprecated": true
},
"oauth_bitbucket": {"enabled": true,
"required": true,
"authenticatable": true,
"block_email_subaddresses": true,
"strategy": "string",
"not_selectable": true,
"deprecated": true
},
"oauth_discord": {"enabled": true,
"required": true,
"authenticatable": true,
"block_email_subaddresses": true,
"strategy": "string",
"not_selectable": true,
"deprecated": true
},
"oauth_dropbox": {"enabled": true,
"required": true,
"authenticatable": true,
"block_email_subaddresses": true,
"strategy": "string",
"not_selectable": true,
"deprecated": true
},
"oauth_facebook": {"enabled": true,
"required": true,
"authenticatable": true,
"block_email_subaddresses": true,
"strategy": "string",
"not_selectable": true,
"deprecated": true
},
"oauth_github": {"enabled": true,
"required": true,
"authenticatable": true,
"block_email_subaddresses": true,
"strategy": "string",
"not_selectable": true,
"deprecated": true
},
"oauth_gitlab": {"enabled": true,
"required": true,
"authenticatable": true,
"block_email_subaddresses": true,
"strategy": "string",
"not_selectable": true,
"deprecated": true
},
"oauth_google": {"enabled": true,
"required": true,
"authenticatable": true,
"block_email_subaddresses": true,
"strategy": "string",
"not_selectable": true,
"deprecated": true
},
"oauth_hubspot": {"enabled": true,
"required": true,
"authenticatable": true,
"block_email_subaddresses": true,
"strategy": "string",
"not_selectable": true,
"deprecated": true
},
"oauth_microsoft": {"enabled": true,
"required": true,
"authenticatable": true,
"block_email_subaddresses": true,
"strategy": "string",
"not_selectable": true,
"deprecated": true
},
"oauth_tiktok": {"enabled": true,
"required": true,
"authenticatable": true,
"block_email_subaddresses": true,
"strategy": "string",
"not_selectable": true,
"deprecated": true
},
"oauth_twitch": {"enabled": true,
"required": true,
"authenticatable": true,
"block_email_subaddresses": true,
"strategy": "string",
"not_selectable": true,
"deprecated": true
},
"oauth_twitter": {"enabled": true,
"required": true,
"authenticatable": true,
"block_email_subaddresses": true,
"strategy": "string",
"not_selectable": true,
"deprecated": true
},
"oauth_linkedin": {"enabled": true,
"required": true,
"authenticatable": true,
"block_email_subaddresses": true,
"strategy": "string",
"not_selectable": true,
"deprecated": true
},
"oauth_linkedin_oidc": {"enabled": true,
"required": true,
"authenticatable": true,
"block_email_subaddresses": true,
"strategy": "string",
"not_selectable": true,
"deprecated": true
},
"oauth_notion": {"enabled": true,
"required": true,
"authenticatable": true,
"block_email_subaddresses": true,
"strategy": "string",
"not_selectable": true,
"deprecated": true
},
"oauth_apple": {"enabled": true,
"required": true,
"authenticatable": true,
"block_email_subaddresses": true,
"strategy": "string",
"not_selectable": true,
"deprecated": true
},
"oauth_line": {"enabled": true,
"required": true,
"authenticatable": true,
"block_email_subaddresses": true,
"strategy": "string",
"not_selectable": true,
"deprecated": true
},
"oauth_coinbase": {"enabled": true,
"required": true,
"authenticatable": true,
"block_email_subaddresses": true,
"strategy": "string",
"not_selectable": true,
"deprecated": true
},
"oauth_box": {"enabled": true,
"required": true,
"authenticatable": true,
"block_email_subaddresses": true,
"strategy": "string",
"not_selectable": true,
"deprecated": true
},
"oauth_xero": {"enabled": true,
"required": true,
"authenticatable": true,
"block_email_subaddresses": true,
"strategy": "string",
"not_selectable": true,
"deprecated": true
},
"oauth_spotify": {"enabled": true,
"required": true,
"authenticatable": true,
"block_email_subaddresses": true,
"strategy": "string",
"not_selectable": true,
"deprecated": true
},
"oauth_slack": {"enabled": true,
"required": true,
"authenticatable": true,
"block_email_subaddresses": true,
"strategy": "string",
"not_selectable": true,
"deprecated": true
},
"oauth_linear": {"enabled": true,
"required": true,
"authenticatable": true,
"block_email_subaddresses": true,
"strategy": "string",
"not_selectable": true,
"deprecated": true
},
"oauth_x": {"enabled": true,
"required": true,
"authenticatable": true,
"block_email_subaddresses": true,
"strategy": "string",
"not_selectable": true,
"deprecated": true
},
"oauth_mock": {"enabled": true,
"required": true,
"authenticatable": true,
"block_email_subaddresses": true,
"strategy": "string",
"not_selectable": true,
"deprecated": true
},
"oauth_custom_mock": {"enabled": true,
"required": true,
"authenticatable": true,
"block_email_subaddresses": true,
"strategy": "string",
"not_selectable": true,
"deprecated": true
}
},
"saml": {"enabled": true
},
"sign_in": {"second_factor": {"required": true
}
},
"sign_up": {"captcha_enabled": true,
"captcha_widget_type": "string",
"custom_action_required": true,
"progressive": true,
"mode": "public",
"legal_consent_enabled": true
},
"restrictions": {"allowlist": {"enabled": true
},
"blocklist": {"enabled": true
},
"block_email_subaddresses": {"enabled": true
},
"block_disposable_email_domains": {"enabled": true
},
"ignore_dots_for_gmail_addresses": {"enabled": true
}
},
"username_settings": {"min_length": 0,
"max_length": 0
},
"password_settings": {"disable_hibp": true,
"min_length": 0,
"max_length": 0,
"require_special_char": true,
"require_numbers": true,
"require_uppercase": true,
"require_lowercase": true,
"show_zxcvbn": true,
"min_zxcvbn_strength": 4,
"enforce_hibp_on_sign_in": true,
"allowed_special_characters": "string"
},
"actions": {"delete_self": true,
"create_organization": true,
"create_organizations_limit": true
},
"attack_protection": {"user_lockout": {"enabled": true,
"duration_in_minutes": 0,
"max_attempts": 0
},
"pii": {"enabled": true
},
"email_link": {"require_same_client": true
}
},
"passkey_settings": {"allow_autofill": true,
"show_sign_in_button": true
}
},
"organization_settings": {"enabled": true,
"max_allowed_memberships": 0,
"actions": {"admin_delete": true
},
"domains": {"enabled": true,
"enrollment_modes": ["manual_invitation"
],
"default_role": "string"
},
"creator_role": "string"
},
"maintenance_mode": true
}

➔ Next to Client