createAllowlistIdentifier()
Adds a new identifier to the allowlist.
function createAllowlistIdentifier: (params: AllowlistIdentifierCreateParams) => Promise<AllowlistIdentifier>;- Name
identifier- Type
string- Description
The
identifiercan be: a phone number in international E.164 format, an email address, or a wildcard email address (*.domain.com). Use this identifier value to allow any email address in a particular email domain.
- Name
notify- Type
boolean- Description
Whether to notify the owner of the identifier. The
notifyproperty is not available for wildcard identifiers.
const response = await clerkClient.allowlistIdentifiers.createAllowlistIdentifier({
identifier: 'test@example.com',
notify: false,
});
console.log(response);
/*
_AllowlistIdentifier {
id: 'alid_2b3VjS02AsRMoTcyLzMJ7mZvz4J',
identifier: 'test@example.com',
createdAt: 1705443883820,
updatedAt: 1705443883820,
invitationId: undefined
}
*/Backend API (BAPI) endpoint
This method in the SDK is a wrapper around the BAPI endpoint POST/allowlist-identifiers. See the BAPI reference for more details.