Class IdToken.Payload

java.lang.Object
java.util.AbstractMap<String,Object>
com.google.api.client.util.GenericData
com.google.api.client.json.GenericJson
com.google.api.client.json.webtoken.JsonWebToken.Payload
com.google.api.client.auth.openidconnect.IdToken.Payload
All Implemented Interfaces:
Cloneable, Map<String,Object>
Enclosing class:
IdToken

@Beta public static class IdToken.Payload extends com.google.api.client.json.webtoken.JsonWebToken.Payload
Beta
ID token payload.
  • Field Details

    • authorizationTimeSeconds

      private Long authorizationTimeSeconds
      Time (in seconds) of end-user authorization or null for none.
    • authorizedParty

      private String authorizedParty
      Authorized party or null for none.
    • nonce

      private String nonce
      Value used to associate a client session with an ID token or null for none.
    • accessTokenHash

      private String accessTokenHash
      Access token hash value or null for none.
    • classReference

      private String classReference
      Authentication context class reference or null for none.
    • methodsReferences

      private List<String> methodsReferences
      Authentication methods references or null for none.
  • Constructor Details

    • Payload

      public Payload()
  • Method Details

    • getAuthorizationTimeSeconds

      public final Long getAuthorizationTimeSeconds()
      Returns the time (in seconds) of end-user authorization or null for none.
    • setAuthorizationTimeSeconds

      public IdToken.Payload setAuthorizationTimeSeconds(Long authorizationTimeSeconds)
      Sets the time (in seconds) of end-user authorization or null for none.

      Overriding is only supported for the purpose of calling the super implementation and changing the return type, but nothing else.

    • getAuthorizedParty

      public final String getAuthorizedParty()
      Returns the authorized party or null for none.

      Upgrade warning: in prior version 1.15 this method returned an Object, but starting with version 1.16 it returns a String.

    • setAuthorizedParty

      public IdToken.Payload setAuthorizedParty(String authorizedParty)
      Sets the authorized party or null for none.

      Overriding is only supported for the purpose of calling the super implementation and changing the return type, but nothing else.

      Upgrade warning: in prior version 1.15 the parameter was an Object, but starting with version 1.16 the parameter is a String.

    • getNonce

      public final String getNonce()
      Returns the value used to associate a client session with an ID token or null for none.
      Since:
      1.16
    • setNonce

      public IdToken.Payload setNonce(String nonce)
      Sets the value used to associate a client session with an ID token or null for none.

      Overriding is only supported for the purpose of calling the super implementation and changing the return type, but nothing else.

      Since:
      1.16
    • getAccessTokenHash

      public final String getAccessTokenHash()
      Returns the access token hash value or null for none.
      Since:
      1.16
    • setAccessTokenHash

      public IdToken.Payload setAccessTokenHash(String accessTokenHash)
      Sets the access token hash value or null for none.

      Overriding is only supported for the purpose of calling the super implementation and changing the return type, but nothing else.

      Since:
      1.16
    • getClassReference

      public final String getClassReference()
      Returns the authentication context class reference or null for none.
      Since:
      1.16
    • setClassReference

      public IdToken.Payload setClassReference(String classReference)
      Sets the authentication context class reference or null for none.

      Overriding is only supported for the purpose of calling the super implementation and changing the return type, but nothing else.

      Since:
      1.16
    • getMethodsReferences

      public final List<String> getMethodsReferences()
      Returns the authentication methods references or null for none.
      Since:
      1.16
    • setMethodsReferences

      public IdToken.Payload setMethodsReferences(List<String> methodsReferences)
      Sets the authentication methods references or null for none.

      Overriding is only supported for the purpose of calling the super implementation and changing the return type, but nothing else.

      Since:
      1.16
    • setExpirationTimeSeconds

      public IdToken.Payload setExpirationTimeSeconds(Long expirationTimeSeconds)
      Overrides:
      setExpirationTimeSeconds in class com.google.api.client.json.webtoken.JsonWebToken.Payload
    • setNotBeforeTimeSeconds

      public IdToken.Payload setNotBeforeTimeSeconds(Long notBeforeTimeSeconds)
      Overrides:
      setNotBeforeTimeSeconds in class com.google.api.client.json.webtoken.JsonWebToken.Payload
    • setIssuedAtTimeSeconds

      public IdToken.Payload setIssuedAtTimeSeconds(Long issuedAtTimeSeconds)
      Overrides:
      setIssuedAtTimeSeconds in class com.google.api.client.json.webtoken.JsonWebToken.Payload
    • setIssuer

      public IdToken.Payload setIssuer(String issuer)
      Overrides:
      setIssuer in class com.google.api.client.json.webtoken.JsonWebToken.Payload
    • setAudience

      public IdToken.Payload setAudience(Object audience)
      Overrides:
      setAudience in class com.google.api.client.json.webtoken.JsonWebToken.Payload
    • setJwtId

      public IdToken.Payload setJwtId(String jwtId)
      Overrides:
      setJwtId in class com.google.api.client.json.webtoken.JsonWebToken.Payload
    • setType

      public IdToken.Payload setType(String type)
      Overrides:
      setType in class com.google.api.client.json.webtoken.JsonWebToken.Payload
    • setSubject

      public IdToken.Payload setSubject(String subject)
      Overrides:
      setSubject in class com.google.api.client.json.webtoken.JsonWebToken.Payload
    • set

      public IdToken.Payload set(String fieldName, Object value)
      Overrides:
      set in class com.google.api.client.json.webtoken.JsonWebToken.Payload
    • clone

      public IdToken.Payload clone()
      Overrides:
      clone in class com.google.api.client.json.webtoken.JsonWebToken.Payload