|
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) |
|
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 userSessionNote, String tokenClaimName, String jsonType, boolean accessToken, boolean idToken) |
|
|
void | setClaim (IDToken token, ProtocolMapperModel mappingModel, UserSessionModel userSession) |
|
void | setClaim (IDToken token, ProtocolMapperModel mappingModel, UserSessionModel userSession, KeycloakSession keycloakSession) |
|
|
static final List< ProviderConfigProperty > | configProperties = new ArrayList<ProviderConfigProperty>() |
|
Mappings UserSessionModel.note to an ID Token claim.
- 著者
- Marek Posolda
◆ [static initializer]()
org.keycloak.protocol.oidc.mappers.UserSessionNoteMapper.[static initializer] |
( |
| ) |
|
|
inlinestaticpackage |
◆ close()
void org.keycloak.protocol.oidc.mappers.AbstractOIDCProtocolMapper.close |
( |
| ) |
|
|
inlineinherited |
◆ create()
final ProtocolMapper org.keycloak.protocol.oidc.mappers.AbstractOIDCProtocolMapper.create |
( |
KeycloakSession |
session | ) |
|
|
inlineinherited |
51 throw new RuntimeException(
"UNSUPPORTED METHOD");
◆ createClaimMapper()
static ProtocolMapperModel org.keycloak.protocol.oidc.mappers.UserSessionNoteMapper.createClaimMapper |
( |
String |
name, |
|
|
String |
userSessionNote, |
|
|
String |
tokenClaimName, |
|
|
String |
jsonType, |
|
|
boolean |
accessToken, |
|
|
boolean |
idToken |
|
) |
| |
|
inlinestatic |
91 ProtocolMapperModel mapper =
new ProtocolMapperModel();
94 mapper.setProtocol(OIDCLoginProtocol.LOGIN_PROTOCOL);
95 Map<String, String> config =
new HashMap<String, String>();
96 config.put(ProtocolMapperUtils.USER_SESSION_NOTE, userSessionNote);
97 config.put(OIDCAttributeMapperHelper.TOKEN_CLAIM_NAME, tokenClaimName);
98 config.put(OIDCAttributeMapperHelper.JSON_TYPE, jsonType);
99 if (accessToken) config.put(OIDCAttributeMapperHelper.INCLUDE_IN_ACCESS_TOKEN,
"true");
100 if (idToken) config.put(OIDCAttributeMapperHelper.INCLUDE_IN_ID_TOKEN,
"true");
101 mapper.setConfig(config);
static final String PROVIDER_ID
Definition: UserSessionNoteMapper.java:52
◆ getConfigProperties()
List<ProviderConfigProperty> org.keycloak.protocol.oidc.mappers.UserSessionNoteMapper.getConfigProperties |
( |
| ) |
|
|
inline |
static final List< ProviderConfigProperty > configProperties
Definition: UserSessionNoteMapper.java:39
◆ getDisplayCategory()
String org.keycloak.protocol.oidc.mappers.UserSessionNoteMapper.getDisplayCategory |
( |
| ) |
|
|
inline |
static final String TOKEN_MAPPER_CATEGORY
Definition: AbstractOIDCProtocolMapper.java:37
◆ getDisplayType()
String org.keycloak.protocol.oidc.mappers.UserSessionNoteMapper.getDisplayType |
( |
| ) |
|
|
inline |
66 return "User Session Note";
◆ getHelpText()
String org.keycloak.protocol.oidc.mappers.UserSessionNoteMapper.getHelpText |
( |
| ) |
|
|
inline |
76 return "Map a custom user session note to a token claim.";
◆ getId()
String org.keycloak.protocol.oidc.mappers.UserSessionNoteMapper.getId |
( |
| ) |
|
|
inline |
static final String PROVIDER_ID
Definition: UserSessionNoteMapper.java:52
◆ getProtocol()
String org.keycloak.protocol.oidc.mappers.AbstractOIDCProtocolMapper.getProtocol |
( |
| ) |
|
|
inlineinherited |
41 return OIDCLoginProtocol.LOGIN_PROTOCOL;
◆ init()
void org.keycloak.protocol.oidc.mappers.AbstractOIDCProtocolMapper.init |
( |
Config.Scope |
config | ) |
|
|
inlineinherited |
◆ postInit()
void org.keycloak.protocol.oidc.mappers.AbstractOIDCProtocolMapper.postInit |
( |
KeycloakSessionFactory |
factory | ) |
|
|
inlineinherited |
◆ setClaim() [1/2]
void org.keycloak.protocol.oidc.mappers.UserSessionNoteMapper.setClaim |
( |
IDToken |
token, |
|
|
ProtocolMapperModel |
mappingModel, |
|
|
UserSessionModel |
userSession |
|
) |
| |
|
inlineprotected |
81 String noteName = mappingModel.getConfig().get(ProtocolMapperUtils.USER_SESSION_NOTE);
82 String noteValue = userSession.getNote(noteName);
83 if (noteValue == null)
return;
84 OIDCAttributeMapperHelper.mapClaim(token, mappingModel, noteValue);
◆ setClaim() [2/2]
void org.keycloak.protocol.oidc.mappers.AbstractOIDCProtocolMapper.setClaim |
( |
IDToken |
token, |
|
|
ProtocolMapperModel |
mappingModel, |
|
|
UserSessionModel |
userSession, |
|
|
KeycloakSession |
keycloakSession |
|
) |
| |
|
inlineprotectedinherited |
Intended to be overridden in ProtocolMapper implementations to add claims to an token.
- 引数
-
token | |
mappingModel | |
userSession | |
keycloakSession | |
117 setClaim(token, mappingModel, userSession);
void setClaim(IDToken token, ProtocolMapperModel mappingModel, UserSessionModel userSession)
Definition: AbstractOIDCProtocolMapper.java:105
◆ transformAccessToken() [1/2]
AccessToken org.keycloak.protocol.oidc.mappers.OIDCAccessTokenMapper.transformAccessToken |
( |
AccessToken |
token, |
|
|
ProtocolMapperModel |
mappingModel, |
|
|
KeycloakSession |
session, |
|
|
UserSessionModel |
userSession, |
|
|
AuthenticatedClientSessionModel |
clientSession |
|
) |
| |
|
inherited |
◆ transformAccessToken() [2/2]
AccessToken org.keycloak.protocol.oidc.mappers.AbstractOIDCProtocolMapper.transformAccessToken |
( |
AccessToken |
token, |
|
|
ProtocolMapperModel |
mappingModel, |
|
|
KeycloakSession |
session, |
|
|
UserSessionModel |
userSession, |
|
|
AuthenticatedClientSessionModel |
clientSession |
|
) |
| |
|
inlineinherited |
77 if (!OIDCAttributeMapperHelper.includeInAccessToken(mappingModel)){
81 setClaim(token, mappingModel, userSession, session);
void setClaim(IDToken token, ProtocolMapperModel mappingModel, UserSessionModel userSession)
Definition: AbstractOIDCProtocolMapper.java:105
◆ transformIDToken() [1/2]
IDToken org.keycloak.protocol.oidc.mappers.OIDCIDTokenMapper.transformIDToken |
( |
IDToken |
token, |
|
|
ProtocolMapperModel |
mappingModel, |
|
|
KeycloakSession |
session, |
|
|
UserSessionModel |
userSession, |
|
|
AuthenticatedClientSessionModel |
clientSession |
|
) |
| |
|
inherited |
◆ transformIDToken() [2/2]
IDToken org.keycloak.protocol.oidc.mappers.AbstractOIDCProtocolMapper.transformIDToken |
( |
IDToken |
token, |
|
|
ProtocolMapperModel |
mappingModel, |
|
|
KeycloakSession |
session, |
|
|
UserSessionModel |
userSession, |
|
|
AuthenticatedClientSessionModel |
clientSession |
|
) |
| |
|
inlineinherited |
88 if (!OIDCAttributeMapperHelper.includeInIDToken(mappingModel)){
92 setClaim(token, mappingModel, userSession, session);
void setClaim(IDToken token, ProtocolMapperModel mappingModel, UserSessionModel userSession)
Definition: AbstractOIDCProtocolMapper.java:105
◆ transformUserInfoToken()
AccessToken org.keycloak.protocol.oidc.mappers.AbstractOIDCProtocolMapper.transformUserInfoToken |
( |
AccessToken |
token, |
|
|
ProtocolMapperModel |
mappingModel, |
|
|
KeycloakSession |
session, |
|
|
UserSessionModel |
userSession, |
|
|
AuthenticatedClientSessionModel |
clientSession |
|
) |
| |
|
inlineinherited |
66 if (!OIDCAttributeMapperHelper.includeInUserInfo(mappingModel)) {
70 setClaim(token, mappingModel, userSession, session);
void setClaim(IDToken token, ProtocolMapperModel mappingModel, UserSessionModel userSession)
Definition: AbstractOIDCProtocolMapper.java:105
◆ configProperties
final List<ProviderConfigProperty> org.keycloak.protocol.oidc.mappers.UserSessionNoteMapper.configProperties = new ArrayList<ProviderConfigProperty>() |
|
staticprivate |
◆ PROVIDER_ID
final String org.keycloak.protocol.oidc.mappers.UserSessionNoteMapper.PROVIDER_ID = "oidc-usersessionmodel-note-mapper" |
|
static |
◆ TOKEN_MAPPER_CATEGORY
final String org.keycloak.protocol.oidc.mappers.AbstractOIDCProtocolMapper.TOKEN_MAPPER_CATEGORY = "Token mapper" |
|
staticinherited |
このクラス詳解は次のファイルから抽出されました: