@leancodepl/kratos
Version:
Headless React components library for building Ory Kratos authentication flows
102 lines (101 loc) • 5.98 kB
TypeScript
/**
* Ory APIs
* # Introduction Documentation for all public and administrative Ory APIs. Administrative APIs can only be accessed with a valid Personal Access Token. Public APIs are mostly used in browsers. ## SDKs This document describes the APIs available in the Ory Network. The APIs are available as SDKs for the following languages: | Language | Download SDK | Documentation | | -------------- | ---------------------------------------------------------------- | ------------------------------------------------------------------------------------ | | Dart | [pub.dev](https://pub.dev/packages/ory_client) | [README](https://github.com/ory/sdk/blob/master/clients/client/dart/README.md) | | .NET | [nuget.org](https://www.nuget.org/packages/Ory.Client/) | [README](https://github.com/ory/sdk/blob/master/clients/client/dotnet/README.md) | | Elixir | [hex.pm](https://hex.pm/packages/ory_client) | [README](https://github.com/ory/sdk/blob/master/clients/client/elixir/README.md) | | Go | [github.com](https://github.com/ory/client-go) | [README](https://github.com/ory/sdk/blob/master/clients/client/go/README.md) | | Java | [maven.org](https://search.maven.org/artifact/sh.ory/ory-client) | [README](https://github.com/ory/sdk/blob/master/clients/client/java/README.md) | | JavaScript | [npmjs.com](https://www.npmjs.com/package/@ory/client) | [README](https://github.com/ory/sdk/blob/master/clients/client/typescript/README.md) | | JavaScript (With fetch) | [npmjs.com](https://www.npmjs.com/package/@ory/client-fetch) | [README](https://github.com/ory/sdk/blob/master/clients/client/typescript-fetch/README.md) | | PHP | [packagist.org](https://packagist.org/packages/ory/client) | [README](https://github.com/ory/sdk/blob/master/clients/client/php/README.md) | | Python | [pypi.org](https://pypi.org/project/ory-client/) | [README](https://github.com/ory/sdk/blob/master/clients/client/python/README.md) | | Ruby | [rubygems.org](https://rubygems.org/gems/ory-client) | [README](https://github.com/ory/sdk/blob/master/clients/client/ruby/README.md) | | Rust | [crates.io](https://crates.io/crates/ory-client) | [README](https://github.com/ory/sdk/blob/master/clients/client/rust/README.md) |
*
* The version of the OpenAPI document: v1.20.10
* Contact: support@ory.sh
*
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
* https://openapi-generator.tech
* Do not edit the class manually.
*/
import type { 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;