Package org.keycloak.migration

Interface MigrationProvider

All Superinterfaces:
org.keycloak.provider.Provider
public interface MigrationProvider extends org.keycloak.provider.Provider
Various common utils needed for migration from older version to newer
Author:
Marek Posolda

  • Method Summary

    Modifier and Type
    Method
    Description
    org.keycloak.models.ClientScopeModel
    addOIDCAcrClientScope(org.keycloak.models.RealmModel realm)
    Add 'acr' client scope or return it if already exists
    org.keycloak.models.ClientScopeModel
    addOIDCBasicClientScope(org.keycloak.models.RealmModel realm)
    Add 'basic' client scope or return it if already exists
    org.keycloak.models.ClientScopeModel
    addOIDCMicroprofileJWTClientScope(org.keycloak.models.RealmModel realm)
    Adds the microprofile-jwt optional client scope to the realm and returns the created scope.
    org.keycloak.models.ClientScopeModel
    addOIDCRolesClientScope(org.keycloak.models.RealmModel realm)
    Add 'roles' client scope or return it if already exists
    org.keycloak.models.ClientScopeModel
    addOIDCServiceAccountClientScope(org.keycloak.models.RealmModel realm)
    Add 'service_account' client scope or return it if already exists
    org.keycloak.models.ClientScopeModel
    addOIDCWebOriginsClientScope(org.keycloak.models.RealmModel realm)
    Add 'web-origins' client scope or return it if already exists
    org.keycloak.models.ClientScopeModel
    addSamlAuthnContextClassRefClientScope(org.keycloak.models.RealmModel realm)
    Add the SAML mapper for the step-up AuthnContextClassRef authentication to the realm.
    Map<String,org.keycloak.models.ProtocolMapperModel>
    getBuiltinMappers(String protocol)
     
    List<org.keycloak.representations.idm.ProtocolMapperRepresentation>
    getMappersForClaimMask(Long claimMask)
     
    void
    setupAdminCli(org.keycloak.models.RealmModel realm)
     

    Methods inherited from interface org.keycloak.provider.Provider

    close

  • Method Details

    • getMappersForClaimMask

      List<org.keycloak.representations.idm.ProtocolMapperRepresentation> getMappersForClaimMask(Long claimMask)
      Parameters:
      claimMask - mask used on ClientModel in 1.1.0
      Returns:
      set of 1.2.0.Beta1 protocol mappers corresponding to given claimMask

    • getBuiltinMappers

      Map<String,org.keycloak.models.ProtocolMapperModel> getBuiltinMappers(String protocol)

    • setupAdminCli

      void setupAdminCli(org.keycloak.models.RealmModel realm)

    • addOIDCRolesClientScope

      org.keycloak.models.ClientScopeModel addOIDCRolesClientScope(org.keycloak.models.RealmModel realm)
      Add 'roles' client scope or return it if already exists
      Parameters:
      realm -
      Returns:
      created or already existing client scope 'roles'

    • addOIDCWebOriginsClientScope

      org.keycloak.models.ClientScopeModel addOIDCWebOriginsClientScope(org.keycloak.models.RealmModel realm)
      Add 'web-origins' client scope or return it if already exists
      Parameters:
      realm -
      Returns:
      created or already existing client scope 'web-origins'

    • addOIDCMicroprofileJWTClientScope

      org.keycloak.models.ClientScopeModel addOIDCMicroprofileJWTClientScope(org.keycloak.models.RealmModel realm)
      Adds the microprofile-jwt optional client scope to the realm and returns the created scope. If the scope already exists in the realm then the existing scope is returned.
      Parameters:
      realm - the realm to which the scope is to be added.
      Returns:
      a reference to the microprofile-jwt client scope that was either created or already exists in the realm.

    • addOIDCAcrClientScope

      org.keycloak.models.ClientScopeModel addOIDCAcrClientScope(org.keycloak.models.RealmModel realm)
      Add 'acr' client scope or return it if already exists
      Parameters:
      realm -
      Returns:
      created or already existing client scope 'acr'

    • addOIDCBasicClientScope

      org.keycloak.models.ClientScopeModel addOIDCBasicClientScope(org.keycloak.models.RealmModel realm)
      Add 'basic' client scope or return it if already exists
      Parameters:
      realm -
      Returns:
      created or already existing client scope 'basic'

    • addOIDCServiceAccountClientScope

      org.keycloak.models.ClientScopeModel addOIDCServiceAccountClientScope(org.keycloak.models.RealmModel realm)
      Add 'service_account' client scope or return it if already exists
      Parameters:
      realm -
      Returns:
      created or already existing client scope 'service_account'

    • addSamlAuthnContextClassRefClientScope

      org.keycloak.models.ClientScopeModel addSamlAuthnContextClassRefClientScope(org.keycloak.models.RealmModel realm)
      Add the SAML mapper for the step-up AuthnContextClassRef authentication to the realm.
      Parameters:
      realm -
      Returns:
      created, already existing client scope or null if not step-up not enabled