org.keycloak.protocol.oidc.mappers.AudienceProtocolMapper の継承関係図

org.keycloak.protocol.oidc.mappers.AudienceProtocolMapper 連携図

公開メンバ関数
List< ProviderConfigProperty >	getConfigProperties ()

String	getId ()

String	getDisplayType ()

String	getDisplayCategory ()

String	getHelpText ()

String	getProtocol ()

void	close ()

final ProtocolMapper	create (KeycloakSession session)

void	init (Config.Scope config)

void	postInit (KeycloakSessionFactory factory)

AccessToken	transformUserInfoToken (AccessToken token, ProtocolMapperModel mappingModel, KeycloakSession session, UserSessionModel userSession, AuthenticatedClientSessionModel clientSession)

AccessToken	transformAccessToken (AccessToken token, ProtocolMapperModel mappingModel, KeycloakSession session, UserSessionModel userSession, AuthenticatedClientSessionModel clientSession)

IDToken	transformIDToken (IDToken token, ProtocolMapperModel mappingModel, KeycloakSession session, UserSessionModel userSession, AuthenticatedClientSessionModel clientSession)

default void	validateConfig (KeycloakSession session, RealmModel realm, ProtocolMapperContainerModel client, ProtocolMapperModel mapperModel) throws ProtocolMapperConfigException

default int	order ()

AccessToken	transformAccessToken (AccessToken token, ProtocolMapperModel mappingModel, KeycloakSession session, UserSessionModel userSession, AuthenticatedClientSessionModel clientSession)

IDToken	transformIDToken (IDToken token, ProtocolMapperModel mappingModel, KeycloakSession session, UserSessionModel userSession, AuthenticatedClientSessionModel clientSession)

静的公開メンバ関数
static ProtocolMapperModel	createClaimMapper (String name, String includedClientAudience, String includedCustomAudience, boolean accessToken, boolean idToken)

静的公開変数類
static final String	INCLUDED_CLIENT_AUDIENCE = "included.client.audience"

static final String	PROVIDER_ID = "oidc-audience-mapper"

static final String	TOKEN_MAPPER_CATEGORY = "Token mapper"

限定公開メンバ関数
void	setClaim (IDToken token, ProtocolMapperModel mappingModel, UserSessionModel userSession, KeycloakSession keycloakSession)

void	setClaim (IDToken token, ProtocolMapperModel mappingModel, UserSessionModel userSession)

静的関数
	[static initializer]

静的非公開変数類
static final List< ProviderConfigProperty >	configProperties = new ArrayList<ProviderConfigProperty>()

static final String	INCLUDED_CLIENT_AUDIENCE_LABEL = "included.client.audience.label"

static final String	INCLUDED_CLIENT_AUDIENCE_HELP_TEXT = "included.client.audience.tooltip"

static final String	INCLUDED_CUSTOM_AUDIENCE = "included.custom.audience"

static final String	INCLUDED_CUSTOM_AUDIENCE_LABEL = "included.custom.audience.label"

static final String	INCLUDED_CUSTOM_AUDIENCE_HELP_TEXT = "included.custom.audience.tooltip"

詳解

著者: Marek Posolda

関数詳解

◆ [static initializer]()

org.keycloak.protocol.oidc.mappers.AudienceProtocolMapper.[static initializer] ( )

inlinestaticpackage

◆ close()

void org.keycloak.protocol.oidc.mappers.AbstractOIDCProtocolMapper.close ( )

inlineinherited

org.keycloak.provider.Providerを実装しています。

                         {
 
     }

◆ create()

final ProtocolMapper org.keycloak.protocol.oidc.mappers.AbstractOIDCProtocolMapper.create ( KeycloakSession session )

inlineinherited

org.keycloak.provider.ProviderFactory< T extends Provider >を実装しています。

                                                                 {
         throw new RuntimeException("UNSUPPORTED METHOD");
     }

◆ createClaimMapper()

static ProtocolMapperModel org.keycloak.protocol.oidc.mappers.AudienceProtocolMapper.createClaimMapper	(	String	name,
		String	includedClientAudience,
		String	includedCustomAudience,
		boolean	accessToken,
		boolean	idToken
	)

inlinestatic

                                                                                               {
         ProtocolMapperModel mapper = new ProtocolMapperModel();
         mapper.setName(name);
         mapper.setProtocolMapper(PROVIDER_ID);
         mapper.setProtocol(OIDCLoginProtocol.LOGIN_PROTOCOL);
 
         Map<String, String> config = new HashMap<String, String>();
         if (includedClientAudience != null) {
             config.put(INCLUDED_CLIENT_AUDIENCE, includedClientAudience);
         }
         if (includedCustomAudience != null) {
             config.put(INCLUDED_CUSTOM_AUDIENCE, includedCustomAudience);
         }
 
         if (accessToken) config.put(OIDCAttributeMapperHelper.INCLUDE_IN_ACCESS_TOKEN, "true");
         if (idToken) config.put(OIDCAttributeMapperHelper.INCLUDE_IN_ID_TOKEN, "true");
         mapper.setConfig(config);
         return mapper;
     }

◆ getConfigProperties()

List<ProviderConfigProperty> org.keycloak.protocol.oidc.mappers.AudienceProtocolMapper.getConfigProperties ( )

inline

org.keycloak.provider.ConfiguredProviderを実装しています。

                                                               {
         return configProperties;
     }

◆ getDisplayCategory()

String org.keycloak.protocol.oidc.mappers.AudienceProtocolMapper.getDisplayCategory ( )

inline

org.keycloak.protocol.ProtocolMapperを実装しています。

                                        {
         return TOKEN_MAPPER_CATEGORY;
     }

◆ getDisplayType()

String org.keycloak.protocol.oidc.mappers.AudienceProtocolMapper.getDisplayType ( )

inline

org.keycloak.protocol.ProtocolMapperを実装しています。

                                    {
         return "Audience";
     }

◆ getHelpText()

String org.keycloak.protocol.oidc.mappers.AudienceProtocolMapper.getHelpText ( )

inline

org.keycloak.provider.ConfiguredProviderを実装しています。

                                 {
         return "Add specified audience to the audience (aud) field of token";
     }

◆ getId()

String org.keycloak.protocol.oidc.mappers.AudienceProtocolMapper.getId ( )

inline

org.keycloak.provider.ProviderFactory< T extends Provider >を実装しています。

                           {
         return PROVIDER_ID;
     }

◆ getProtocol()

String org.keycloak.protocol.oidc.mappers.AbstractOIDCProtocolMapper.getProtocol ( )

inlineinherited

org.keycloak.protocol.ProtocolMapperを実装しています。

                                 {
         return OIDCLoginProtocol.LOGIN_PROTOCOL;
     }

◆ init()

void org.keycloak.protocol.oidc.mappers.AbstractOIDCProtocolMapper.init ( Config.Scope config )

inlineinherited

org.keycloak.provider.ProviderFactory< T extends Provider >を実装しています。

55 {

56 }

◆ order()

default int org.keycloak.provider.ProviderFactory< T extends Provider >.order ( )

inlineinherited

org.keycloak.protocol.docker.DockerAuthV2ProtocolFactory, org.keycloak.urls.HostnameProviderFactory, org.keycloak.protocol.oidc.ext.OIDCExtProviderFactoryで実装されています。

                         {
         return 0;
     }

◆ postInit()

void org.keycloak.protocol.oidc.mappers.AbstractOIDCProtocolMapper.postInit ( KeycloakSessionFactory factory )

inlineinherited

org.keycloak.provider.ProviderFactory< T extends Provider >を実装しています。

                                                          {
 
     }

◆ setClaim() [1/2]

void org.keycloak.protocol.oidc.mappers.AudienceProtocolMapper.setClaim	(	IDToken	token,
		ProtocolMapperModel	mappingModel,
		UserSessionModel	userSession,
		KeycloakSession	keycloakSession
	)

inlineprotected

                                                                                                                                             {
         String audienceValue = mappingModel.getConfig().get(INCLUDED_CLIENT_AUDIENCE);
 
         if (audienceValue == null) {
             // Fallback to custom audience
             audienceValue = mappingModel.getConfig().get(INCLUDED_CUSTOM_AUDIENCE);
         }
 
         if (audienceValue == null) return;
         token.addAudience(audienceValue);
     }

◆ setClaim() [2/2]

void org.keycloak.protocol.oidc.mappers.AbstractOIDCProtocolMapper.setClaim	(	IDToken	token,
		ProtocolMapperModel	mappingModel,
		UserSessionModel	userSession
	)

inlineprotectedinherited

Intended to be overridden in ProtocolMapper implementations to add claims to an token.

引数

token
mappingModel
userSession

非推奨:: override setClaim(IDToken, ProtocolMapperModel, UserSessionModel, KeycloakSession) instead.

105 {

106 }

◆ transformAccessToken() [1/2]

AccessToken org.keycloak.protocol.oidc.mappers.OIDCAccessTokenMapper.transformAccessToken	(	AccessToken	token,
		ProtocolMapperModel	mappingModel,
		KeycloakSession	session,
		UserSessionModel	userSession,
		AuthenticatedClientSessionModel	clientSession
	)

inherited

org.keycloak.protocol.oidc.mappers.RoleNameMapper, org.keycloak.protocol.oidc.mappers.HardcodedRole, org.keycloak.protocol.oidc.mappers.AbstractPairwiseSubMapperで実装されています。

◆ transformAccessToken() [2/2]

AccessToken org.keycloak.protocol.oidc.mappers.AbstractOIDCProtocolMapper.transformAccessToken	(	AccessToken	token,
		ProtocolMapperModel	mappingModel,
		KeycloakSession	session,
		UserSessionModel	userSession,
		AuthenticatedClientSessionModel	clientSession
	)

inlineinherited

                                                                                                                          {
 
         if (!OIDCAttributeMapperHelper.includeInAccessToken(mappingModel)){
             return token;
         }
 
         setClaim(token, mappingModel, userSession, session);
         return token;
     }

◆ transformIDToken() [1/2]

IDToken org.keycloak.protocol.oidc.mappers.OIDCIDTokenMapper.transformIDToken	(	IDToken	token,
		ProtocolMapperModel	mappingModel,
		KeycloakSession	session,
		UserSessionModel	userSession,
		AuthenticatedClientSessionModel	clientSession
	)

inherited

org.keycloak.protocol.oidc.mappers.AbstractPairwiseSubMapperで実装されています。

◆ transformIDToken() [2/2]

IDToken org.keycloak.protocol.oidc.mappers.AbstractOIDCProtocolMapper.transformIDToken	(	IDToken	token,
		ProtocolMapperModel	mappingModel,
		KeycloakSession	session,
		UserSessionModel	userSession,
		AuthenticatedClientSessionModel	clientSession
	)

inlineinherited

                                                                                                                  {
 
         if (!OIDCAttributeMapperHelper.includeInIDToken(mappingModel)){
             return token;
         }
 
         setClaim(token, mappingModel, userSession, session);
         return token;
     }

◆ transformUserInfoToken()

AccessToken org.keycloak.protocol.oidc.mappers.AbstractOIDCProtocolMapper.transformUserInfoToken	(	AccessToken	token,
		ProtocolMapperModel	mappingModel,
		KeycloakSession	session,
		UserSessionModel	userSession,
		AuthenticatedClientSessionModel	clientSession
	)

inlineinherited

                                                                                                                            {
 
         if (!OIDCAttributeMapperHelper.includeInUserInfo(mappingModel)) {
             return token;
         }
 
         setClaim(token, mappingModel, userSession, session);
         return token;
     }

◆ validateConfig()

default void org.keycloak.protocol.ProtocolMapper.validateConfig	(	KeycloakSession	session,
		RealmModel	realm,
		ProtocolMapperContainerModel	client,
		ProtocolMapperModel	mapperModel
	)		throws ProtocolMapperConfigException

inlineinherited

Called when instance of mapperModel is created/updated for this protocolMapper through admin endpoint

引数

session
realm
client	client or clientTemplate
mapperModel

例外

ProtocolMapperConfigException if configuration provided in mapperModel is not valid

org.keycloak.protocol.saml.mappers.ScriptBasedMapper, org.keycloak.protocol.oidc.mappers.ScriptBasedOIDCProtocolMapper, org.keycloak.protocol.oidc.mappers.AbstractPairwiseSubMapperで実装されています。

46 {

47 };

メンバ詳解

◆ configProperties

final List<ProviderConfigProperty> org.keycloak.protocol.oidc.mappers.AudienceProtocolMapper.configProperties = new ArrayList<ProviderConfigProperty>()

staticprivate

◆ INCLUDED_CLIENT_AUDIENCE

final String org.keycloak.protocol.oidc.mappers.AudienceProtocolMapper.INCLUDED_CLIENT_AUDIENCE = "included.client.audience"

static

◆ INCLUDED_CLIENT_AUDIENCE_HELP_TEXT

final String org.keycloak.protocol.oidc.mappers.AudienceProtocolMapper.INCLUDED_CLIENT_AUDIENCE_HELP_TEXT = "included.client.audience.tooltip"

staticprivate

◆ INCLUDED_CLIENT_AUDIENCE_LABEL

final String org.keycloak.protocol.oidc.mappers.AudienceProtocolMapper.INCLUDED_CLIENT_AUDIENCE_LABEL = "included.client.audience.label"

staticprivate

◆ INCLUDED_CUSTOM_AUDIENCE

final String org.keycloak.protocol.oidc.mappers.AudienceProtocolMapper.INCLUDED_CUSTOM_AUDIENCE = "included.custom.audience"

staticprivate

◆ INCLUDED_CUSTOM_AUDIENCE_HELP_TEXT

final String org.keycloak.protocol.oidc.mappers.AudienceProtocolMapper.INCLUDED_CUSTOM_AUDIENCE_HELP_TEXT = "included.custom.audience.tooltip"

staticprivate

◆ INCLUDED_CUSTOM_AUDIENCE_LABEL

final String org.keycloak.protocol.oidc.mappers.AudienceProtocolMapper.INCLUDED_CUSTOM_AUDIENCE_LABEL = "included.custom.audience.label"

staticprivate

◆ PROVIDER_ID

final String org.keycloak.protocol.oidc.mappers.AudienceProtocolMapper.PROVIDER_ID = "oidc-audience-mapper"

static

◆ TOKEN_MAPPER_CATEGORY

final String org.keycloak.protocol.oidc.mappers.AbstractOIDCProtocolMapper.TOKEN_MAPPER_CATEGORY = "Token mapper"

staticinherited

このクラス詳解は次のファイルから抽出されました:

D:/AppData/doxygen/keycloak/src/keycloak/src/main/java/org/keycloak/protocol/oidc/mappers/AudienceProtocolMapper.java

公開メンバ関数

静的公開メンバ関数

静的公開変数類

限定公開メンバ関数

静的関数

静的非公開変数類

詳解

関数詳解

◆ [static initializer]()

◆ close()

◆ create()

◆ createClaimMapper()

◆ getConfigProperties()

◆ getDisplayCategory()

◆ getDisplayType()

◆ getHelpText()

◆ getId()

◆ getProtocol()

◆ init()

◆ order()

◆ postInit()

◆ setClaim() [1/2]

◆ setClaim() [2/2]

◆ transformAccessToken() [1/2]

◆ transformAccessToken() [2/2]

◆ transformIDToken() [1/2]

◆ transformIDToken() [2/2]

◆ transformUserInfoToken()

◆ validateConfig()

メンバ詳解

◆ configProperties

◆ INCLUDED_CLIENT_AUDIENCE

◆ INCLUDED_CLIENT_AUDIENCE_HELP_TEXT

◆ INCLUDED_CLIENT_AUDIENCE_LABEL

◆ INCLUDED_CUSTOM_AUDIENCE

◆ INCLUDED_CUSTOM_AUDIENCE_HELP_TEXT

◆ INCLUDED_CUSTOM_AUDIENCE_LABEL

◆ PROVIDER_ID

◆ TOKEN_MAPPER_CATEGORY