Interface AuthLinkDto

Export

AuthLinkDto

Hierarchy

  • AuthLinkDto

Properties

account_id created_at expires_at? id metadata? redeemed redirect_url? updated_at url user_id

Properties

account_id

account_id: string

The account id of the user that can authenticate with this auth link.

Memberof

AuthLinkDto

created_at

created_at: string

Time at which the auth link was created.

Memberof

AuthLinkDto

Optional expires_at

expires_at?: string

The expiration date of this auth link.

Memberof

AuthLinkDto

id

id: string

The id of the auth link.

Memberof

AuthLinkDto

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

AuthLinkDto

Type declaration

  • [key: string]: string

redeemed

redeemed: boolean

Indicates whether this auth link has been redeemed.

Memberof

AuthLinkDto

Optional redirect_url

redirect_url?: string

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

Memberof

AuthLinkDto

updated_at

updated_at: string

Time at which the auth link was last updated.

Memberof

AuthLinkDto

url

url: string

The url to use for authenticating via auth link.

Memberof

AuthLinkDto

user_id

user_id: string

The id of the user that can authenticate with this auth link.

Memberof

AuthLinkDto

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc