updateRestrictions()
Updates the restriction settings for the current instance.
Returns the updated InstanceRestrictions object.
function updateRestrictions(params: UpdateRestrictionsParams): Promise<InstanceRestrictions>- Name
-
allowlist? - Type
boolean | null- Description
Whether the instance should have Allowlist enabled.
- Name
-
blockDisposableEmailDomains? - Type
boolean | null- Description
Whether the instance should have Block sign-ups that use disposable email domains enabled.
- Name
-
blockEmailSubaddresses? - Type
boolean | null- Description
Whether the instance should have Block email subaddresses enabled.
- Name
-
blocklist? - Type
boolean | null- Description
Whether the instance should have Blocklist enabled.
- Name
-
ignoreDotsForGmailAddresses? - Type
boolean | null- Description
Whether the instance should ignore dots for Gmail addresses.
const response = await clerkClient.instances.updateRestrictions({
allowlist: true,
blockEmailSubaddresses: true,
})Backend API (BAPI) endpoint
This method in the SDK is a wrapper around the BAPI endpoint PATCH/instance/restrictions. See the BAPI reference for more information.
Feedback
Last updated on