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

Headless React components library for building Ory Kratos authentication flows

import { OAuth2LoginRequest } from './OAuth2LoginRequest';
import { UiContainer } from './UiContainer';
/**
 *
 * @export
 * @interface RegistrationFlow
 */
export interface RegistrationFlow {
    /**
     * Active, if set, contains the registration method that is being used. It is initially
     * not set.
     * password CredentialsTypePassword
     * oidc CredentialsTypeOIDC
     * totp CredentialsTypeTOTP
     * lookup_secret CredentialsTypeLookup
     * webauthn CredentialsTypeWebAuthn
     * code CredentialsTypeCodeAuth
     * passkey CredentialsTypePasskey
     * profile CredentialsTypeProfile
     * saml CredentialsTypeSAML
     * link_recovery CredentialsTypeRecoveryLink  CredentialsTypeRecoveryLink is a special credential type linked to the link strategy (recovery flow).  It is not used within the credentials object itself.
     * code_recovery CredentialsTypeRecoveryCode
     * @type {string}
     * @memberof RegistrationFlow
     */
    active?: RegistrationFlowActiveEnum;
    /**
     * ExpiresAt is the time (UTC) when the flow expires. If the user still wishes to log in,
     * a new flow has to be initiated.
     * @type {Date}
     * @memberof RegistrationFlow
     */
    expires_at: Date;
    /**
     * ID represents the flow's unique ID. When performing the registration flow, this
     * represents the id in the registration ui's query parameter: http://<selfservice.flows.registration.ui_url>/?flow=<id>
     * @type {string}
     * @memberof RegistrationFlow
     */
    id: string;
    /**
     * IssuedAt is the time (UTC) when the flow occurred.
     * @type {Date}
     * @memberof RegistrationFlow
     */
    issued_at: Date;
    /**
     * Ory OAuth 2.0 Login Challenge.
     *
     * This value is set using the `login_challenge` query parameter of the registration and login endpoints.
     * If set will cooperate with Ory OAuth2 and OpenID to act as an OAuth2 server / OpenID Provider.
     * @type {string}
     * @memberof RegistrationFlow
     */
    oauth2_login_challenge?: string;
    /**
     *
     * @type {OAuth2LoginRequest}
     * @memberof RegistrationFlow
     */
    oauth2_login_request?: OAuth2LoginRequest;
    /**
     *
     * @type {string}
     * @memberof RegistrationFlow
     */
    organization_id?: string | null;
    /**
     * 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 RegistrationFlow
     */
    request_url: string;
    /**
     * ReturnTo contains the requested return_to URL.
     * @type {string}
     * @memberof RegistrationFlow
     */
    return_to?: string;
    /**
     * SessionTokenExchangeCode holds the secret code that the client can use to retrieve a session token after the flow has been completed.
     * This is only set if the client has requested a session token exchange code, and if the flow is of type "api",
     * and only on creating the flow.
     * @type {string}
     * @memberof RegistrationFlow
     */
    session_token_exchange_code?: string;
    /**
     * State represents the state of this request:
     *
     * choose_method: ask the user to choose a method (e.g. registration with email)
     * sent_email: the email has been sent to the user
     * passed_challenge: the request was successful and the registration challenge was passed.
     * @type {any}
     * @memberof RegistrationFlow
     */
    state: any | null;
    /**
     * TransientPayload is used to pass data from the registration to a webhook
     * @type {object}
     * @memberof RegistrationFlow
     */
    transient_payload?: object;
    /**
     * The flow type can either be `api` or `browser`.
     * @type {string}
     * @memberof RegistrationFlow
     */
    type: string;
    /**
     *
     * @type {UiContainer}
     * @memberof RegistrationFlow
     */
    ui: UiContainer;
}
/**
 * @export
 */
export declare const RegistrationFlowActiveEnum: {
    readonly Password: "password";
    readonly Oidc: "oidc";
    readonly Totp: "totp";
    readonly LookupSecret: "lookup_secret";
    readonly Webauthn: "webauthn";
    readonly Code: "code";
    readonly Passkey: "passkey";
    readonly Profile: "profile";
    readonly Saml: "saml";
    readonly LinkRecovery: "link_recovery";
    readonly CodeRecovery: "code_recovery";
    readonly UnknownDefaultOpenApi: "11184809";
};
export type RegistrationFlowActiveEnum = typeof RegistrationFlowActiveEnum[keyof typeof RegistrationFlowActiveEnum];
/**
 * Check if a given object implements the RegistrationFlow interface.
 */
export declare function instanceOfRegistrationFlow(value: object): value is RegistrationFlow;
export declare function RegistrationFlowFromJSON(json: any): RegistrationFlow;
export declare function RegistrationFlowFromJSONTyped(json: any, ignoreDiscriminator: boolean): RegistrationFlow;
export declare function RegistrationFlowToJSON(json: any): RegistrationFlow;
export declare function RegistrationFlowToJSONTyped(value?: RegistrationFlow | null, ignoreDiscriminator?: boolean): any;
//# sourceMappingURL=RegistrationFlow.d.ts.map