Package org.keycloak.protocol.oidc.mappers

Class HardcodedRole

java.lang.Object
org.keycloak.protocol.oidc.mappers.AbstractOIDCProtocolMapper
org.keycloak.protocol.oidc.mappers.HardcodedRole
All Implemented Interfaces:
OIDCAccessTokenMapper, TokenIntrospectionTokenMapper, UserInfoTokenMapper, org.keycloak.protocol.ProtocolMapper, org.keycloak.provider.ConfiguredProvider, org.keycloak.provider.Provider, org.keycloak.provider.ProviderFactory<org.keycloak.protocol.ProtocolMapper>
public class HardcodedRole extends AbstractOIDCProtocolMapper implements OIDCAccessTokenMapper, UserInfoTokenMapper, TokenIntrospectionTokenMapper
Add a role to a token
Version:
$Revision: 1 $
Author:
Bill Burke

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final String
    PROVIDER_ID
     
    static final String
    ROLE_CONFIG
     

    Fields inherited from class org.keycloak.protocol.oidc.mappers.AbstractOIDCProtocolMapper

    TOKEN_MAPPER_CATEGORY

  • Constructor Summary

    Constructors
    Constructor
    Description
    HardcodedRole()
     

  • Method Summary

    Modifier and Type
    Method
    Description
    static org.keycloak.models.ProtocolMapperModel
    create(String name, String role)
     
    List<org.keycloak.provider.ProviderConfigProperty>
    getConfigProperties()
     
    String
    getDisplayCategory()
     
    String
    getDisplayType()
     
    String
    getHelpText()
     
    String
    getId()
     
    int
    getPriority()
     
    protected void
    setClaim(org.keycloak.representations.IDToken token, org.keycloak.models.ProtocolMapperModel mappingModel, org.keycloak.models.UserSessionModel userSession, org.keycloak.models.KeycloakSession session, org.keycloak.models.ClientSessionContext clientSessionCtx)
    Intended to be overridden in ProtocolMapper implementations to add claims to an token.
    org.keycloak.representations.AccessToken
    transformAccessToken(org.keycloak.representations.AccessToken token, org.keycloak.models.ProtocolMapperModel mappingModel, org.keycloak.models.KeycloakSession session, org.keycloak.models.UserSessionModel userSession, org.keycloak.models.ClientSessionContext clientSessionCtx)
     
    org.keycloak.representations.AccessToken
    transformIntrospectionToken(org.keycloak.representations.AccessToken token, org.keycloak.models.ProtocolMapperModel mappingModel, org.keycloak.models.KeycloakSession session, org.keycloak.models.UserSessionModel userSession, org.keycloak.models.ClientSessionContext clientSessionCtx)
     
    org.keycloak.representations.AccessToken
    transformUserInfoToken(org.keycloak.representations.AccessToken token, org.keycloak.models.ProtocolMapperModel mappingModel, org.keycloak.models.KeycloakSession session, org.keycloak.models.UserSessionModel userSession, org.keycloak.models.ClientSessionContext clientSessionCtx)
     

    Methods inherited from class org.keycloak.protocol.oidc.mappers.AbstractOIDCProtocolMapper

    close, create, getEffectiveModel, getProtocol, getShouldUseLightweightToken, init, postInit, setClaim, setClaim, transformAccessTokenResponse, transformIDToken

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    Methods inherited from interface org.keycloak.provider.ConfiguredProvider

    getConfig

    Methods inherited from interface org.keycloak.protocol.ProtocolMapper

    validateConfig

    Methods inherited from interface org.keycloak.provider.ProviderFactory

    dependsOn, getConfigMetadata, order

  • Field Details

  • Constructor Details

    • HardcodedRole

      public HardcodedRole()

  • Method Details

    • getConfigProperties

      public List<org.keycloak.provider.ProviderConfigProperty> getConfigProperties()
      Specified by:
      getConfigProperties in interface org.keycloak.provider.ConfiguredProvider

    • getId

      public String getId()
      Specified by:
      getId in interface org.keycloak.provider.ProviderFactory<org.keycloak.protocol.ProtocolMapper>

    • getDisplayType

      public String getDisplayType()
      Specified by:
      getDisplayType in interface org.keycloak.protocol.ProtocolMapper

    • getDisplayCategory

      public String getDisplayCategory()
      Specified by:
      getDisplayCategory in interface org.keycloak.protocol.ProtocolMapper

    • getHelpText

      public String getHelpText()
      Specified by:
      getHelpText in interface org.keycloak.provider.ConfiguredProvider

    • getPriority

      public int getPriority()
      Specified by:
      getPriority in interface org.keycloak.protocol.ProtocolMapper

    • transformUserInfoToken

      public org.keycloak.representations.AccessToken transformUserInfoToken(org.keycloak.representations.AccessToken token, org.keycloak.models.ProtocolMapperModel mappingModel, org.keycloak.models.KeycloakSession session, org.keycloak.models.UserSessionModel userSession, org.keycloak.models.ClientSessionContext clientSessionCtx)
      Specified by:
      transformUserInfoToken in interface UserInfoTokenMapper
      Overrides:
      transformUserInfoToken in class AbstractOIDCProtocolMapper

    • transformAccessToken

      public org.keycloak.representations.AccessToken transformAccessToken(org.keycloak.representations.AccessToken token, org.keycloak.models.ProtocolMapperModel mappingModel, org.keycloak.models.KeycloakSession session, org.keycloak.models.UserSessionModel userSession, org.keycloak.models.ClientSessionContext clientSessionCtx)
      Specified by:
      transformAccessToken in interface OIDCAccessTokenMapper
      Overrides:
      transformAccessToken in class AbstractOIDCProtocolMapper

    • transformIntrospectionToken

      public org.keycloak.representations.AccessToken transformIntrospectionToken(org.keycloak.representations.AccessToken token, org.keycloak.models.ProtocolMapperModel mappingModel, org.keycloak.models.KeycloakSession session, org.keycloak.models.UserSessionModel userSession, org.keycloak.models.ClientSessionContext clientSessionCtx)
      Specified by:
      transformIntrospectionToken in interface TokenIntrospectionTokenMapper
      Overrides:
      transformIntrospectionToken in class AbstractOIDCProtocolMapper

    • setClaim

      protected void setClaim(org.keycloak.representations.IDToken token, org.keycloak.models.ProtocolMapperModel mappingModel, org.keycloak.models.UserSessionModel userSession, org.keycloak.models.KeycloakSession session, org.keycloak.models.ClientSessionContext clientSessionCtx)
      Description copied from class: AbstractOIDCProtocolMapper
      Intended to be overridden in ProtocolMapper implementations to add claims to an token.
      Overrides:
      setClaim in class AbstractOIDCProtocolMapper

    • create

      public static org.keycloak.models.ProtocolMapperModel create(String name, String role)