Interface AuthLinkCreateParams

Export

AuthLinkCreateParams

Hierarchy

  • AuthLinkCreateParams

Properties

expiration metadata? redirect_url? user_id

Properties

expiration

expiration: string

Expiration of the Auth Link (i.e.. 1d, 7d, 30d). Value must be between 0d and 30d.

Memberof

AuthLinkCreateParams

Optional metadata

metadata?: {
    [key: string]: string;
}

Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value (i.e. \'\' or null) to them. All keys can be unset by posting an empty value (i.e. {} or null) to metadata.

Memberof

AuthLinkCreateParams

Type declaration

  • [key: string]: string

Optional redirect_url

redirect_url?: string

The console url to redirect the user to after authenticating. Defaults to /dashboard if not provided.

Memberof

AuthLinkCreateParams

user_id

user_id: string

The id of the user.

Memberof

AuthLinkCreateParams

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc