org.keycloak.broker.social.SocialIdentityProvider< C extends IdentityProviderModel > インタフェーステンプレート

org.keycloak.broker.social.SocialIdentityProvider< C extends IdentityProviderModel > の継承関係図

org.keycloak.broker.social.SocialIdentityProvider< C extends IdentityProviderModel > 連携図

公開メンバ関数
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, AuthenticationCallback callback, EventBuilder event)
Response	performLogin (AuthenticationRequest request)
Response	retrieveToken (KeycloakSession session, FederatedIdentityModel identity)
void	backchannelLogout (KeycloakSession session, UserSessionModel userSession, UriInfo uriInfo, RealmModel realm)
Response	keycloakInitiatedBrowserLogout (KeycloakSession session, UserSessionModel userSession, UriInfo uriInfo, RealmModel realm)
Response	export (UriInfo uriInfo, RealmModel realm, String format)
IdentityProviderDataMarshaller	getMarshaller ()

公開変数類
String	EXTERNAL_IDENTITY_PROVIDER = "EXTERNAL_IDENTITY_PROVIDER"
String	FEDERATED_ACCESS_TOKEN = "FEDERATED_ACCESS_TOKEN"

詳解

著者

Pedro Igor

関数詳解

authenticationFinished()

void org.keycloak.broker.provider.IdentityProvider< C extends IdentityProviderModel >.authenticationFinished ( AuthenticationSessionModel  authSession, BrokeredIdentityContext  context  )

inherited

backchannelLogout()

void org.keycloak.broker.provider.IdentityProvider< C extends IdentityProviderModel >.backchannelLogout ( KeycloakSession  session, UserSessionModel  userSession, UriInfo  uriInfo, RealmModel  realm  )

inherited

callback()

Object org.keycloak.broker.provider.IdentityProvider< C extends IdentityProviderModel >.callback ( RealmModel  realm, AuthenticationCallback  callback, EventBuilder  event  )

inherited

JAXRS callback endpoint for when the remote IDP wants to callback to keycloak.

戻り値

export()

Response org.keycloak.broker.provider.IdentityProvider< C extends IdentityProviderModel >.export ( UriInfo  uriInfo, RealmModel  realm, String  format  )

inherited

Export a representation of the IdentityProvider in a specific format. For example, a SAML EntityDescriptor

戻り値

getMarshaller()

IdentityProviderDataMarshaller org.keycloak.broker.provider.IdentityProvider< C extends IdentityProviderModel >.getMarshaller ( )

inherited

Implementation of marshaller to serialize/deserialize attached data to Strings, which can be saved in clientSession

戻り値

importNewUser()

void org.keycloak.broker.provider.IdentityProvider< C extends IdentityProviderModel >.importNewUser ( KeycloakSession  session, RealmModel  realm, UserModel  user, BrokeredIdentityContext  context  )

inherited

keycloakInitiatedBrowserLogout()

Response org.keycloak.broker.provider.IdentityProvider< C extends IdentityProviderModel >.keycloakInitiatedBrowserLogout ( KeycloakSession  session, UserSessionModel  userSession, UriInfo  uriInfo, RealmModel  realm  )

inherited

Called when a Keycloak application initiates a logout through the browser. This is expected to do a logout with the IDP

引数

userSession
uriInfo
realm

戻り値

null if this is not supported by this provider

performLogin()

Response org.keycloak.broker.provider.IdentityProvider< C extends IdentityProviderModel >.performLogin ( AuthenticationRequest  request )

inherited

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.

戻り値

preprocessFederatedIdentity()

void org.keycloak.broker.provider.IdentityProvider< C extends IdentityProviderModel >.preprocessFederatedIdentity ( KeycloakSession  session, RealmModel  realm, BrokeredIdentityContext  context  )

inherited

retrieveToken()

Response org.keycloak.broker.provider.IdentityProvider< C extends IdentityProviderModel >.retrieveToken ( KeycloakSession  session, FederatedIdentityModel  identity  )

inherited

Returns a javax.ws.rs.core.Response containing the token previously stored during the authentication process for a specific user.

引数

identity

戻り値

updateBrokeredUser()

void org.keycloak.broker.provider.IdentityProvider< C extends IdentityProviderModel >.updateBrokeredUser ( KeycloakSession  session, RealmModel  realm, UserModel  user, BrokeredIdentityContext  context  )

inherited

メンバ詳解

EXTERNAL_IDENTITY_PROVIDER

String org.keycloak.broker.provider.IdentityProvider< C extends IdentityProviderModel >.EXTERNAL_IDENTITY_PROVIDER = "EXTERNAL_IDENTITY_PROVIDER"

inherited

FEDERATED_ACCESS_TOKEN

String org.keycloak.broker.provider.IdentityProvider< C extends IdentityProviderModel >.FEDERATED_ACCESS_TOKEN = "FEDERATED_ACCESS_TOKEN"

inherited

---

このインタフェース詳解は次のファイルから抽出されました:

• D:/AppData/doxygen/keycloak/spi-private/src/server-spi-private/src/main/java/org/keycloak/broker/social/SocialIdentityProvider.java