Function completeAuthorizationCodeGrant

Attempt to exchange authorization code for bearer token.

Takes the authorization code returned by the OpenID Provider via the authorization URL, and makes a request to the Token Endpoint, to obtain the access token, refresh token, etc.

Param: code

authorization code as returned by OP during authorization

Param: state

authorization state param as returned by OP during authorization

Param: responseMode

the response mode used for authentication

Returns

valid bearer token response

Throws

An Error with message set to an entry in OidcError, when the request fails, or the returned token response is invalid.

completeAuthorizationCodeGrant(
    code: string,
    state: string,
    responseMode?: "query" | "fragment" | undefined,
): Promise<
    {
        homeserverUrl: string;
        identityServerUrl?: string;
        idTokenClaims: IdTokenClaims;
        oidcClientSettings: { clientId: string; issuer: string };
        tokenResponse: BearerTokenResponse;
    },
>
Experimental
Parameters
- code: string
- state: string
- responseMode: "query" | "fragment" | undefined = "query"
Returns Promise<
    {
        homeserverUrl: string;
        identityServerUrl?: string;
        idTokenClaims: IdTokenClaims;
        oidcClientSettings: { clientId: string; issuer: string };
        tokenResponse: BearerTokenResponse;
    },
>
- Defined in src/oidc/authorize.ts:221

Function completeAuthorizationCodeGrant

Param: code

Param: state

Param: responseMode

Returns

Throws

Parameters

Returns Promise< { homeserverUrl: string; identityServerUrl?: string; idTokenClaims: IdTokenClaims; oidcClientSettings: { clientId: string; issuer: string }; tokenResponse: BearerTokenResponse; },>

Settings

Returns Promise<
{
homeserverUrl: string;
identityServerUrl?: string;
idTokenClaims: IdTokenClaims;
oidcClientSettings: { clientId: string; issuer: string };
tokenResponse: BearerTokenResponse;
},
>