Member Junction
    Preparing search index...

    Interface CreateClaimServerParams

    Parameters for creating a new Identity Claim

    interface CreateClaimServerParams {
        ClaimBaseURL?: string;
        ClaimTypeID?: string;
        ClaimTypeName?: string;
        EmailSubject?: string;
        EmailTemplateID?: string;
        EntityID?: string;
        ExpiresAt?: Date;
        ExpiresInDays?: number;
        MagicLinkInviteID?: string;
        Metadata?: Record<string, unknown>;
        NormalizedEmail?: string;
        Payload?: Record<string, unknown>;
        RecordID?: string;
        SendEmail?: boolean;
        TemplateData?: Record<string, unknown>;
        VerificationToken?: string;
    }

    Hierarchy (View Summary)

    Index

    Properties

    ClaimBaseURL? ClaimTypeID? ClaimTypeName? EmailSubject? EmailTemplateID? EntityID? ExpiresAt? ExpiresInDays? MagicLinkInviteID? Metadata? NormalizedEmail? Payload? RecordID? SendEmail? TemplateData? VerificationToken?

    Properties

    ClaimBaseURL?: string

    Optional Magic Link base URL for verification links

    ClaimTypeID?: string

    ID of the IdentityClaimType (if Name is not provided)

    ClaimTypeName?: string

    Name of the IdentityClaimType

    EmailSubject?: string

    Optional custom email subject

    EmailTemplateID?: string

    Optional custom email template ID (overrides ClaimType template)

    EntityID?: string

    Optional polymorphic target entity ID

    ExpiresAt?: Date

    Exact expiry instant, for claims shorter than a day (whole days cannot express "ten minutes"). Takes precedence over ExpiresInDays. Must be a valid instant in the future.

    ExpiresInDays?: number

    Lifespan in days before expiration (defaults to ClaimType.DefaultExpirationDays)

    MagicLinkInviteID?: string

    Optional linked MagicLinkInvite ID for token verification

    Metadata?: Record<string, unknown>

    Optional tracking metadata

    NormalizedEmail?: string

    Email address of the intended recipient/claimant.

    Optional ONLY for claim types whose Configuration sets RequireToken: true. Such a claim is redeemed by its token alone, so it needs no recipient — for example, a link that hands an anonymous visitor's work to whoever signs in holding it. The claim is stored with an empty NormalizedEmail, which no account can match, so email-match redemption and auto-claim on login can never reach it. Every other claim type still requires an email.

    Payload?: Record<string, unknown>

    Optional payload data for driver consumption

    RecordID?: string

    Optional target record primary key ID

    SendEmail?: boolean

    Whether to send an email notification to claimant (defaults to true)

    TemplateData?: Record<string, unknown>

    Optional additional template data

    VerificationToken?: string

    Optional raw verification token. If not provided and MagicLinkInviteID is null, one is securely generated.

    Settings

    Member Visibility

    On This Page

    Properties