@leancodepl/kratos/dist/lib/kratos/api.generated/models/VerificationFlow.d.ts

Headless React components library for building Ory Kratos authentication flows

import { UiContainer } from './UiContainer';
/**
 * Used to verify an out-of-band communication
 * channel such as an email address or a phone number.
 *
 * For more information head over to: https://www.ory.sh/docs/kratos/self-service/flows/verify-email-account-activation
 * @export
 * @interface VerificationFlow
 */
export interface VerificationFlow {
    /**
     * Active, if set, contains the registration method that is being used. It is initially
     * not set.
     * @type {string}
     * @memberof VerificationFlow
     */
    active?: string;
    /**
     * ExpiresAt is the time (UTC) when the request expires. If the user still wishes to verify the address,
     * a new request has to be initiated.
     * @type {Date}
     * @memberof VerificationFlow
     */
    expires_at?: Date;
    /**
     * ID represents the request's unique ID. When performing the verification flow, this
     * represents the id in the verify ui's query parameter: http://<selfservice.flows.verification.ui_url>?request=<id>
     *
     * type: string
     * format: uuid
     * @type {string}
     * @memberof VerificationFlow
     */
    id: string;
    /**
     * IssuedAt is the time (UTC) when the request occurred.
     * @type {Date}
     * @memberof VerificationFlow
     */
    issued_at?: Date;
    /**
     * RequestURL is the initial URL that was requested from Ory Kratos. It can be used
     * to forward information contained in the URL's path or query for example.
     * @type {string}
     * @memberof VerificationFlow
     */
    request_url?: string;
    /**
     * ReturnTo contains the requested return_to URL.
     * @type {string}
     * @memberof VerificationFlow
     */
    return_to?: string;
    /**
     * State represents the state of this request:
     *
     * choose_method: ask the user to choose a method (e.g. verify your email)
     * sent_email: the email has been sent to the user
     * passed_challenge: the request was successful and the verification challenge was passed.
     * @type {any}
     * @memberof VerificationFlow
     */
    state: any | null;
    /**
     * TransientPayload is used to pass data from the verification flow to hooks and email templates
     * @type {object}
     * @memberof VerificationFlow
     */
    transient_payload?: object;
    /**
     * The flow type can either be `api` or `browser`.
     * @type {string}
     * @memberof VerificationFlow
     */
    type: string;
    /**
     *
     * @type {UiContainer}
     * @memberof VerificationFlow
     */
    ui: UiContainer;
}
/**
 * Check if a given object implements the VerificationFlow interface.
 */
export declare function instanceOfVerificationFlow(value: object): value is VerificationFlow;
export declare function VerificationFlowFromJSON(json: any): VerificationFlow;
export declare function VerificationFlowFromJSONTyped(json: any, ignoreDiscriminator: boolean): VerificationFlow;
export declare function VerificationFlowToJSON(json: any): VerificationFlow;
export declare function VerificationFlowToJSONTyped(value?: VerificationFlow | null, ignoreDiscriminator?: boolean): any;
//# sourceMappingURL=VerificationFlow.d.ts.map