Package com.pingidentity.sdk.token

Interface TokenRequest

All Known Implementing Classes:
GenericTokenRequest
public interface TokenRequest

  • Method Details

    • getSigningConfig

      TokenSigningConfig getSigningConfig()
      Returns the signing configuration for the token.
      Returns:
      the TokenSigningConfig

    • getJti

      default String getJti()
      Returns the JWT ID (jti) claim.
      Returns:
      the jti claim, or null if one should be generated automatically

    • getClientId

      String getClientId()
      Returns the Client ID, often used for the Issuer (iss) and Subject (sub) claims.
      Returns:
      the client ID

    • getAudience

      String getAudience()
      Returns the Audience (aud) claim.
      Returns:
      the audience

    • getLifetime

      float getLifetime()
      Returns the lifetime of the token in minutes.
      Returns:
      the lifetime in minutes

    • includeNotBeforeClaim

      boolean includeNotBeforeClaim()
      Indicates whether the Not Before (nbf) claim should be included in the token.
      Returns:
      true if the nbf claim should be included, false otherwise

    • getType

      String getType()
      Returns the Type (typ) header parameter value.
      Returns:
      the type header value

    • getClaimsOverride

      default Map<String,Object> getClaimsOverride()
      Returns a map of claims that should be added to the token. If a claim in this map conflicts with a default claim generated by the token service, the value in this map will take precedence.
      Returns:
      a map of claims to include in the token