Package org.keycloak.services.resources

Class IdentityBrokerService

java.lang.Object

org.keycloak.services.resources.IdentityBrokerService

All Implemented Interfaces:

IdentityProvider.AuthenticationCallback

public class IdentityBrokerService
extends Object
implements IdentityProvider.AuthenticationCallback

Author:

Pedro Igor

Constructor Summary

Constructors

Constructor	Description
IdentityBrokerService(KeycloakSession session)

Method Summary

Modifier and Type	Method	Description
jakarta.ws.rs.core.Response	afterFirstBrokerLogin(String code, String clientId, String tabId)
jakarta.ws.rs.core.Response	afterPostBrokerLoginFlow(String code, String clientId, String tabId)
jakarta.ws.rs.core.Response	authenticated(BrokeredIdentityContext context)	This method should be called by provider after the JAXRS callback endpoint has finished authentication with the remote IDP.
protected jakarta.ws.rs.core.Response	browserAuthentication(AuthenticationSessionModel authSession, String errorMessage, Object... parameters)
jakarta.ws.rs.core.Response	cancelled(IdentityProviderModel idpConfig)	Called when user cancelled authentication on the IDP side - for example user didn't approve consent page on the IDP side.
jakarta.ws.rs.core.Response	clientInitiatedAccountLinking(String providerId, String redirectUri, String clientId, String nonce, String hash)
jakarta.ws.rs.core.Response	clientIntiatedAccountLinkingPreflight(String providerId)	Closes off CORS preflight requests for account linking
jakarta.ws.rs.core.Response	error(String message)	Called when error happened on the IDP side.
AuthenticationSessionModel	getAndVerifyAuthenticationSession(String encodedCode)	Common method to return current authenticationSession and verify if it is not expired
Object	getEndpoint(String providerId)
static IdentityProvider	getIdentityProvider(KeycloakSession session, RealmModel realm, String alias)
static IdentityProviderFactory	getIdentityProviderFactory(KeycloakSession session, IdentityProviderModel model)
void	init()
jakarta.ws.rs.core.Response	performLogin(String providerId, String code, String clientId, String tabId, String loginHint)
jakarta.ws.rs.core.Response	performPostLogin(String providerId, String code, String clientId, String tabId, String loginHint)
jakarta.ws.rs.core.Response	retrieveToken(String providerId)
jakarta.ws.rs.core.Response	retrieveTokenPreflight()
jakarta.ws.rs.core.Response	validateUser(AuthenticationSessionModel authSession, UserModel user, RealmModel realm)

Methods inherited from class java.lang.Object

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

Constructor Details

IdentityBrokerService

public IdentityBrokerService(KeycloakSession session)

Method Details

init

public void init()

clientIntiatedAccountLinkingPreflight

@OPTIONS
@Path("/{provider_id}/link")
public jakarta.ws.rs.core.Response clientIntiatedAccountLinkingPreflight(@PathParam("provider_id")
 String providerId)

Closes off CORS preflight requests for account linking

Parameters:

providerId -

Returns:

clientInitiatedAccountLinking

@GET
@Path("/{provider_id}/link")
public jakarta.ws.rs.core.Response clientInitiatedAccountLinking(@PathParam("provider_id")
 String providerId,
 @QueryParam("redirect_uri")
 String redirectUri,
 @QueryParam("client_id")
 String clientId,
 @QueryParam("nonce")
 String nonce,
 @QueryParam("hash")
 String hash)

performPostLogin

@POST
@Path("/{provider_id}/login")
public jakarta.ws.rs.core.Response performPostLogin(@PathParam("provider_id")
 String providerId,
 @QueryParam("session_code")
 String code,
 @QueryParam("client_id")
 String clientId,
 @QueryParam("tab_id")
 String tabId,
 @QueryParam("login_hint")
 String loginHint)

performLogin

@GET
@Path("/{provider_id}/login")
public jakarta.ws.rs.core.Response performLogin(@PathParam("provider_id")
 String providerId,
 @QueryParam("session_code")
 String code,
 @QueryParam("client_id")
 String clientId,
 @QueryParam("tab_id")
 String tabId,
 @QueryParam("login_hint")
 String loginHint)

getEndpoint

@Path("{provider_id}/endpoint")
public Object getEndpoint(@PathParam("provider_id")
 String providerId)

retrieveTokenPreflight

@Path("{provider_id}/token")
@OPTIONS
public jakarta.ws.rs.core.Response retrieveTokenPreflight()

retrieveToken

@GET
@Path("{provider_id}/token")
public jakarta.ws.rs.core.Response retrieveToken(@PathParam("provider_id")
 String providerId)

authenticated

public jakarta.ws.rs.core.Response authenticated(BrokeredIdentityContext context)

Description copied from interface: IdentityProvider.AuthenticationCallback

This method should be called by provider after the JAXRS callback endpoint has finished authentication with the remote IDP. There is an assumption that authenticationSession is set in the context when this method is called

Specified by:

authenticated in interface IdentityProvider.AuthenticationCallback

Returns:

see description

validateUser

public jakarta.ws.rs.core.Response validateUser(AuthenticationSessionModel authSession,
 UserModel user,
 RealmModel realm)

afterFirstBrokerLogin

@GET
@Path("/after-first-broker-login")
public jakarta.ws.rs.core.Response afterFirstBrokerLogin(@QueryParam("session_code")
 String code,
 @QueryParam("client_id")
 String clientId,
 @QueryParam("tab_id")
 String tabId)

afterPostBrokerLoginFlow

@GET
@Path("/after-post-broker-login")
public jakarta.ws.rs.core.Response afterPostBrokerLoginFlow(@QueryParam("session_code")
 String code,
 @QueryParam("client_id")
 String clientId,
 @QueryParam("tab_id")
 String tabId)

cancelled

public jakarta.ws.rs.core.Response cancelled(IdentityProviderModel idpConfig)

Description copied from interface: IdentityProvider.AuthenticationCallback

Called when user cancelled authentication on the IDP side - for example user didn't approve consent page on the IDP side. Assumption is that authenticationSession is set in the KeycloakContext when this method is called

Specified by:

cancelled in interface IdentityProvider.AuthenticationCallback

Parameters:

idpConfig - identity provider config

Returns:

see description

error

public jakarta.ws.rs.core.Response error(String message)

Description copied from interface: IdentityProvider.AuthenticationCallback

Called when error happened on the IDP side. Assumption is that authenticationSession is set in the KeycloakContext when this method is called

Specified by:

error in interface IdentityProvider.AuthenticationCallback

Returns:

see description

getAndVerifyAuthenticationSession

public AuthenticationSessionModel getAndVerifyAuthenticationSession(String encodedCode)

Description copied from interface: IdentityProvider.AuthenticationCallback

Common method to return current authenticationSession and verify if it is not expired

Specified by:

getAndVerifyAuthenticationSession in interface IdentityProvider.AuthenticationCallback

Returns:

see description

browserAuthentication

protected jakarta.ws.rs.core.Response browserAuthentication(AuthenticationSessionModel authSession,
 String errorMessage,
 Object... parameters)

getIdentityProvider

public static IdentityProvider getIdentityProvider(KeycloakSession session,
 RealmModel realm,
 String alias)

getIdentityProviderFactory

public static IdentityProviderFactory getIdentityProviderFactory(KeycloakSession session,
 IdentityProviderModel model)