clerk.update_instance_restrictions
Update sign-up and sign-in restriction settings for a connected Clerk instance.
Call clerk.get_connected_accounts first. Pass clerk_instance_id to target a specific connection, or omit it to use the default account.
Returns the updated instance restrictions.
Cost = 8 tokens.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| allowlist | No | Whether the allowlist restriction should be enabled. | |
| blocklist | No | Whether the blocklist restriction should be enabled. | |
| clerk_instance_id | No | Clerk instance id (ins_...) from clerk.get_connected_accounts. Omit to use the default connected account. | |
| block_email_subaddresses | No | Whether email subaddresses (plus-addressing) should be blocked. | |
| block_disposable_email_domains | No | Whether disposable email domains should be blocked. | |
| allowlist_blocklist_disabled_on_sign_in | No | Whether allowlist and blocklist checks should be skipped during sign-in. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| restrictions | No | Updated Clerk instance restrictions from the Backend API. |