@leancodepl/kratos
Version:
Headless React components library for building Ory Kratos authentication flows
106 lines (105 loc) • 7.25 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.
*/
/**
*
* @export
* @interface AcceptOAuth2LoginRequest
*/
export interface AcceptOAuth2LoginRequest {
/**
* ACR sets the Authentication AuthorizationContext Class Reference value for this authentication session. You can use it
* to express that, for example, a user authenticated using two factor authentication.
* @type {string}
* @memberof AcceptOAuth2LoginRequest
*/
acr?: string;
/**
*
* @type {Array<string>}
* @memberof AcceptOAuth2LoginRequest
*/
amr?: Array<string>;
/**
*
* @type {object}
* @memberof AcceptOAuth2LoginRequest
*/
context?: object;
/**
* Extend OAuth2 authentication session lifespan
*
* If set to `true`, the OAuth2 authentication cookie lifespan is extended. This is for example useful if you want the user to be able to use `prompt=none` continuously.
*
* This value can only be set to `true` if the user has an authentication, which is the case if the `skip` value is `true`.
* @type {boolean}
* @memberof AcceptOAuth2LoginRequest
*/
extend_session_lifespan?: boolean;
/**
* ForceSubjectIdentifier forces the "pairwise" user ID of the end-user that authenticated. The "pairwise" user ID refers to the
* (Pairwise Identifier Algorithm)[http://openid.net/specs/openid-connect-core-1_0.html#PairwiseAlg] of the OpenID
* Connect specification. It allows you to set an obfuscated subject ("user") identifier that is unique to the client.
*
* Please note that this changes the user ID on endpoint /userinfo and sub claim of the ID Token. It does not change the
* sub claim in the OAuth 2.0 Introspection.
*
* Per default, ORY Hydra handles this value with its own algorithm. In case you want to set this yourself
* you can use this field. Please note that setting this field has no effect if `pairwise` is not configured in
* ORY Hydra or the OAuth 2.0 Client does not expect a pairwise identifier (set via `subject_type` key in the client's
* configuration).
*
* Please also be aware that ORY Hydra is unable to properly compute this value during authentication. This implies
* that you have to compute this value on every authentication process (probably depending on the client ID or some
* other unique value).
*
* If you fail to compute the proper value, then authentication processes which have id_token_hint set might fail.
* @type {string}
* @memberof AcceptOAuth2LoginRequest
*/
force_subject_identifier?: string;
/**
* IdentityProviderSessionID is the session ID of the end-user that authenticated.
* If specified, we will use this value to propagate the logout.
* @type {string}
* @memberof AcceptOAuth2LoginRequest
*/
identity_provider_session_id?: string;
/**
* Remember, if set to true, tells ORY Hydra to remember this user by telling the user agent (browser) to store
* a cookie with authentication data. If the same user performs another OAuth 2.0 Authorization Request, he/she
* will not be asked to log in again.
* @type {boolean}
* @memberof AcceptOAuth2LoginRequest
*/
remember?: boolean;
/**
* RememberFor sets how long the authentication should be remembered for in seconds. If set to `0`, the
* authorization will be remembered for the duration of the browser session (using a session cookie).
* @type {number}
* @memberof AcceptOAuth2LoginRequest
*/
remember_for?: number;
/**
* Subject is the user ID of the end-user that authenticated.
* @type {string}
* @memberof AcceptOAuth2LoginRequest
*/
subject: string;
}
/**
* Check if a given object implements the AcceptOAuth2LoginRequest interface.
*/
export declare function instanceOfAcceptOAuth2LoginRequest(value: object): value is AcceptOAuth2LoginRequest;
export declare function AcceptOAuth2LoginRequestFromJSON(json: any): AcceptOAuth2LoginRequest;
export declare function AcceptOAuth2LoginRequestFromJSONTyped(json: any, ignoreDiscriminator: boolean): AcceptOAuth2LoginRequest;
export declare function AcceptOAuth2LoginRequestToJSON(json: any): AcceptOAuth2LoginRequest;
export declare function AcceptOAuth2LoginRequestToJSONTyped(value?: AcceptOAuth2LoginRequest | null, ignoreDiscriminator?: boolean): any;