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

Headless React components library for building Ory Kratos authentication flows

import { OAuth2ConsentRequestOpenIDConnectContext } from './OAuth2ConsentRequestOpenIDConnectContext';
import { OAuth2Client } from './OAuth2Client';
/**
 *
 * @export
 * @interface OAuth2LoginRequest
 */
export interface OAuth2LoginRequest {
    /**
     * ID is the identifier of the login request.
     * @type {string}
     * @memberof OAuth2LoginRequest
     */
    challenge: string;
    /**
     *
     * @type {OAuth2Client}
     * @memberof OAuth2LoginRequest
     */
    client: OAuth2Client;
    /**
     *
     * @type {OAuth2ConsentRequestOpenIDConnectContext}
     * @memberof OAuth2LoginRequest
     */
    oidc_context?: OAuth2ConsentRequestOpenIDConnectContext;
    /**
     * RequestURL is the original OAuth 2.0 Authorization URL requested by the OAuth 2.0 client. It is the URL which
     * initiates the OAuth 2.0 Authorization Code or OAuth 2.0 Implicit flow. This URL is typically not needed, but
     * might come in handy if you want to deal with additional request parameters.
     * @type {string}
     * @memberof OAuth2LoginRequest
     */
    request_url: string;
    /**
     *
     * @type {Array<string>}
     * @memberof OAuth2LoginRequest
     */
    requested_access_token_audience?: Array<string>;
    /**
     *
     * @type {Array<string>}
     * @memberof OAuth2LoginRequest
     */
    requested_scope?: Array<string>;
    /**
     * SessionID is the login session ID. If the user-agent reuses a login session (via cookie / remember flag)
     * this ID will remain the same. If the user-agent did not have an existing authentication session (e.g. remember is false)
     * this will be a new random value. This value is used as the "sid" parameter in the ID Token and in OIDC Front-/Back-
     * channel logout. It's value can generally be used to associate consecutive login requests by a certain user.
     * @type {string}
     * @memberof OAuth2LoginRequest
     */
    session_id?: string;
    /**
     * Skip, if true, implies that the client has requested the same scopes from the same user previously.
     * If true, you can skip asking the user to grant the requested scopes, and simply forward the user to the redirect URL.
     *
     * This feature allows you to update / set session information.
     * @type {boolean}
     * @memberof OAuth2LoginRequest
     */
    skip: boolean;
    /**
     * Subject is the user ID of the end-user that authenticated. Now, that end user needs to grant or deny the scope
     * requested by the OAuth 2.0 client. If this value is set and `skip` is true, you MUST include this subject type
     * when accepting the login request, or the request will fail.
     * @type {string}
     * @memberof OAuth2LoginRequest
     */
    subject: string;
}
/**
 * Check if a given object implements the OAuth2LoginRequest interface.
 */
export declare function instanceOfOAuth2LoginRequest(value: object): value is OAuth2LoginRequest;
export declare function OAuth2LoginRequestFromJSON(json: any): OAuth2LoginRequest;
export declare function OAuth2LoginRequestFromJSONTyped(json: any, ignoreDiscriminator: boolean): OAuth2LoginRequest;
export declare function OAuth2LoginRequestToJSON(json: any): OAuth2LoginRequest;
export declare function OAuth2LoginRequestToJSONTyped(value?: OAuth2LoginRequest | null, ignoreDiscriminator?: boolean): any;
//# sourceMappingURL=OAuth2LoginRequest.d.ts.map