Package org.keycloak.protocol.oidc.grants

Class PreAuthorizedCodeGrantType

java.lang.Object

org.keycloak.protocol.oidc.grants.OAuth2GrantTypeBase

org.keycloak.protocol.oidc.grants.PreAuthorizedCodeGrantType

All Implemented Interfaces:

OAuth2GrantType, Provider

public class PreAuthorizedCodeGrantType
extends OAuth2GrantTypeBase

Nested Class Summary

Nested classes/interfaces inherited from interface org.keycloak.protocol.oidc.grants.OAuth2GrantType

OAuth2GrantType.Context

Field Summary

Fields

Modifier and Type	Field	Description
static final String	VC_ISSUANCE_FLOW

Fields inherited from class org.keycloak.protocol.oidc.grants.OAuth2GrantTypeBase

client, clientAuthAttributes, clientConfig, clientConnection, context, cors, event, formParams, headers, realm, request, response, session, tokenManager

Constructor Summary

Constructors

Constructor	Description
PreAuthorizedCodeGrantType()

Method Summary

Modifier and Type	Method	Description
EventType	getEventType()	Returns the event type associated with this OAuth 2.0 grant type.
Set<String>	getTokenParameterNames()	Name of the "token" parameters, which this grant type supports.
boolean	isTokenAllowed(KeycloakSession session, AccessToken token)	Restrict pre-authorized tokens to the VC credential endpoint.
jakarta.ws.rs.core.Response	process(OAuth2GrantType.Context context)	Processes grant request.

Methods inherited from class org.keycloak.protocol.oidc.grants.OAuth2GrantTypeBase

addCustomTokenResponseClaims, afterAuthorizationDetailsProcessed, checkAndBindMtlsHoKToken, checkClient, close, createTokenResponse, createTokenResponse, createTokenResponseBuilder, getRequestedScopes, handleMissingAuthorizationDetails, processAuthorizationDetails, processStoredAuthorizationDetails, setContext, updateClientSession, updateUserSessionFromClientAuth, useRefreshToken

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.keycloak.protocol.oidc.grants.OAuth2GrantType

getSupportedMultivaluedRequestParameters, preProcess

Field Details

VC_ISSUANCE_FLOW

public static final String VC_ISSUANCE_FLOW

See Also:

• Constant Field Values

Constructor Details

PreAuthorizedCodeGrantType

public PreAuthorizedCodeGrantType()

Method Details

process

public jakarta.ws.rs.core.Response process(OAuth2GrantType.Context context)

Description copied from interface: OAuth2GrantType

Processes grant request.

Parameters:

context - grant request context

Returns:

token response

getEventType

public EventType getEventType()

Description copied from interface: OAuth2GrantType

Returns the event type associated with this OAuth 2.0 grant type.

Returns:

event type

getTokenParameterNames

public Set<String> getTokenParameterNames()

Description copied from interface: OAuth2GrantType

Name of the "token" parameters, which this grant type supports. As 'token' parameter is considered a parameter containing possibly long token (for example big JWT or SAML assertion) with unbounded data (For example possibly big amount of roles inside JWT). Example of such parameter is for example 'subject_token' parameter case of token exchange grant.

Returns:

set of strings with the "token" parameters supported by this grant type

isTokenAllowed

public boolean isTokenAllowed(KeycloakSession session,
 AccessToken token)

Restrict pre-authorized tokens to the VC credential endpoint.

Parameters:

session - the Keycloak session

token - the access token

Returns:

true if the token is allowed for the current request, false otherwise