public interface IdentityProvider<C extends IdentityProviderModel> extends Provider
Modifier and Type | Interface and Description |
---|---|
static interface |
IdentityProvider.AuthenticationCallback |
Modifier and Type | Field and Description |
---|---|
static String |
EXTERNAL_IDENTITY_PROVIDER |
static String |
FEDERATED_ACCESS_TOKEN |
Modifier and Type | Method and Description |
---|---|
void |
authenticationFinished(AuthenticationSessionModel authSession,
BrokeredIdentityContext context) |
void |
backchannelLogout(KeycloakSession session,
UserSessionModel userSession,
javax.ws.rs.core.UriInfo uriInfo,
RealmModel realm) |
Object |
callback(RealmModel realm,
IdentityProvider.AuthenticationCallback callback,
EventBuilder event)
JAXRS callback endpoint for when the remote IDP wants to callback to keycloak.
|
javax.ws.rs.core.Response |
export(javax.ws.rs.core.UriInfo uriInfo,
RealmModel realm,
String format)
Export a representation of the IdentityProvider in a specific format.
|
IdentityProviderDataMarshaller |
getMarshaller()
Implementation of marshaller to serialize/deserialize attached data to Strings, which can be saved in clientSession
|
void |
importNewUser(KeycloakSession session,
RealmModel realm,
UserModel user,
BrokeredIdentityContext context) |
javax.ws.rs.core.Response |
keycloakInitiatedBrowserLogout(KeycloakSession session,
UserSessionModel userSession,
javax.ws.rs.core.UriInfo uriInfo,
RealmModel realm)
Called when a Keycloak application initiates a logout through the browser.
|
javax.ws.rs.core.Response |
performLogin(AuthenticationRequest request)
Initiates the authentication process by sending an authentication request to an identity provider.
|
void |
preprocessFederatedIdentity(KeycloakSession session,
RealmModel realm,
BrokeredIdentityContext context) |
javax.ws.rs.core.Response |
retrieveToken(KeycloakSession session,
FederatedIdentityModel identity)
Returns a
Response containing the token previously stored during the authentication process for a
specific user. |
void |
updateBrokeredUser(KeycloakSession session,
RealmModel realm,
UserModel user,
BrokeredIdentityContext context) |
static final String EXTERNAL_IDENTITY_PROVIDER
static final String FEDERATED_ACCESS_TOKEN
void preprocessFederatedIdentity(KeycloakSession session, RealmModel realm, BrokeredIdentityContext context)
void authenticationFinished(AuthenticationSessionModel authSession, BrokeredIdentityContext context)
void importNewUser(KeycloakSession session, RealmModel realm, UserModel user, BrokeredIdentityContext context)
void updateBrokeredUser(KeycloakSession session, RealmModel realm, UserModel user, BrokeredIdentityContext context)
Object callback(RealmModel realm, IdentityProvider.AuthenticationCallback callback, EventBuilder event)
javax.ws.rs.core.Response performLogin(AuthenticationRequest request)
Initiates the authentication process by sending an authentication request to an identity provider. This method is called only once during the authentication.
request
- The initial authentication request. Contains all the contextual information in order to build an authentication request to the
identity provider.javax.ws.rs.core.Response retrieveToken(KeycloakSession session, FederatedIdentityModel identity)
Returns a Response
containing the token previously stored during the authentication process for a
specific user.
identity
- void backchannelLogout(KeycloakSession session, UserSessionModel userSession, javax.ws.rs.core.UriInfo uriInfo, RealmModel realm)
javax.ws.rs.core.Response keycloakInitiatedBrowserLogout(KeycloakSession session, UserSessionModel userSession, javax.ws.rs.core.UriInfo uriInfo, RealmModel realm)
userSession
- uriInfo
- realm
- javax.ws.rs.core.Response export(javax.ws.rs.core.UriInfo uriInfo, RealmModel realm, String format)
IdentityProviderDataMarshaller getMarshaller()
Copyright © 2021 JBoss by Red Hat. All rights reserved.