Interface IdentityProviderMapper

    • Method Detail

      • getCompatibleProviders

        String[] getCompatibleProviders()
      • getDisplayCategory

        String getDisplayCategory()
      • getDisplayType

        String getDisplayType()
      • preprocessFederatedIdentity

        void preprocessFederatedIdentity​(KeycloakSession session,
                                         RealmModel realm,
                                         IdentityProviderMapperModel mapperModel,
                                         BrokeredIdentityContext context)
        Called to determine what keycloak username and email to use to process the login request from the external IDP. It's called before "FirstBrokerLogin" flow, so can be used to map attributes to BrokeredIdentityContext ( BrokeredIdentityContext.setUserAttribute ), which will be available on "Review Profile" page and in authenticators during FirstBrokerLogin flow
        Parameters:
        session -
        realm -
        mapperModel -
        context -
      • updateBrokeredUserLegacy

        void updateBrokeredUserLegacy​(KeycloakSession session,
                                      RealmModel realm,
                                      UserModel user,
                                      IdentityProviderMapperModel mapperModel,
                                      BrokeredIdentityContext context)
        Called when this user has logged in before and has already been imported. Legacy behaviour. When updating the mapper to correctly update brokered users in all sync modes, move the old behavior into this method.
        Parameters:
        session -
        realm -
        user -
        mapperModel -
        context -