Interface IdentityProvider<C extends IdentityProviderModel>

    • Method Detail

      • performLogin

        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.

        Parameters:
        request - The initial authentication request. Contains all the contextual information in order to build an authentication request to the identity provider.
        Returns:
      • retrieveToken

        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.

        Parameters:
        identity -
        Returns:
      • keycloakInitiatedBrowserLogout

        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. This is expected to do a logout with the IDP
        Parameters:
        userSession -
        uriInfo -
        realm -
        Returns:
        null if this is not supported by this provider
      • export

        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. For example, a SAML EntityDescriptor
        Returns:
      • getMarshaller

        IdentityProviderDataMarshaller getMarshaller()
        Implementation of marshaller to serialize/deserialize attached data to Strings, which can be saved in clientSession
        Returns: