|
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) |
|
AccessToken | transformUserInfoToken (AccessToken token, ProtocolMapperModel mappingModel, KeycloakSession session, UserSessionModel userSession, AuthenticatedClientSessionModel clientSession) |
|
|
static boolean | useFullPath (ProtocolMapperModel mappingModel) |
|
static ProtocolMapperModel | create (String name, String tokenClaimName, boolean consentRequired, String consentText, 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>() |
|
Maps user group membership
- 著者
- Bill Burke
- バージョン
- Revision
- 1
◆ [static initializer]()
org.keycloak.protocol.oidc.mappers.GroupMembershipMapper.[static initializer] |
( |
| ) |
|
|
inlinestaticpackage |
◆ close()
void org.keycloak.protocol.oidc.mappers.AbstractOIDCProtocolMapper.close |
( |
| ) |
|
|
inlineinherited |
◆ create() [1/2]
final ProtocolMapper org.keycloak.protocol.oidc.mappers.AbstractOIDCProtocolMapper.create |
( |
KeycloakSession |
session | ) |
|
|
inlineinherited |
51 throw new RuntimeException(
"UNSUPPORTED METHOD");
◆ create() [2/2]
static ProtocolMapperModel org.keycloak.protocol.oidc.mappers.GroupMembershipMapper.create |
( |
String |
name, |
|
|
String |
tokenClaimName, |
|
|
boolean |
consentRequired, |
|
|
String |
consentText, |
|
|
boolean |
accessToken, |
|
|
boolean |
idToken |
|
) |
| |
|
inlinestatic |
115 ProtocolMapperModel mapper =
new ProtocolMapperModel();
116 mapper.setName(name);
118 mapper.setProtocol(OIDCLoginProtocol.LOGIN_PROTOCOL);
119 Map<String, String> config =
new HashMap<String, String>();
120 config.put(OIDCAttributeMapperHelper.TOKEN_CLAIM_NAME, tokenClaimName);
121 if (accessToken) config.put(OIDCAttributeMapperHelper.INCLUDE_IN_ACCESS_TOKEN,
"true");
122 if (idToken) config.put(OIDCAttributeMapperHelper.INCLUDE_IN_ID_TOKEN,
"true");
123 mapper.setConfig(config);
static final String PROVIDER_ID
Definition: GroupMembershipMapper.java:57
◆ getConfigProperties()
List<ProviderConfigProperty> org.keycloak.protocol.oidc.mappers.GroupMembershipMapper.getConfigProperties |
( |
| ) |
|
|
inline |
static final List< ProviderConfigProperty > configProperties
Definition: GroupMembershipMapper.java:42
◆ getDisplayCategory()
String org.keycloak.protocol.oidc.mappers.GroupMembershipMapper.getDisplayCategory |
( |
| ) |
|
|
inline |
static final String TOKEN_MAPPER_CATEGORY
Definition: AbstractOIDCProtocolMapper.java:37
◆ getDisplayType()
String org.keycloak.protocol.oidc.mappers.GroupMembershipMapper.getDisplayType |
( |
| ) |
|
|
inline |
71 return "Group Membership";
◆ getHelpText()
String org.keycloak.protocol.oidc.mappers.GroupMembershipMapper.getHelpText |
( |
| ) |
|
|
inline |
81 return "Map user group membership";
◆ getId()
String org.keycloak.protocol.oidc.mappers.GroupMembershipMapper.getId |
( |
| ) |
|
|
inline |
static final String PROVIDER_ID
Definition: GroupMembershipMapper.java:57
◆ 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.GroupMembershipMapper.setClaim |
( |
IDToken |
token, |
|
|
ProtocolMapperModel |
mappingModel, |
|
|
UserSessionModel |
userSession |
|
) |
| |
|
inlineprotected |
Adds the group membership information to the IDToken#otherClaims.
- 引数
-
token | |
mappingModel | |
userSession | |
97 List<String> membership =
new LinkedList<>();
99 for (GroupModel group : userSession.getUser().getGroups()) {
101 membership.add(ModelToRepresentation.buildGroupPath(group));
103 membership.add(group.getName());
106 String protocolClaim = mappingModel.getConfig().get(OIDCAttributeMapperHelper.TOKEN_CLAIM_NAME);
108 token.getOtherClaims().put(protocolClaim, membership);
static boolean useFullPath(ProtocolMapperModel mappingModel)
Definition: GroupMembershipMapper.java:84
◆ 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() [1/2]
AccessToken org.keycloak.protocol.oidc.mappers.UserInfoTokenMapper.transformUserInfoToken |
( |
AccessToken |
token, |
|
|
ProtocolMapperModel |
mappingModel, |
|
|
KeycloakSession |
session, |
|
|
UserSessionModel |
userSession, |
|
|
AuthenticatedClientSessionModel |
clientSession |
|
) |
| |
|
inherited |
◆ transformUserInfoToken() [2/2]
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
◆ useFullPath()
static boolean org.keycloak.protocol.oidc.mappers.GroupMembershipMapper.useFullPath |
( |
ProtocolMapperModel |
mappingModel | ) |
|
|
inlinestatic |
85 return "true".equals(mappingModel.getConfig().get(
"full.path"));
◆ configProperties
final List<ProviderConfigProperty> org.keycloak.protocol.oidc.mappers.GroupMembershipMapper.configProperties = new ArrayList<ProviderConfigProperty>() |
|
staticprivate |
◆ PROVIDER_ID
final String org.keycloak.protocol.oidc.mappers.GroupMembershipMapper.PROVIDER_ID = "oidc-group-membership-mapper" |
|
static |
◆ TOKEN_MAPPER_CATEGORY
final String org.keycloak.protocol.oidc.mappers.AbstractOIDCProtocolMapper.TOKEN_MAPPER_CATEGORY = "Token mapper" |
|
staticinherited |
このクラス詳解は次のファイルから抽出されました: