## Uses of Class
org.keycloak.representations.IDToken

- Packages that use IDToken
  Package | Description
  --- | ---
  org.keycloak |
  org.keycloak.authorization.common |
  org.keycloak.protocol.oidc |
  org.keycloak.protocol.oidc.mappers |
  org.keycloak.representations |
  org.keycloak.representations.oidc |
  org.keycloak.services.managers |

- - ### Uses of IDToken in org.keycloak

    Fields in org.keycloak declared as IDToken
    Modifier and Type | Field and Description
    --- | ---
    `protected IDToken` | KeycloakSecurityContext.`idToken`

    Methods in org.keycloak that return IDToken
    Modifier and Type | Method and Description
    --- | ---
    `IDToken` | KeycloakSecurityContext.`getIdToken()`

    Constructors in org.keycloak with parameters of type IDToken
    Constructor and Description
    `KeycloakSecurityContext(String tokenString, AccessToken token, String idTokenString, IDToken idToken)`

  - ### Uses of IDToken in org.keycloak.authorization.common

    Constructors in org.keycloak.authorization.common with parameters of type IDToken
    Constructor and Description
    `KeycloakIdentity(IDToken token, KeycloakSession keycloakSession, RealmModel realm)`
    `KeycloakIdentity(KeycloakSession keycloakSession, IDToken token)`

  - ### Uses of IDToken in org.keycloak.protocol.oidc

    Methods in org.keycloak.protocol.oidc that return IDToken
    Modifier and Type | Method and Description
    --- | ---
    `IDToken` | TokenManager.AccessTokenResponseBuilder.`getIdToken()`
    `IDToken` | TokenManager.`verifyIDToken(KeycloakSession session, RealmModel realm, String encodedIDToken)`
    `IDToken` | TokenManager.`verifyIDTokenSignature(KeycloakSession session, String encodedIDToken)`

    Methods in org.keycloak.protocol.oidc with parameters of type IDToken
    Modifier and Type | Method and Description
    --- | ---
    `void` | TokenManager.`transformIDToken(KeycloakSession session, IDToken token, UserSessionModel userSession, ClientSessionContext clientSessionCtx)`

  - ### Uses of IDToken in org.keycloak.protocol.oidc.mappers

    Methods in org.keycloak.protocol.oidc.mappers that return IDToken
    Modifier and Type | Method and Description
    --- | ---
    `IDToken` | OIDCIDTokenMapper.`transformIDToken(IDToken token, ProtocolMapperModel mappingModel, KeycloakSession session, UserSessionModel userSession, ClientSessionContext clientSession)`
    `IDToken` | AbstractPairwiseSubMapper.`transformIDToken(IDToken token, ProtocolMapperModel mappingModel, KeycloakSession session, UserSessionModel userSession, ClientSessionContext clientSessionCtx)`
    `IDToken` | AbstractOIDCProtocolMapper.`transformIDToken(IDToken token, ProtocolMapperModel mappingModel, KeycloakSession session, UserSessionModel userSession, ClientSessionContext clientSessionCtx)`

    Methods in org.keycloak.protocol.oidc.mappers with parameters of type IDToken
    Modifier and Type | Method and Description
    --- | ---
    `static void` | OIDCAttributeMapperHelper.`mapClaim(IDToken token, ProtocolMapperModel mappingModel, Object attributeValue)`
    `protected void` | AbstractPairwiseSubMapper.`setAccessTokenSubject(IDToken token, String pairwiseSub)`
    `protected void` | UserSessionNoteMapper.`setClaim(IDToken token, ProtocolMapperModel mappingModel, UserSessionModel userSession)`
    `protected void` | UserPropertyMapper.`setClaim(IDToken token, ProtocolMapperModel mappingModel, UserSessionModel userSession)`
    `protected void` | UserAttributeMapper.`setClaim(IDToken token, ProtocolMapperModel mappingModel, UserSessionModel userSession)`
    `protected void` | HardcodedClaim.`setClaim(IDToken token, ProtocolMapperModel mappingModel, UserSessionModel userSession)`
    `protected void` | GroupMembershipMapper.`setClaim(IDToken token, ProtocolMapperModel mappingModel, UserSessionModel userSession)` Adds the group membership information to the `JsonWebToken.otherClaims`.
    `protected void` | FullNameMapper.`setClaim(IDToken token, ProtocolMapperModel mappingModel, UserSessionModel userSession)`
    `protected void` | AddressMapper.`setClaim(IDToken token, ProtocolMapperModel mappingModel, UserSessionModel userSession)`
    `protected void` | AbstractOIDCProtocolMapper.`setClaim(IDToken token, ProtocolMapperModel mappingModel, UserSessionModel userSession)` Deprecated. override `AbstractOIDCProtocolMapper.setClaim(IDToken, ProtocolMapperModel, UserSessionModel, KeycloakSession, ClientSessionContext)` instead.
    `protected void` | UserRealmRoleMappingMapper.`setClaim(IDToken token, ProtocolMapperModel mappingModel, UserSessionModel userSession, KeycloakSession session, ClientSessionContext clientSessionCtx)`
    `protected void` | UserClientRoleMappingMapper.`setClaim(IDToken token, ProtocolMapperModel mappingModel, UserSessionModel userSession, KeycloakSession session, ClientSessionContext clientSessionCtx)`
    `protected void` | ScriptBasedOIDCProtocolMapper.`setClaim(IDToken token, ProtocolMapperModel mappingModel, UserSessionModel userSession, KeycloakSession keycloakSession, ClientSessionContext clientSessionCtx)`
    `protected void` | ClaimsParameterTokenMapper.`setClaim(IDToken token, ProtocolMapperModel mappingModel, UserSessionModel userSession, KeycloakSession keycloakSession, ClientSessionContext clientSessionCtx)`
    `protected void` | AudienceProtocolMapper.`setClaim(IDToken token, ProtocolMapperModel mappingModel, UserSessionModel userSession, KeycloakSession keycloakSession, ClientSessionContext clientSessionCtx)`
    `protected void` | AbstractOIDCProtocolMapper.`setClaim(IDToken token, ProtocolMapperModel mappingModel, UserSessionModel userSession, KeycloakSession keycloakSession, ClientSessionContext clientSessionCtx)` Intended to be overridden in `ProtocolMapper` implementations to add claims to an token.
    `protected void` | AbstractPairwiseSubMapper.`setIDTokenSubject(IDToken token, String pairwiseSub)`
    `protected void` | AbstractPairwiseSubMapper.`setUserInfoTokenSubject(IDToken token, String pairwiseSub)`
    `IDToken` | OIDCIDTokenMapper.`transformIDToken(IDToken token, ProtocolMapperModel mappingModel, KeycloakSession session, UserSessionModel userSession, ClientSessionContext clientSession)`
    `IDToken` | AbstractPairwiseSubMapper.`transformIDToken(IDToken token, ProtocolMapperModel mappingModel, KeycloakSession session, UserSessionModel userSession, ClientSessionContext clientSessionCtx)`
    `IDToken` | AbstractOIDCProtocolMapper.`transformIDToken(IDToken token, ProtocolMapperModel mappingModel, KeycloakSession session, UserSessionModel userSession, ClientSessionContext clientSessionCtx)`

  - ### Uses of IDToken in org.keycloak.representations

    Subclasses of IDToken in org.keycloak.representations
    Modifier and Type | Class and Description
    --- | ---
    `class` | `AccessToken`
    `class` | `RefreshToken`

  - ### Uses of IDToken in org.keycloak.representations.oidc

    Subclasses of IDToken in org.keycloak.representations.oidc
    Modifier and Type | Class and Description
    --- | ---
    `class` | `TokenMetadataRepresentation`

  - ### Uses of IDToken in org.keycloak.services.managers

    Subclasses of IDToken in org.keycloak.services.managers
    Modifier and Type | Class and Description
    --- | ---
    `class` | `IdentityCookieToken`

Copyright © 2021 JBoss by Red Hat. All rights reserved.