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

Headless React components library for building Ory Kratos authentication flows

import { OAuth2ConsentRequestOpenIDConnectContext } from './OAuth2ConsentRequestOpenIDConnectContext';
import { OAuth2Client } from './OAuth2Client';
/**
 *
 * @export
 * @interface OAuth2ConsentRequest
 */
export interface OAuth2ConsentRequest {
    /**
     * ACR represents 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 OAuth2ConsentRequest
     */
    acr?: string;
    /**
     *
     * @type {Array<string>}
     * @memberof OAuth2ConsentRequest
     */
    amr?: Array<string>;
    /**
     * Challenge is used to retrieve/accept/deny the consent request.
     * @type {string}
     * @memberof OAuth2ConsentRequest
     */
    challenge: string;
    /**
     *
     * @type {OAuth2Client}
     * @memberof OAuth2ConsentRequest
     */
    client?: OAuth2Client;
    /**
     * ConsentRequestID is the ID of the consent request.
     * @type {string}
     * @memberof OAuth2ConsentRequest
     */
    consent_request_id?: string;
    /**
     *
     * @type {object}
     * @memberof OAuth2ConsentRequest
     */
    context?: object;
    /**
     * LoginChallenge is the login challenge this consent challenge belongs to. It can be used to associate
     * a login and consent request in the login & consent app.
     * @type {string}
     * @memberof OAuth2ConsentRequest
     */
    login_challenge?: string;
    /**
     * LoginSessionID 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 OAuth2ConsentRequest
     */
    login_session_id?: string;
    /**
     *
     * @type {OAuth2ConsentRequestOpenIDConnectContext}
     * @memberof OAuth2ConsentRequest
     */
    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 OAuth2ConsentRequest
     */
    request_url?: string;
    /**
     *
     * @type {Array<string>}
     * @memberof OAuth2ConsentRequest
     */
    requested_access_token_audience?: Array<string>;
    /**
     *
     * @type {Array<string>}
     * @memberof OAuth2ConsentRequest
     */
    requested_scope?: Array<string>;
    /**
     * Skip, if true, implies that the client has requested the same scopes from the same user previously.
     * If true, you must not ask the user to grant the requested scopes. You must however either allow or deny the
     * consent request using the usual API call.
     * @type {boolean}
     * @memberof OAuth2ConsentRequest
     */
    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.
     * @type {string}
     * @memberof OAuth2ConsentRequest
     */
    subject?: string;
}
/**
 * Check if a given object implements the OAuth2ConsentRequest interface.
 */
export declare function instanceOfOAuth2ConsentRequest(value: object): value is OAuth2ConsentRequest;
export declare function OAuth2ConsentRequestFromJSON(json: any): OAuth2ConsentRequest;
export declare function OAuth2ConsentRequestFromJSONTyped(json: any, ignoreDiscriminator: boolean): OAuth2ConsentRequest;
export declare function OAuth2ConsentRequestToJSON(json: any): OAuth2ConsentRequest;
export declare function OAuth2ConsentRequestToJSONTyped(value?: OAuth2ConsentRequest | null, ignoreDiscriminator?: boolean): any;
//# sourceMappingURL=OAuth2ConsentRequest.d.ts.map