wihan/dev

docs /clerk / resources

markdown
browse the clerk docs

clerk_allowlist_identifier (Resource)

An entry in the sign-up allowlist. When the allowlist restriction is on, only identifiers on this list can sign up.

Example Usage

# Allow one address.
resource "clerk_allowlist_identifier" "founder" {
  identifier = "[email protected]"
}

# Allow a whole domain.
resource "clerk_allowlist_identifier" "company" {
  identifier = "*@example.com"
}

Schema

Required

  • identifier (String) Email address, phone number (with a + prefix), username, or a wildcard domain such as *@example.com. A change forces a replacement.

Optional

  • notify (Boolean) Send an invitation email on create. Only valid for an email identifier. Clerk never returns this value; a change forces a replacement. Defaults to false.

Read-Only

  • id (String) Allowlist identifier id.
  • identifier_type (String) Type that Clerk detected: email_address, phone_number, or web3_wallet.

Import

Import is supported using the following syntax:

The terraform import command can be used, for example:

terraform import clerk_allowlist_identifier.founder alid_2abcDEFghiJKLmnoPQRstuVWXyz