@leancodepl/kratos
Version:
Headless React components library for building Ory Kratos authentication flows
100 lines (99 loc) • 5.59 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 { SessionDevice } from './SessionDevice';
import type { SessionAuthenticationMethod } from './SessionAuthenticationMethod';
import type { AuthenticatorAssuranceLevel } from './AuthenticatorAssuranceLevel';
import type { Identity } from './Identity';
/**
* A Session
* @export
* @interface Session
*/
export interface Session {
/**
* Active state. If false the session is no longer active.
* @type {boolean}
* @memberof Session
*/
active?: boolean;
/**
* The Session Authentication Timestamp
*
* When this session was authenticated at. If multi-factor authentication was used this
* is the time when the last factor was authenticated (e.g. the TOTP code challenge was completed).
* @type {Date}
* @memberof Session
*/
authenticated_at?: Date;
/**
* A list of authenticators which were used to authenticate the session.
* @type {Array<SessionAuthenticationMethod>}
* @memberof Session
*/
authentication_methods?: Array<SessionAuthenticationMethod>;
/**
*
* @type {AuthenticatorAssuranceLevel}
* @memberof Session
*/
authenticator_assurance_level?: AuthenticatorAssuranceLevel;
/**
* Devices has history of all endpoints where the session was used
* @type {Array<SessionDevice>}
* @memberof Session
*/
devices?: Array<SessionDevice>;
/**
* The Session Expiry
*
* When this session expires at.
* @type {Date}
* @memberof Session
*/
expires_at?: Date;
/**
* Session ID
* @type {string}
* @memberof Session
*/
id: string;
/**
*
* @type {Identity}
* @memberof Session
*/
identity?: Identity;
/**
* The Session Issuance Timestamp
*
* When this session was issued at. Usually equal or close to `authenticated_at`.
* @type {Date}
* @memberof Session
*/
issued_at?: Date;
/**
* Tokenized is the tokenized (e.g. JWT) version of the session.
*
* It is only set when the `tokenize` query parameter was set to a valid tokenize template during calls to `/session/whoami`.
* @type {string}
* @memberof Session
*/
tokenized?: string;
}
/**
* Check if a given object implements the Session interface.
*/
export declare function instanceOfSession(value: object): value is Session;
export declare function SessionFromJSON(json: any): Session;
export declare function SessionFromJSONTyped(json: any, ignoreDiscriminator: boolean): Session;
export declare function SessionToJSON(json: any): Session;
export declare function SessionToJSONTyped(value?: Session | null, ignoreDiscriminator?: boolean): any;