org.keycloak.representations.IDToken クラス

org.keycloak.representations.IDToken の継承関係図

org.keycloak.representations.IDToken 連携図

公開メンバ関数
String	getNonce ()
void	setNonce (String nonce)
int	getAuthTime ()
void	setAuthTime (int authTime)
String	getSessionState ()
void	setSessionState (String sessionState)
String	getAccessTokenHash ()
void	setAccessTokenHash (String accessTokenHash)
String	getCodeHash ()
void	setCodeHash (String codeHash)
String	getName ()
void	setName (String name)
String	getGivenName ()
void	setGivenName (String givenName)
String	getFamilyName ()
void	setFamilyName (String familyName)
String	getMiddleName ()
void	setMiddleName (String middleName)
String	getNickName ()
void	setNickName (String nickName)
String	getPreferredUsername ()
void	setPreferredUsername (String preferredUsername)
String	getProfile ()
void	setProfile (String profile)
String	getPicture ()
void	setPicture (String picture)
String	getWebsite ()
void	setWebsite (String website)
String	getEmail ()
void	setEmail (String email)
Boolean	getEmailVerified ()
void	setEmailVerified (Boolean emailVerified)
String	getGender ()
void	setGender (String gender)
String	getBirthdate ()
void	setBirthdate (String birthdate)
String	getZoneinfo ()
void	setZoneinfo (String zoneinfo)
String	getLocale ()
void	setLocale (String locale)
String	getPhoneNumber ()
void	setPhoneNumber (String phoneNumber)
Boolean	getPhoneNumberVerified ()
void	setPhoneNumberVerified (Boolean phoneNumberVerified)
AddressClaimSet	getAddress ()
void	setAddress (AddressClaimSet address)
Long	getUpdatedAt ()
void	setUpdatedAt (Long updatedAt)
String	getClaimsLocales ()
void	setClaimsLocales (String claimsLocales)
String	getAcr ()
void	setAcr (String acr)
String	getStateHash ()
void	setStateHash (String stateHash)
TokenCategory	getCategory ()
JsonWebToken	id (String id)
JsonWebToken	expiration (int expiration)
JsonWebToken	notBefore (int notBefore)
JsonWebToken	issuedAt (int issuedAt)
JsonWebToken	issuer (String issuer)
JsonWebToken	audience (String... audience)
JsonWebToken	subject (String subject)
JsonWebToken	type (String type)
JsonWebToken	issuedFor (String issuedFor)
String	getId ()
int	getExpiration ()
boolean	isExpired ()
int	getNotBefore ()
boolean	isNotBefore (int allowedTimeSkew)
boolean	isActive ()
boolean	isActive (int allowedTimeSkew)
int	getIssuedAt ()
JsonWebToken	issuedNow ()
String	getIssuer ()
String []	getAudience ()
boolean	hasAudience (String audience)
JsonWebToken	addAudience (String audience)
String	getSubject ()
void	setSubject (String subject)
String	getType ()
String	getIssuedFor ()
Map< String, Object >	getOtherClaims ()
void	setOtherClaims (String name, Object value)

公開変数類
String	issuedFor

静的公開変数類
static final String	NONCE = "nonce"
static final String	AUTH_TIME = "auth_time"
static final String	SESSION_STATE = "session_state"
static final String	AT_HASH = "at_hash"
static final String	C_HASH = "c_hash"
static final String	NAME = "name"
static final String	GIVEN_NAME = "given_name"
static final String	FAMILY_NAME = "family_name"
static final String	MIDDLE_NAME = "middle_name"
static final String	NICKNAME = "nickname"
static final String	PREFERRED_USERNAME = "preferred_username"
static final String	PROFILE = "profile"
static final String	PICTURE = "picture"
static final String	WEBSITE = "website"
static final String	EMAIL = "email"
static final String	EMAIL_VERIFIED = "email_verified"
static final String	GENDER = "gender"
static final String	BIRTHDATE = "birthdate"
static final String	ZONEINFO = "zoneinfo"
static final String	LOCALE = "locale"
static final String	PHONE_NUMBER = "phone_number"
static final String	PHONE_NUMBER_VERIFIED = "phone_number_verified"
static final String	ADDRESS = "address"
static final String	UPDATED_AT = "updated_at"
static final String	CLAIMS_LOCALES = "claims_locales"
static final String	ACR = "acr"
static final String	S_HASH = "s_hash"

限定公開変数類
String	nonce
int	authTime
String	sessionState
String	accessTokenHash
String	codeHash
String	name
String	givenName
String	familyName
String	middleName
String	nickName
String	preferredUsername
String	profile
String	picture
String	website
String	email
Boolean	emailVerified
String	gender
String	birthdate
String	zoneinfo
String	locale
String	phoneNumber
Boolean	phoneNumberVerified
AddressClaimSet	address
Long	updatedAt
String	claimsLocales
String	acr
String	stateHash
String	id
int	expiration
int	notBefore
int	issuedAt
String	issuer
String []	audience
String	subject
String	type
Map< String, Object >	otherClaims = new HashMap<>()

詳解

著者

Bill Burke

バージョン

Revision

1

関数詳解

addAudience()

JsonWebToken org.keycloak.representations.JsonWebToken.addAudience ( String  audience )

inlineinherited

                                                     {
        if (this.audience == null) {
            this.audience = new String[] { audience };
        } else {
            // Check if audience is already there
            for (String aud : this.audience) {
                if (audience.equals(aud)) {
                    return this;
                }
            }

            String[] newAudience = Arrays.copyOf(this.audience, this.audience.length + 1);
            newAudience[this.audience.length] = audience;
            this.audience = newAudience;
        }
        return this;
    }

audience()

JsonWebToken org.keycloak.representations.JsonWebToken.audience ( String...  audience )

inlineinherited

                                                     {
        this.audience = audience;
        return this;
    }

expiration()

JsonWebToken org.keycloak.representations.JsonWebToken.expiration ( int  expiration )

inlineinherited

                                                   {
        this.expiration = expiration;
        return this;
    }

getAccessTokenHash()

String org.keycloak.representations.IDToken.getAccessTokenHash ( )

inline

                                       {
        return accessTokenHash;
    }

getAcr()

String org.keycloak.representations.IDToken.getAcr ( )

inline

                           {
        return acr;
    }

getAddress()

AddressClaimSet org.keycloak.representations.IDToken.getAddress ( )

inline

                                        {
        return address;
    }

getAudience()

String [] org.keycloak.representations.JsonWebToken.getAudience ( )

inlineinherited

                                  {
        return audience;
    }

getAuthTime()

int org.keycloak.representations.IDToken.getAuthTime ( )

inline

                             {
        return authTime;
    }

getBirthdate()

String org.keycloak.representations.IDToken.getBirthdate ( )

inline

                                 {
        return this.birthdate;
    }

getCategory()

TokenCategory org.keycloak.representations.IDToken.getCategory ( )

inline

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

                                       {
        return TokenCategory.ID;
    }

getClaimsLocales()

String org.keycloak.representations.IDToken.getClaimsLocales ( )

inline

                                     {
        return this.claimsLocales;
    }

getCodeHash()

String org.keycloak.representations.IDToken.getCodeHash ( )

inline

                                {
        return codeHash;
    }

getEmail()

String org.keycloak.representations.IDToken.getEmail ( )

inline

                             {
        return this.email;
    }

getEmailVerified()

Boolean org.keycloak.representations.IDToken.getEmailVerified ( )

inline

                                      {
        return this.emailVerified;
    }

getExpiration()

int org.keycloak.representations.JsonWebToken.getExpiration ( )

inlineinherited

                               {
        return expiration;
    }

getFamilyName()

String org.keycloak.representations.IDToken.getFamilyName ( )

inline

                                  {
        return this.familyName;
    }

getGender()

String org.keycloak.representations.IDToken.getGender ( )

inline

                              {
        return this.gender;
    }

getGivenName()

String org.keycloak.representations.IDToken.getGivenName ( )

inline

                                 {
        return this.givenName;
    }

getId()

String org.keycloak.representations.JsonWebToken.getId ( )

inlineinherited

                          {
        return id;
    }

getIssuedAt()

int org.keycloak.representations.JsonWebToken.getIssuedAt ( )

inlineinherited

                             {
        return issuedAt;
    }

getIssuedFor()

String org.keycloak.representations.JsonWebToken.getIssuedFor ( )

inlineinherited

OAuth client the token was issued for.

戻り値

                                 {
        return issuedFor;
    }

getIssuer()

String org.keycloak.representations.JsonWebToken.getIssuer ( )

inlineinherited

                              {
        return issuer;
    }

getLocale()

String org.keycloak.representations.IDToken.getLocale ( )

inline

                              {
        return this.locale;
    }

getMiddleName()

String org.keycloak.representations.IDToken.getMiddleName ( )

inline

                                  {
        return this.middleName;
    }

getName()

String org.keycloak.representations.IDToken.getName ( )

inline

                            {
        return this.name;
    }

getNickName()

String org.keycloak.representations.IDToken.getNickName ( )

inline

                                {
        return this.nickName;
    }

getNonce()

String org.keycloak.representations.IDToken.getNonce ( )

inline

                             {
        return nonce;
    }

getNotBefore()

int org.keycloak.representations.JsonWebToken.getNotBefore ( )

inlineinherited

                              {
        return notBefore;
    }

getOtherClaims()

Map<String, Object> org.keycloak.representations.JsonWebToken.getOtherClaims ( )

inlineinherited

This is a map of any other claims and data that might be in the IDToken. Could be custom claims set up by the auth server

戻り値

                                                {
        return otherClaims;
    }

getPhoneNumber()

String org.keycloak.representations.IDToken.getPhoneNumber ( )

inline

                                   {
        return this.phoneNumber;
    }

getPhoneNumberVerified()

Boolean org.keycloak.representations.IDToken.getPhoneNumberVerified ( )

inline

                                            {
        return this.phoneNumberVerified;
    }

getPicture()

String org.keycloak.representations.IDToken.getPicture ( )

inline

                               {
        return this.picture;
    }

getPreferredUsername()

String org.keycloak.representations.IDToken.getPreferredUsername ( )

inline

                                         {
        return this.preferredUsername;
    }

getProfile()

String org.keycloak.representations.IDToken.getProfile ( )

inline

                               {
        return this.profile;
    }

getSessionState()

String org.keycloak.representations.IDToken.getSessionState ( )

inline

                                    {
        return sessionState;
    }

getStateHash()

String org.keycloak.representations.IDToken.getStateHash ( )

inline

                                 {
        return stateHash;
    }

getSubject()

String org.keycloak.representations.JsonWebToken.getSubject ( )

inlineinherited

                               {
        return subject;
    }

getType()

String org.keycloak.representations.JsonWebToken.getType ( )

inlineinherited

                            {
        return type;
    }

getUpdatedAt()

Long org.keycloak.representations.IDToken.getUpdatedAt ( )

inline

                               {
        return this.updatedAt;
    }

getWebsite()

String org.keycloak.representations.IDToken.getWebsite ( )

inline

                               {
        return this.website;
    }

getZoneinfo()

String org.keycloak.representations.IDToken.getZoneinfo ( )

inline

                                {
        return this.zoneinfo;
    }

hasAudience()

boolean org.keycloak.representations.JsonWebToken.hasAudience ( String  audience )

inlineinherited

                                                {
        if (this.audience == null) return false;
        for (String a : this.audience) {
            if (a.equals(audience)) {
                return true;
            }
        }
        return false;
    }

id()

JsonWebToken org.keycloak.representations.JsonWebToken.id ( String  id )

inlineinherited

                                      {
        this.id = id;
        return this;
    }

isActive() [1/2]

boolean org.keycloak.representations.JsonWebToken.isActive ( )

inlineinherited

Tests that the token is not expired and is not-before.

戻り値

                              {
        return isActive(0);
    }

isActive() [2/2]

boolean org.keycloak.representations.JsonWebToken.isActive ( int  allowedTimeSkew )

inlineinherited

                                                 {
        return (!isExpired() || expiration == 0) && (isNotBefore(allowedTimeSkew) || notBefore == 0);
    }

isExpired()

boolean org.keycloak.representations.JsonWebToken.isExpired ( )

inlineinherited

                               {
        return Time.currentTime() > expiration;
    }

isNotBefore()

boolean org.keycloak.representations.JsonWebToken.isNotBefore ( int  allowedTimeSkew )

inlineinherited

                                                    {
        return Time.currentTime() + allowedTimeSkew >= notBefore;
    }

issuedAt()

JsonWebToken org.keycloak.representations.JsonWebToken.issuedAt ( int  issuedAt )

inlineinherited

                                               {
        this.issuedAt = issuedAt;
        return this;
    }

issuedFor()

JsonWebToken org.keycloak.representations.JsonWebToken.issuedFor ( String  issuedFor )

inlineinherited

                                                    {
        this.issuedFor = issuedFor;
        return this;
    }

issuedNow()

JsonWebToken org.keycloak.representations.JsonWebToken.issuedNow ( )

inlineinherited

Set issuedAt to the current time

                                    {
        issuedAt = Time.currentTime();
        return this;
    }

issuer()

JsonWebToken org.keycloak.representations.JsonWebToken.issuer ( String  issuer )

inlineinherited

                                              {
        this.issuer = issuer;
        return this;
    }

notBefore()

JsonWebToken org.keycloak.representations.JsonWebToken.notBefore ( int  notBefore )

inlineinherited

                                                 {
        this.notBefore = notBefore;
        return this;
    }

setAccessTokenHash()

void org.keycloak.representations.IDToken.setAccessTokenHash ( String  accessTokenHash )

inline

                                                           {
        this.accessTokenHash = accessTokenHash;
    }

setAcr()

void org.keycloak.representations.IDToken.setAcr ( String  acr )

inline

                                   {
        this.acr = acr;
    }

setAddress()

void org.keycloak.representations.IDToken.setAddress ( AddressClaimSet  address )

inline

                                                    {
        this.address = address;
    }

setAuthTime()

void org.keycloak.representations.IDToken.setAuthTime ( int  authTime )

inline

                                          {
        this.authTime = authTime;
    }

setBirthdate()

void org.keycloak.representations.IDToken.setBirthdate ( String  birthdate )

inline

                                               {
        this.birthdate = birthdate;
    }

setClaimsLocales()

void org.keycloak.representations.IDToken.setClaimsLocales ( String  claimsLocales )

inline

                                                       {
        this.claimsLocales = claimsLocales;
    }

setCodeHash()

void org.keycloak.representations.IDToken.setCodeHash ( String  codeHash )

inline

                                             {
        this.codeHash = codeHash;
    }

setEmail()

void org.keycloak.representations.IDToken.setEmail ( String  email )

inline

                                       {
        this.email = email;
    }

setEmailVerified()

void org.keycloak.representations.IDToken.setEmailVerified ( Boolean  emailVerified )

inline

                                                        {
        this.emailVerified = emailVerified;
    }

setFamilyName()

void org.keycloak.representations.IDToken.setFamilyName ( String  familyName )

inline

                                                 {
        this.familyName = familyName;
    }

setGender()

void org.keycloak.representations.IDToken.setGender ( String  gender )

inline

                                         {
        this.gender = gender;
    }

setGivenName()

void org.keycloak.representations.IDToken.setGivenName ( String  givenName )

inline

                                               {
        this.givenName = givenName;
    }

setLocale()

void org.keycloak.representations.IDToken.setLocale ( String  locale )

inline

                                         {
        this.locale = locale;
    }

setMiddleName()

void org.keycloak.representations.IDToken.setMiddleName ( String  middleName )

inline

                                                 {
        this.middleName = middleName;
    }

setName()

void org.keycloak.representations.IDToken.setName ( String  name )

inline

                                     {
        this.name = name;
    }

setNickName()

void org.keycloak.representations.IDToken.setNickName ( String  nickName )

inline

                                             {
        this.nickName = nickName;
    }

setNonce()

void org.keycloak.representations.IDToken.setNonce ( String  nonce )

inline

                                       {
        this.nonce = nonce;
    }

setOtherClaims()

void org.keycloak.representations.JsonWebToken.setOtherClaims ( String  name, Object  value  )

inlineinherited

                                                          {
        otherClaims.put(name, value);
    }

setPhoneNumber()

void org.keycloak.representations.IDToken.setPhoneNumber ( String  phoneNumber )

inline

                                                   {
        this.phoneNumber = phoneNumber;
    }

setPhoneNumberVerified()

void org.keycloak.representations.IDToken.setPhoneNumberVerified ( Boolean  phoneNumberVerified )

inline

                                                                    {
        this.phoneNumberVerified = phoneNumberVerified;
    }

setPicture()

void org.keycloak.representations.IDToken.setPicture ( String  picture )

inline

                                           {
        this.picture = picture;
    }

setPreferredUsername()

void org.keycloak.representations.IDToken.setPreferredUsername ( String  preferredUsername )

inline

                                                               {
        this.preferredUsername = preferredUsername;
    }

setProfile()

void org.keycloak.representations.IDToken.setProfile ( String  profile )

inline

                                           {
        this.profile = profile;
    }

setSessionState()

void org.keycloak.representations.IDToken.setSessionState ( String  sessionState )

inline

                                                     {
        this.sessionState = sessionState;
    }

setStateHash()

void org.keycloak.representations.IDToken.setStateHash ( String  stateHash )

inline

                                               {
        this.stateHash = stateHash;
    }

setSubject()

void org.keycloak.representations.JsonWebToken.setSubject ( String  subject )

inlineinherited

                                           {
        this.subject = subject;
    }

setUpdatedAt()

void org.keycloak.representations.IDToken.setUpdatedAt ( Long  updatedAt )

inline

                                             {
        this.updatedAt = updatedAt;
    }

setWebsite()

void org.keycloak.representations.IDToken.setWebsite ( String  website )

inline

                                           {
        this.website = website;
    }

setZoneinfo()

void org.keycloak.representations.IDToken.setZoneinfo ( String  zoneinfo )

inline

                                             {
        this.zoneinfo = zoneinfo;
    }

subject()

JsonWebToken org.keycloak.representations.JsonWebToken.subject ( String  subject )

inlineinherited

                                                {
        this.subject = subject;
        return this;
    }

type()

JsonWebToken org.keycloak.representations.JsonWebToken.type ( String  type )

inlineinherited

                                          {
        this.type = type;
        return this;
    }

メンバ詳解

accessTokenHash

String org.keycloak.representations.IDToken.accessTokenHash

protected

ACR

final String org.keycloak.representations.IDToken.ACR = "acr"

static

acr

String org.keycloak.representations.IDToken.acr

protected

ADDRESS

final String org.keycloak.representations.IDToken.ADDRESS = "address"

static

address

AddressClaimSet org.keycloak.representations.IDToken.address

protected

AT_HASH

final String org.keycloak.representations.IDToken.AT_HASH = "at_hash"

static

audience

String [] org.keycloak.representations.JsonWebToken.audience

protectedinherited

AUTH_TIME

final String org.keycloak.representations.IDToken.AUTH_TIME = "auth_time"

static

authTime

int org.keycloak.representations.IDToken.authTime

protected

BIRTHDATE

final String org.keycloak.representations.IDToken.BIRTHDATE = "birthdate"

static

birthdate

String org.keycloak.representations.IDToken.birthdate

protected

C_HASH

final String org.keycloak.representations.IDToken.C_HASH = "c_hash"

static

CLAIMS_LOCALES

final String org.keycloak.representations.IDToken.CLAIMS_LOCALES = "claims_locales"

static

claimsLocales

String org.keycloak.representations.IDToken.claimsLocales

protected

codeHash

String org.keycloak.representations.IDToken.codeHash

protected

EMAIL

final String org.keycloak.representations.IDToken.EMAIL = "email"

static

email

String org.keycloak.representations.IDToken.email

protected

EMAIL_VERIFIED

final String org.keycloak.representations.IDToken.EMAIL_VERIFIED = "email_verified"

static

emailVerified

Boolean org.keycloak.representations.IDToken.emailVerified

protected

expiration

int org.keycloak.representations.JsonWebToken.expiration

protectedinherited

FAMILY_NAME

final String org.keycloak.representations.IDToken.FAMILY_NAME = "family_name"

static

familyName

String org.keycloak.representations.IDToken.familyName

protected

GENDER

final String org.keycloak.representations.IDToken.GENDER = "gender"

static

gender

String org.keycloak.representations.IDToken.gender

protected

GIVEN_NAME

final String org.keycloak.representations.IDToken.GIVEN_NAME = "given_name"

static

givenName

String org.keycloak.representations.IDToken.givenName

protected

id

String org.keycloak.representations.JsonWebToken.id

protectedinherited

issuedAt

int org.keycloak.representations.JsonWebToken.issuedAt

protectedinherited

issuedFor

String org.keycloak.representations.JsonWebToken.issuedFor

inherited

issuer

String org.keycloak.representations.JsonWebToken.issuer

protectedinherited

LOCALE

final String org.keycloak.representations.IDToken.LOCALE = "locale"

static

locale

String org.keycloak.representations.IDToken.locale

protected

MIDDLE_NAME

final String org.keycloak.representations.IDToken.MIDDLE_NAME = "middle_name"

static

middleName

String org.keycloak.representations.IDToken.middleName

protected

NAME

final String org.keycloak.representations.IDToken.NAME = "name"

static

name

String org.keycloak.representations.IDToken.name

protected

NICKNAME

final String org.keycloak.representations.IDToken.NICKNAME = "nickname"

static

nickName

String org.keycloak.representations.IDToken.nickName

protected

NONCE

final String org.keycloak.representations.IDToken.NONCE = "nonce"

static

nonce

String org.keycloak.representations.IDToken.nonce

protected

notBefore

int org.keycloak.representations.JsonWebToken.notBefore

protectedinherited

otherClaims

Map<String, Object> org.keycloak.representations.JsonWebToken.otherClaims = new HashMap<>()

protectedinherited

PHONE_NUMBER

final String org.keycloak.representations.IDToken.PHONE_NUMBER = "phone_number"

static

PHONE_NUMBER_VERIFIED

final String org.keycloak.representations.IDToken.PHONE_NUMBER_VERIFIED = "phone_number_verified"

static

phoneNumber

String org.keycloak.representations.IDToken.phoneNumber

protected

phoneNumberVerified

Boolean org.keycloak.representations.IDToken.phoneNumberVerified

protected

PICTURE

final String org.keycloak.representations.IDToken.PICTURE = "picture"

static

picture

String org.keycloak.representations.IDToken.picture

protected

PREFERRED_USERNAME

final String org.keycloak.representations.IDToken.PREFERRED_USERNAME = "preferred_username"

static

preferredUsername

String org.keycloak.representations.IDToken.preferredUsername

protected

PROFILE

final String org.keycloak.representations.IDToken.PROFILE = "profile"

static

profile

String org.keycloak.representations.IDToken.profile

protected

S_HASH

final String org.keycloak.representations.IDToken.S_HASH = "s_hash"

static

SESSION_STATE

final String org.keycloak.representations.IDToken.SESSION_STATE = "session_state"

static

sessionState

String org.keycloak.representations.IDToken.sessionState

protected

stateHash

String org.keycloak.representations.IDToken.stateHash

protected

subject

String org.keycloak.representations.JsonWebToken.subject

protectedinherited

type

String org.keycloak.representations.JsonWebToken.type

protectedinherited

UPDATED_AT

final String org.keycloak.representations.IDToken.UPDATED_AT = "updated_at"

static

updatedAt

Long org.keycloak.representations.IDToken.updatedAt

protected

WEBSITE

final String org.keycloak.representations.IDToken.WEBSITE = "website"

static

website

String org.keycloak.representations.IDToken.website

protected

ZONEINFO

final String org.keycloak.representations.IDToken.ZONEINFO = "zoneinfo"

static

zoneinfo

String org.keycloak.representations.IDToken.zoneinfo

protected

---

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

• D:/AppData/doxygen/keycloak/src/keycloak/src/main/java/org/keycloak/representations/IDToken.java