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

Headless React components library for building Ory Kratos authentication flows

import { ContinueWith } from './ContinueWith';
import { UiContainer } from './UiContainer';
/**
 * This request is used when an identity wants to recover their account.
 *
 * We recommend reading the [Account Recovery Documentation](../self-service/flows/password-reset-account-recovery)
 * @export
 * @interface RecoveryFlow
 */
export interface RecoveryFlow {
    /**
     * Active, if set, contains the recovery method that is being used. It is initially
     * not set.
     * @type {string}
     * @memberof RecoveryFlow
     */
    active?: string;
    /**
     * Contains possible actions that could follow this flow
     * @type {Array<ContinueWith>}
     * @memberof RecoveryFlow
     */
    continue_with?: Array<ContinueWith>;
    /**
     * ExpiresAt is the time (UTC) when the request expires. If the user still wishes to update the setting,
     * a new request has to be initiated.
     * @type {Date}
     * @memberof RecoveryFlow
     */
    expires_at: Date;
    /**
     * ID represents the request's unique ID. When performing the recovery flow, this
     * represents the id in the recovery ui's query parameter: http://<selfservice.flows.recovery.ui_url>?request=<id>
     * @type {string}
     * @memberof RecoveryFlow
     */
    id: string;
    /**
     * IssuedAt is the time (UTC) when the request occurred.
     * @type {Date}
     * @memberof RecoveryFlow
     */
    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 RecoveryFlow
     */
    request_url: string;
    /**
     * ReturnTo contains the requested return_to URL.
     * @type {string}
     * @memberof RecoveryFlow
     */
    return_to?: string;
    /**
     * State represents the state of this request:
     *
     * choose_method: ask the user to choose a method (e.g. recover account via email)
     * sent_email: the email has been sent to the user
     * passed_challenge: the request was successful and the recovery challenge was passed.
     * @type {any}
     * @memberof RecoveryFlow
     */
    state: any | null;
    /**
     * TransientPayload is used to pass data from the recovery flow to hooks and email templates
     * @type {object}
     * @memberof RecoveryFlow
     */
    transient_payload?: object;
    /**
     * The flow type can either be `api` or `browser`.
     * @type {string}
     * @memberof RecoveryFlow
     */
    type: string;
    /**
     *
     * @type {UiContainer}
     * @memberof RecoveryFlow
     */
    ui: UiContainer;
}
/**
 * Check if a given object implements the RecoveryFlow interface.
 */
export declare function instanceOfRecoveryFlow(value: object): value is RecoveryFlow;
export declare function RecoveryFlowFromJSON(json: any): RecoveryFlow;
export declare function RecoveryFlowFromJSONTyped(json: any, ignoreDiscriminator: boolean): RecoveryFlow;
export declare function RecoveryFlowToJSON(json: any): RecoveryFlow;
export declare function RecoveryFlowToJSONTyped(value?: RecoveryFlow | null, ignoreDiscriminator?: boolean): any;
//# sourceMappingURL=RecoveryFlow.d.ts.map