Serialized Form (com.authlete:authlete-java-common 3.16 API)

Package com.authlete.common.api
- Class com.authlete.common.api.AuthleteApiException extends RuntimeException implements Serializable
  
  serialVersionUID:
  
  1L
  - Serialized Fields
    - mStatusCode
```
int mStatusCode
```
      HTTP status code. May be 0.
    - mStatusMessage
```
String mStatusMessage
```
      HTTP status message. May be null.
    - mResponseBody
```
String mResponseBody
```
      HTTP response body. May be null.
    - mResponseHeaders
```
Map<K,V> mResponseHeaders
```
      HTTP response headers. May be null.
Package com.authlete.common.assurance
- Class com.authlete.common.assurance.Claims extends LinkedHashMap<String,Object> implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.authlete.common.assurance.Document extends LinkedHashMap<String,Object> implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.authlete.common.assurance.Evidence extends LinkedHashMap<String,Object> implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.authlete.common.assurance.EvidenceArray extends ArrayList<Evidence> implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.authlete.common.assurance.IDDocument extends Evidence implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.authlete.common.assurance.IdentityAssuranceException extends RuntimeException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.authlete.common.assurance.Issuer extends LinkedHashMap<String,Object> implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.authlete.common.assurance.Provider extends LinkedHashMap<String,Object> implements Serializable
  
  serialVersionUID:
  
  2L
- Class com.authlete.common.assurance.QES extends Evidence implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.authlete.common.assurance.UtilityBill extends Evidence implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.authlete.common.assurance.Verification extends LinkedHashMap<String,Object> implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.authlete.common.assurance.VerifiedClaims extends LinkedHashMap<String,Object> implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.authlete.common.assurance.Verifier extends LinkedHashMap<String,Object> implements Serializable
  
  serialVersionUID:
  
  1L
Package com.authlete.common.assurance.constraint
- Class com.authlete.common.assurance.constraint.ClaimsConstraint extends LinkedHashMap<String,VerifiedClaimConstraint> implements Serializable
  
  serialVersionUID:
  
  2L
  - Serialized Fields
    - exists
```
boolean exists
```
    - isNull
```
boolean isNull
```
- Class com.authlete.common.assurance.constraint.ConstraintException extends RuntimeException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.authlete.common.assurance.constraint.EvidenceArrayConstraint extends ArrayList<EvidenceConstraint> implements Serializable
  
  serialVersionUID:
  
  1L
  - Serialized Fields
    - exists
```
boolean exists
```
    - isNull
```
boolean isNull
```
Package com.authlete.common.dto
- Class com.authlete.common.dto.AccessToken extends Object implements Serializable
  
  serialVersionUID:
  
  1L
  - Serialized Fields
    - accessTokenHash
```
String accessTokenHash
```
    - refreshTokenHash
```
String refreshTokenHash
```
    - clientId
```
long clientId
```
    - subject
```
String subject
```
    - grantType
```
GrantType grantType
```
    - scopes
```
String[] scopes
```
    - accessTokenExpiresAt
```
long accessTokenExpiresAt
```
    - refreshTokenExpiresAt
```
long refreshTokenExpiresAt
```
    - createdAt
```
long createdAt
```
    - lastRefreshedAt
```
long lastRefreshedAt
```
    - properties
```
Property[] properties
```
- Class com.authlete.common.dto.Address extends Object implements Serializable
  
  serialVersionUID:
  
  1L
  - Serialized Fields
    - formatted
```
String formatted
```
    - street_address
```
String street_address
```
    - locality
```
String locality
```
    - region
```
String region
```
    - postal_code
```
String postal_code
```
    - country
```
String country
```
- Class com.authlete.common.dto.ApiResponse extends Object implements Serializable
  
  serialVersionUID:
  
  1L
  - Serialized Fields
    - resultCode
```
String resultCode
```
    - resultMessage
```
String resultMessage
```
- Class com.authlete.common.dto.AuthenticationCallbackRequest extends Object implements Serializable
  
  serialVersionUID:
  
  3L
  - Serialized Fields
    - serviceApiKey
```
long serviceApiKey
```
    - clientId
```
long clientId
```
    - id
```
String id
```
    - password
```
String password
```
    - claims
```
String[] claims
```
    - claimsLocales
```
String[] claimsLocales
```
    - sns
```
Sns sns
```
    - accessToken
```
String accessToken
```
    - refreshToken
```
String refreshToken
```
    - expiresIn
```
long expiresIn
```
    - rawTokenResponse
```
String rawTokenResponse
```
- Class com.authlete.common.dto.AuthenticationCallbackResponse extends Object implements Serializable
  
  serialVersionUID:
  
  3L
  - Serialized Fields
    - authenticated
```
boolean authenticated
```
    - subject
```
String subject
```
    - claims
```
String claims
```
- Class com.authlete.common.dto.AuthorizationAuthenticateRequest extends Object implements Serializable
  
  serialVersionUID:
  
  2L
  - Serialized Fields
    - ticket
```
String ticket
```
      The ticket issued by Authlete's /auth/authorization API.
    - loginId
```
String loginId
```
      The login ID of the end-user to authenticate.
    - password
```
String password
```
      The password of the end-user to authenticate.
    - claims
```
String claims
```
      The claims to request.
    - claimsLocales
```
String claimsLocales
```
      Locales for claims.
- Class com.authlete.common.dto.AuthorizationAuthenticateResponse extends ApiResponse implements Serializable
  
  serialVersionUID:
  
  2L
  - Serialized Fields
    - action
```
AuthorizationAuthenticateResponse.Action action
```
    - authenticated
```
boolean authenticated
```
    - responseContent
```
String responseContent
```
- Class com.authlete.common.dto.AuthorizationFailRequest extends Object implements Serializable
  
  serialVersionUID:
  
  3L
  - Serialized Fields
    - ticket
```
String ticket
```
      The ticket issued by Authlete's /auth/authorization API.
    - reason
```
AuthorizationFailRequest.Reason reason
```
      The reason of the failure.
    - description
```
String description
```
      The custom description about the failure.
- Class com.authlete.common.dto.AuthorizationFailResponse extends ApiResponse implements Serializable
  
  serialVersionUID:
  
  1L
  - Serialized Fields
    - action
```
AuthorizationFailResponse.Action action
```
    - responseContent
```
String responseContent
```
- Class com.authlete.common.dto.AuthorizationIssueRequest extends Object implements Serializable
  
  serialVersionUID:
  
  12L
  - Serialized Fields
    - ticket
```
String ticket
```
      The ticket issued by Authlete's endpoint.
    - subject
```
String subject
```
      The subject (end-user) managed by the service.
    - sub
```
String sub
```
      The value of the 'sub' claim in an ID token. When this field is empty, 'subject' is used.
    - authTime
```
long authTime
```
      The time when the end-user was authenticated.
    - acr
```
String acr
```
      The authentication context class reference.
    - claims
```
String claims
```
      Claims in JSON format.
    - properties
```
Property[] properties
```
      Extra properties to associate with an access token and/or an authorization code.
    - scopes
```
String[] scopes
```
      Scopes to associate with an access token and/or an authorization code. If this field is null, the scopes specified in the original authorization request from the client application are used. In other cases, including the case of an empty array, the scopes here will replace the original scopes contained in the original request.
    - idtHeaderParams
```
String idtHeaderParams
```
      JSON that represents additional JWS header parameters for ID tokens that may be issued based on the authorization request.
      
      Since:
      
      2.76
    - authorizationDetails
```
AuthzDetails authorizationDetails
```
      The authorization details to associate with the access token.
    - consentedClaims
```
String[] consentedClaims
```
      Claims that the user has consented for the client application to know.
      
      Since:
      
      3.7
    - claimsForTx
```
String claimsForTx
```
      Claim key-value pairs that are used to compute values of transformed claims. The format is JSON.
      
      Since:
      
      3.8
    - verifiedClaimsForTx
```
String[] verifiedClaimsForTx
```
      Verified claim key-value pairs that are used to compute values of transformed claims. The format of each element is JSON.
      
      Since:
      
      3.8
- Class com.authlete.common.dto.AuthorizationIssueResponse extends ApiResponse implements Serializable
  
  serialVersionUID:
  
  3L
  - Serialized Fields
    - action
```
AuthorizationIssueResponse.Action action
```
    - responseContent
```
String responseContent
```
    - accessToken
```
String accessToken
```
    - accessTokenExpiresAt
```
long accessTokenExpiresAt
```
    - accessTokenDuration
```
long accessTokenDuration
```
    - idToken
```
String idToken
```
    - authorizationCode
```
String authorizationCode
```
    - jwtAccessToken
```
String jwtAccessToken
```
- Class com.authlete.common.dto.AuthorizationRequest extends Object implements Serializable
  
  serialVersionUID:
  
  2L
  - Serialized Fields
    - parameters
```
String parameters
```
      OAuth 2.0 authorization request parameters.
- Class com.authlete.common.dto.AuthorizationResponse extends ApiResponse implements Serializable
  
  serialVersionUID:
  
  17L
  - Serialized Fields
    - action
```
AuthorizationResponse.Action action
```
    - service
```
Service service
```
    - client
```
Client client
```
    - display
```
Display display
```
    - maxAge
```
int maxAge
```
    - scopes
```
Scope[] scopes
```
    - dynamicScopes
```
DynamicScope[] dynamicScopes
```
    - uiLocales
```
String[] uiLocales
```
    - claimsLocales
```
String[] claimsLocales
```
    - claims
```
String[] claims
```
    - acrEssential
```
boolean acrEssential
```
    - clientIdAliasUsed
```
boolean clientIdAliasUsed
```
    - acrs
```
String[] acrs
```
    - subject
```
String subject
```
    - loginHint
```
String loginHint
```
    - lowestPrompt
```
Prompt lowestPrompt
```
    - prompts
```
Prompt[] prompts
```
    - requestObjectPayload
```
String requestObjectPayload
```
    - idTokenClaims
```
String idTokenClaims
```
    - userInfoClaims
```
String userInfoClaims
```
    - transformedClaims
```
String transformedClaims
```
    - resources
```
URI[] resources
```
    - authorizationDetails
```
AuthzDetails authorizationDetails
```
    - purpose
```
String purpose
```
    - gmAction
```
GMAction gmAction
```
    - grantId
```
String grantId
```
    - grantSubject
```
String grantSubject
```
    - grant
```
Grant grant
```
    - requestedClaimsForTx
```
String[] requestedClaimsForTx
```
    - requestedVerifiedClaimsForTx
```
StringArray[] requestedVerifiedClaimsForTx
```
    - responseContent
```
String responseContent
```
    - ticket
```
String ticket
```
- Class com.authlete.common.dto.AuthorizedClientListResponse extends ClientListResponse implements Serializable
  
  serialVersionUID:
  
  1L
  - Serialized Fields
    - subject
```
String subject
```
      The identifier of the user who has granted authorization to the client applications.
- Class com.authlete.common.dto.AuthzDetails extends Object implements Serializable
  
  serialVersionUID:
  
  1L
  - Serialized Fields
    - elements
```
AuthzDetailsElement[] elements
```
- Class com.authlete.common.dto.AuthzDetailsElement extends Object implements Serializable
  
  serialVersionUID:
  
  4L
  - Serialized Fields
    - type
```
String type
```
    - locations
```
String[] locations
```
    - actions
```
String[] actions
```
    - dataTypes
```
String[] dataTypes
```
    - identifier
```
String identifier
```
    - privileges
```
String[] privileges
```
    - otherFields
```
String otherFields
```
- Class com.authlete.common.dto.BackchannelAuthenticationCompleteRequest extends Object implements Serializable
  
  serialVersionUID:
  
  4L
  - Serialized Fields
    - ticket
```
String ticket
```
      The ticket issued by Authlete's /api/backchannel/authentication API.
    - result
```
BackchannelAuthenticationCompleteRequest.Result result
```
      The result of the end-user authentication and authorization.
    - subject
```
String subject
```
      The subject (= unique identifier) of the end-user.
    - sub
```
String sub
```
      The value of the sub claim for the ID token. When this field is empty, subject is used as the value of the sub claim.
    - authTime
```
long authTime
```
      The time at which the end-user was authenticated.
    - acr
```
String acr
```
      The authentication context class reference.
    - claims
```
String claims
```
      Additional claims in JSON format.
    - properties
```
Property[] properties
```
      Extra properties associated with the access token.
    - scopes
```
String[] scopes
```
      Scopes associated with the access token. If this field is null, the scopes specified in the original backchannel authentication request are used. In other cases, the scopes here will replace the original scopes contained in the original request.
    - idtHeaderParams
```
String idtHeaderParams
```
      JSON that represents additional JWS header parameters for the ID token.
      
      Since:
      
      2.79
    - consentedClaims
```
String[] consentedClaims
```
      Claims that the user has consented for the client application to know.
      
      Since:
      
      3.7
    - errorDescription
```
String errorDescription
```
      The description of the error. This property is referred to when the result is not AUTHORIZED.
    - errorUri
```
URI errorUri
```
      The URI of a document which describes the error in detail. This property is referred to when the result is not AUTHORIZED.
- Class com.authlete.common.dto.BackchannelAuthenticationCompleteResponse extends ApiResponse implements Serializable
  
  serialVersionUID:
  
  7L
  - Serialized Fields
    - action
```
BackchannelAuthenticationCompleteResponse.Action action
```
    - responseContent
```
String responseContent
```
    - clientId
```
long clientId
```
    - clientIdAlias
```
String clientIdAlias
```
    - clientIdAliasUsed
```
boolean clientIdAliasUsed
```
    - clientName
```
String clientName
```
    - deliveryMode
```
DeliveryMode deliveryMode
```
    - clientNotificationEndpoint
```
URI clientNotificationEndpoint
```
    - clientNotificationToken
```
String clientNotificationToken
```
    - authReqId
```
String authReqId
```
    - accessToken
```
String accessToken
```
    - refreshToken
```
String refreshToken
```
    - idToken
```
String idToken
```
    - accessTokenDuration
```
long accessTokenDuration
```
    - refreshTokenDuration
```
long refreshTokenDuration
```
    - idTokenDuration
```
long idTokenDuration
```
    - jwtAccessToken
```
String jwtAccessToken
```
    - resources
```
URI[] resources
```
    - authorizationDetails
```
AuthzDetails authorizationDetails
```
    - grantId
```
String grantId
```
    - serviceAttributes
```
Pair[] serviceAttributes
```
    - clientAttributes
```
Pair[] clientAttributes
```
- Class com.authlete.common.dto.BackchannelAuthenticationFailRequest extends Object implements Serializable
  
  serialVersionUID:
  
  3L
  - Serialized Fields
    - ticket
```
String ticket
```
    - reason
```
BackchannelAuthenticationFailRequest.Reason reason
```
    - errorDescription
```
String errorDescription
```
    - errorUri
```
URI errorUri
```
- Class com.authlete.common.dto.BackchannelAuthenticationFailResponse extends ApiResponse implements Serializable
  
  serialVersionUID:
  
  1L
  - Serialized Fields
    - action
```
BackchannelAuthenticationFailResponse.Action action
```
    - responseContent
```
String responseContent
```
- Class com.authlete.common.dto.BackchannelAuthenticationIssueRequest extends Object implements Serializable
  
  serialVersionUID:
  
  1L
  - Serialized Fields
    - ticket
```
String ticket
```
      The ticket issued by Authlete's /api/backchannel/authentication API.
- Class com.authlete.common.dto.BackchannelAuthenticationIssueResponse extends ApiResponse implements Serializable
  
  serialVersionUID:
  
  1L
  - Serialized Fields
    - action
```
BackchannelAuthenticationIssueResponse.Action action
```
    - responseContent
```
String responseContent
```
    - authReqId
```
String authReqId
```
    - expiresIn
```
int expiresIn
```
    - interval
```
int interval
```
- Class com.authlete.common.dto.BackchannelAuthenticationRequest extends Object implements Serializable
  
  serialVersionUID:
  
  1L
  - Serialized Fields
    - parameters
```
String parameters
```
      Request parameters of a backchannel authentication request.
    - clientId
```
String clientId
```
      Client ID extracted from Authorization header.
    - clientSecret
```
String clientSecret
```
      Client secret extracted from Authorization header.
    - clientCertificate
```
String clientCertificate
```
      Client certificate.
    - clientCertificatePath
```
String[] clientCertificatePath
```
      Client certificate path.
- Class com.authlete.common.dto.BackchannelAuthenticationResponse extends ApiResponse implements Serializable
  
  serialVersionUID:
  
  10L
  - Serialized Fields
    - action
```
BackchannelAuthenticationResponse.Action action
```
    - responseContent
```
String responseContent
```
    - clientId
```
long clientId
```
    - clientIdAlias
```
String clientIdAlias
```
    - clientIdAliasUsed
```
boolean clientIdAliasUsed
```
    - clientName
```
String clientName
```
    - clientAuthMethod
```
ClientAuthMethod clientAuthMethod
```
    - deliveryMode
```
DeliveryMode deliveryMode
```
    - scopes
```
Scope[] scopes
```
    - dynamicScopes
```
DynamicScope[] dynamicScopes
```
    - claimNames
```
String[] claimNames
```
    - clientNotificationToken
```
String clientNotificationToken
```
    - acrs
```
String[] acrs
```
    - hintType
```
UserIdentificationHintType hintType
```
    - hint
```
String hint
```
    - sub
```
String sub
```
    - bindingMessage
```
String bindingMessage
```
    - userCode
```
String userCode
```
    - userCodeRequired
```
boolean userCodeRequired
```
    - requestedExpiry
```
int requestedExpiry
```
    - requestContext
```
String requestContext
```
    - resources
```
URI[] resources
```
    - authorizationDetails
```
AuthzDetails authorizationDetails
```
    - gmAction
```
GMAction gmAction
```
    - grantId
```
String grantId
```
    - grantSubject
```
String grantSubject
```
    - grant
```
Grant grant
```
    - serviceAttributes
```
Pair[] serviceAttributes
```
    - clientAttributes
```
Pair[] clientAttributes
```
    - warnings
```
String[] warnings
```
    - ticket
```
String ticket
```
- Class com.authlete.common.dto.Client extends Object implements Serializable
  
  serialVersionUID:
  
  24L
  - Serialized Fields
    - number
```
int number
```
      Client number.
    - serviceNumber
```
int serviceNumber
```
      Service number.
    - developer
```
String developer
```
      Developer unique ID.
    - clientId
```
long clientId
```
      Client ID.
    - clientIdAlias
```
String clientIdAlias
```
      Alias of Client ID.
    - clientIdAliasEnabled
```
boolean clientIdAliasEnabled
```
      True when the client ID alias is enabled.
    - clientSecret
```
String clientSecret
```
      Client secret.
    - clientType
```
ClientType clientType
```
      Client type.
    - redirectUris
```
String[] redirectUris
```
      Redirect URIs.
    - responseTypes
```
ResponseType[] responseTypes
```
      Response types.
    - grantTypes
```
GrantType[] grantTypes
```
      Grant types.
    - applicationType
```
ApplicationType applicationType
```
      Application type.
    - contacts
```
String[] contacts
```
      Email addresses of contacts.
    - clientName
```
String clientName
```
      Client name.
    - clientNames
```
TaggedValue[] clientNames
```
      Client names.
    - logoUri
```
URI logoUri
```
      Logo URI.
    - logoUris
```
TaggedValue[] logoUris
```
      Logo URIs.
    - clientUri
```
URI clientUri
```
      Client URI.
    - clientUris
```
TaggedValue[] clientUris
```
      Client URIs.
    - policyUri
```
URI policyUri
```
      Policy URI.
    - policyUris
```
TaggedValue[] policyUris
```
      Policy URIs.
    - tosUri
```
URI tosUri
```
      Terms of Service URI.
    - tosUris
```
TaggedValue[] tosUris
```
      Terms of Service URIs.
    - jwksUri
```
URI jwksUri
```
      JSON Web Key Set URI.
    - jwks
```
String jwks
```
      JSON Web Key Set.
    - derivedSectorIdentifier
```
String derivedSectorIdentifier
```
      Calculated sector identifier host component
      
      Since:
      
      2.61
    - sectorIdentifierUri
```
URI sectorIdentifierUri
```
      Sector identifier URI.
      
      Since:
      
      2.50
    - subjectType
```
SubjectType subjectType
```
    - idTokenSignAlg
```
JWSAlg idTokenSignAlg
```
    - idTokenEncryptionAlg
```
JWEAlg idTokenEncryptionAlg
```
    - idTokenEncryptionEnc
```
JWEEnc idTokenEncryptionEnc
```
    - userInfoSignAlg
```
JWSAlg userInfoSignAlg
```
    - userInfoEncryptionAlg
```
JWEAlg userInfoEncryptionAlg
```
    - userInfoEncryptionEnc
```
JWEEnc userInfoEncryptionEnc
```
    - requestSignAlg
```
JWSAlg requestSignAlg
```
    - requestEncryptionAlg
```
JWEAlg requestEncryptionAlg
```
    - requestEncryptionEnc
```
JWEEnc requestEncryptionEnc
```
    - tokenAuthMethod
```
ClientAuthMethod tokenAuthMethod
```
    - tokenAuthSignAlg
```
JWSAlg tokenAuthSignAlg
```
    - defaultMaxAge
```
int defaultMaxAge
```
    - defaultAcrs
```
String[] defaultAcrs
```
    - authTimeRequired
```
boolean authTimeRequired
```
    - loginUri
```
URI loginUri
```
    - requestUris
```
String[] requestUris
```
    - description
```
String description
```
    - descriptions
```
TaggedValue[] descriptions
```
    - createdAt
```
long createdAt
```
    - modifiedAt
```
long modifiedAt
```
    - extension
```
ClientExtension extension
```
    - tlsClientAuthSubjectDn
```
String tlsClientAuthSubjectDn
```
    - tlsClientAuthSanDns
```
String tlsClientAuthSanDns
```
    - tlsClientAuthSanUri
```
URI tlsClientAuthSanUri
```
    - tlsClientAuthSanIp
```
String tlsClientAuthSanIp
```
    - tlsClientAuthSanEmail
```
String tlsClientAuthSanEmail
```
    - tlsClientCertificateBoundAccessTokens
```
boolean tlsClientCertificateBoundAccessTokens
```
    - selfSignedCertificateKeyId
```
String selfSignedCertificateKeyId
```
    - softwareId
```
String softwareId
```
    - softwareVersion
```
String softwareVersion
```
    - authorizationSignAlg
```
JWSAlg authorizationSignAlg
```
    - authorizationEncryptionAlg
```
JWEAlg authorizationEncryptionAlg
```
    - authorizationEncryptionEnc
```
JWEEnc authorizationEncryptionEnc
```
    - bcDeliveryMode
```
DeliveryMode bcDeliveryMode
```
    - bcNotificationEndpoint
```
URI bcNotificationEndpoint
```
    - bcRequestSignAlg
```
JWSAlg bcRequestSignAlg
```
    - bcUserCodeRequired
```
boolean bcUserCodeRequired
```
    - dynamicallyRegistered
```
boolean dynamicallyRegistered
```
    - registrationAccessTokenHash
```
String registrationAccessTokenHash
```
    - authorizationDetailsTypes
```
String[] authorizationDetailsTypes
```
    - parRequired
```
boolean parRequired
```
    - requestObjectRequired
```
boolean requestObjectRequired
```
    - attributes
```
Pair[] attributes
```
    - customMetadata
```
String customMetadata
```
    - frontChannelRequestObjectEncryptionRequired
```
boolean frontChannelRequestObjectEncryptionRequired
```
    - requestObjectEncryptionAlgMatchRequired
```
boolean requestObjectEncryptionAlgMatchRequired
```
    - requestObjectEncryptionEncMatchRequired
```
boolean requestObjectEncryptionEncMatchRequired
```
    - digestAlgorithm
```
String digestAlgorithm
```
- Class com.authlete.common.dto.ClientAuthorizationDeleteRequest extends Object implements Serializable
  
  serialVersionUID:
  
  1L
  - Serialized Fields
    - subject
```
String subject
```
- Class com.authlete.common.dto.ClientAuthorizationGetListRequest extends Object implements Serializable
  
  serialVersionUID:
  
  1L
  - Serialized Fields
    - subject
```
String subject
```
    - developer
```
String developer
```
    - start
```
int start
```
    - end
```
int end
```
- Class com.authlete.common.dto.ClientAuthorizationUpdateRequest extends Object implements Serializable
  
  serialVersionUID:
  
  1L
  - Serialized Fields
    - subject
```
String subject
```
    - scopes
```
String[] scopes
```
- Class com.authlete.common.dto.ClientExtension extends Object implements Serializable
  
  serialVersionUID:
  
  4L
  - Serialized Fields
    - requestableScopesEnabled
```
boolean requestableScopesEnabled
```
    - requestableScopes
```
String[] requestableScopes
```
    - accessTokenDuration
```
long accessTokenDuration
```
    - refreshTokenDuration
```
long refreshTokenDuration
```
- Class com.authlete.common.dto.ClientListResponse extends Object implements Serializable
  
  serialVersionUID:
  
  1L
  - Serialized Fields
    - start
```
int start
```
      The start index (inclusive) for the result set of the query.
    - end
```
int end
```
      The end index (exclusive) for the result set of the query.
    - developer
```
String developer
```
      The developer of the targeted client applications.
    - totalCount
```
int totalCount
```
      The total count of client applications.
    - clients
```
Client[] clients
```
      The client list extracted from the database.
- Class com.authlete.common.dto.ClientLockFlagUpdateRequest extends Object implements Serializable
  
  serialVersionUID:
  
  1L
  - Serialized Fields
    - clientLocked
```
boolean clientLocked
```
- Class com.authlete.common.dto.ClientRegistrationRequest extends Object implements Serializable
  
  serialVersionUID:
  
  1L
  - Serialized Fields
    - json
```
String json
```
      Metadata in JSON format that complies with RFC 7591.
    - token
```
String token
```
      The client registration access token. Used only for GET, UPDATE, and DELETE requests.
    - clientId
```
String clientId
```
      The client's identifier. Used for GET, UPDATE, and DELETE requests.
- Class com.authlete.common.dto.ClientRegistrationResponse extends ApiResponse implements Serializable
  
  serialVersionUID:
  
  2L
  - Serialized Fields
    - action
```
ClientRegistrationResponse.Action action
```
    - responseContent
```
String responseContent
```
    - client
```
Client client
```
- Class com.authlete.common.dto.ClientSecretRefreshResponse extends ApiResponse implements Serializable
  
  serialVersionUID:
  
  1L
  - Serialized Fields
    - newClientSecret
```
String newClientSecret
```
    - oldClientSecret
```
String oldClientSecret
```
- Class com.authlete.common.dto.ClientSecretUpdateRequest extends Object implements Serializable
  
  serialVersionUID:
  
  1L
  - Serialized Fields
    - clientSecret
```
String clientSecret
```
- Class com.authlete.common.dto.ClientSecretUpdateResponse extends ApiResponse implements Serializable
  
  serialVersionUID:
  
  1L
  - Serialized Fields
    - newClientSecret
```
String newClientSecret
```
    - oldClientSecret
```
String oldClientSecret
```
- Class com.authlete.common.dto.DeveloperAuthenticationCallbackRequest extends Object implements Serializable
  
  serialVersionUID:
  
  1L
  - Serialized Fields
    - serviceApiKey
```
long serviceApiKey
```
    - id
```
String id
```
    - password
```
String password
```
    - sns
```
Sns sns
```
    - accessToken
```
String accessToken
```
    - refreshToken
```
String refreshToken
```
    - expiresIn
```
long expiresIn
```
    - rawTokenResponse
```
String rawTokenResponse
```
- Class com.authlete.common.dto.DeveloperAuthenticationCallbackResponse extends Object implements Serializable
  
  serialVersionUID:
  
  3L
  - Serialized Fields
    - authenticated
```
boolean authenticated
```
    - subject
```
String subject
```
    - displayName
```
String displayName
```
- Class com.authlete.common.dto.DeviceAuthorizationRequest extends Object implements Serializable
  
  serialVersionUID:
  
  1L
  - Serialized Fields
    - parameters
```
String parameters
```
      Request parameters of a device authorization request.
    - clientId
```
String clientId
```
      Client ID extracted from Authorization header.
    - clientSecret
```
String clientSecret
```
      Client secret extracted from Authorization header.
    - clientCertificate
```
String clientCertificate
```
      Client certificate.
    - clientCertificatePath
```
String[] clientCertificatePath
```
      Client certificate path.
- Class com.authlete.common.dto.DeviceAuthorizationResponse extends ApiResponse implements Serializable
  
  serialVersionUID:
  
  8L
  - Serialized Fields
    - action
```
DeviceAuthorizationResponse.Action action
```
    - responseContent
```
String responseContent
```
    - clientId
```
long clientId
```
    - clientIdAlias
```
String clientIdAlias
```
    - clientIdAliasUsed
```
boolean clientIdAliasUsed
```
    - clientName
```
String clientName
```
    - clientAuthMethod
```
ClientAuthMethod clientAuthMethod
```
    - scopes
```
Scope[] scopes
```
    - dynamicScopes
```
DynamicScope[] dynamicScopes
```
    - claimNames
```
String[] claimNames
```
    - acrs
```
String[] acrs
```
    - deviceCode
```
String deviceCode
```
    - userCode
```
String userCode
```
    - verificationUri
```
URI verificationUri
```
    - verificationUriComplete
```
URI verificationUriComplete
```
    - expiresIn
```
int expiresIn
```
    - interval
```
int interval
```
    - resources
```
URI[] resources
```
    - authorizationDetails
```
AuthzDetails authorizationDetails
```
    - gmAction
```
GMAction gmAction
```
    - grantId
```
String grantId
```
    - grantSubject
```
String grantSubject
```
    - grant
```
Grant grant
```
    - serviceAttributes
```
Pair[] serviceAttributes
```
    - clientAttributes
```
Pair[] clientAttributes
```
    - warnings
```
String[] warnings
```
- Class com.authlete.common.dto.DeviceCompleteRequest extends Object implements Serializable
  
  serialVersionUID:
  
  4L
  - Serialized Fields
    - userCode
```
String userCode
```
      The user code input by the end-user.
    - result
```
DeviceCompleteRequest.Result result
```
      The result of the end-user authentication and authorization.
    - subject
```
String subject
```
      The subject (= unique identifier) of the end-user.
    - sub
```
String sub
```
      The value of the sub claim for the ID token. When this field is empty, subject is used as the value of the sub claim.
      
      Since:
      
      2.44
    - authTime
```
long authTime
```
      The time at which the end-user was authenticated.
      
      Since:
      
      2.44
    - acr
```
String acr
```
      The authentication context class reference.
      
      Since:
      
      2.44
    - claims
```
String claims
```
      Additional claims in JSON format.
      
      Since:
      
      2.44
    - properties
```
Property[] properties
```
      Extra properties associated with the access token.
    - scopes
```
String[] scopes
```
      Scopes associated with the access token. If this field is null, the scopes specified in the original device authorization request are used. In other cases, the scopes here will replace the original scopes contained in the original request.
    - idtHeaderParams
```
String idtHeaderParams
```
      JSON that represents additional JWS header parameters for the ID token which may be issued from the token endpoint.
      
      Since:
      
      2.79
    - consentedClaims
```
String[] consentedClaims
```
      Claims that the user has consented for the client application to know.
      
      Since:
      
      3.7
    - errorDescription
```
String errorDescription
```
      The description of the error. This property is referred to when the result is not AUTHORIZED.
    - errorUri
```
URI errorUri
```
      The URI of a document which describes the error in detail. This property is referred to when the result is not AUTHORIZED.
- Class com.authlete.common.dto.DeviceCompleteResponse extends ApiResponse implements Serializable
  
  serialVersionUID:
  
  1L
  - Serialized Fields
    - action
```
DeviceCompleteResponse.Action action
```
- Class com.authlete.common.dto.DeviceVerificationRequest extends Object implements Serializable
  
  serialVersionUID:
  
  1L
  - Serialized Fields
    - userCode
```
String userCode
```
      The user code.
- Class com.authlete.common.dto.DeviceVerificationResponse extends ApiResponse implements Serializable
  
  serialVersionUID:
  
  8L
  - Serialized Fields
    - action
```
DeviceVerificationResponse.Action action
```
    - clientId
```
long clientId
```
    - clientIdAlias
```
String clientIdAlias
```
    - clientIdAliasUsed
```
boolean clientIdAliasUsed
```
    - clientName
```
String clientName
```
    - scopes
```
Scope[] scopes
```
    - dynamicScopes
```
DynamicScope[] dynamicScopes
```
    - claimNames
```
String[] claimNames
```
    - acrs
```
String[] acrs
```
    - expiresAt
```
long expiresAt
```
    - resources
```
URI[] resources
```
    - authorizationDetails
```
AuthzDetails authorizationDetails
```
    - gmAction
```
GMAction gmAction
```
    - grantId
```
String grantId
```
    - grantSubject
```
String grantSubject
```
    - grant
```
Grant grant
```
    - serviceAttributes
```
Pair[] serviceAttributes
```
    - clientAttributes
```
Pair[] clientAttributes
```
- Class com.authlete.common.dto.DynamicScope extends Object implements Serializable
  
  serialVersionUID:
  
  1L
  - Serialized Fields
    - name
```
String name
```
      Scope name.
    - value
```
String value
```
      Scope value.
- Class com.authlete.common.dto.GMRequest extends Object implements Serializable
  
  serialVersionUID:
  
  1L
  - Serialized Fields
    - gmAction
```
GMAction gmAction
```
      A grant management action; either QUERY or REVOKE.
    - grantId
```
String grantId
```
      The grant ID.
    - accessToken
```
String accessToken
```
      The access token.
    - clientCertificate
```
String clientCertificate
```
      The client certificate used in the TLS connection established between the client application and the grant management endpoint.
    - dpop
```
String dpop
```
      The DPoP HTTP header.
    - htm
```
String htm
```
      The HTTP method of the grant management request.
    - htu
```
String htu
```
      The URL of the grant management endpoint.
- Class com.authlete.common.dto.GMResponse extends ApiResponse implements Serializable
  
  serialVersionUID:
  
  1L
  - Serialized Fields
    - action
```
GMResponse.Action action
```
    - responseContent
```
String responseContent
```
- Class com.authlete.common.dto.Grant extends Object implements Serializable
  
  serialVersionUID:
  
  1L
  - Serialized Fields
    - scopes
```
GrantScope[] scopes
```
    - claims
```
String[] claims
```
    - authorizationDetails
```
AuthzDetails authorizationDetails
```
- Class com.authlete.common.dto.GrantedScopesGetResponse extends ApiResponse implements Serializable
  
  serialVersionUID:
  
  1L
  - Serialized Fields
    - serviceApiKey
```
long serviceApiKey
```
    - clientId
```
long clientId
```
    - subject
```
String subject
```
    - latestGrantedScopes
```
String[] latestGrantedScopes
```
    - mergedGrantedScopes
```
String[] mergedGrantedScopes
```
    - modifiedAt
```
long modifiedAt
```
- Class com.authlete.common.dto.GrantScope extends Object implements Serializable
  
  serialVersionUID:
  
  1L
  - Serialized Fields
    - scope
```
String scope
```
      Space-delimited scopes.
    - resource
```
String[] resource
```
      List of resource indicators.
- Class com.authlete.common.dto.Hsk extends Object implements Serializable
  
  serialVersionUID:
  
  1L
  - Serialized Fields
    - kty
```
String kty
```
    - use
```
String use
```
    - alg
```
String alg
```
    - kid
```
String kid
```
    - hsmName
```
String hsmName
```
    - handle
```
String handle
```
    - publicKey
```
String publicKey
```
- Class com.authlete.common.dto.HskCreateRequest extends Object implements Serializable
  
  serialVersionUID:
  
  1L
  - Serialized Fields
    - kty
```
String kty
```
    - use
```
String use
```
    - alg
```
String alg
```
    - kid
```
String kid
```
    - hsmName
```
String hsmName
```
- Class com.authlete.common.dto.HskListResponse extends ApiResponse implements Serializable
  
  serialVersionUID:
  
  1L
  - Serialized Fields
    - action
```
HskListResponse.Action action
```
    - hsks
```
Hsk[] hsks
```
- Class com.authlete.common.dto.HskResponse extends ApiResponse implements Serializable
  
  serialVersionUID:
  
  1L
  - Serialized Fields
    - action
```
HskResponse.Action action
```
    - hsk
```
Hsk hsk
```
- Class com.authlete.common.dto.IntrospectionRequest extends Object implements Serializable
  
  serialVersionUID:
  
  4L
  - Serialized Fields
    - token
```
String token
```
      Access token to introspect.
    - scopes
```
String[] scopes
```
      Required scopes for access to the protected resource endpoint.
    - subject
```
String subject
```
      Expected identifier of resource owner.
    - clientCertificate
```
String clientCertificate
```
      Client certificate used in the mutual TLS connection between the client application and the protected resource endpoint.
    - dpop
```
String dpop
```
      DPoP Header.
    - htm
```
String htm
```
      HTTP Method (for DPoP validation).
    - htu
```
String htu
```
      HTTP URL base (for DPoP validation).
    - resources
```
URI[] resources
```
      Resource indicators.
- Class com.authlete.common.dto.IntrospectionResponse extends ApiResponse implements Serializable
  
  serialVersionUID:
  
  14L
  - Serialized Fields
    - action
```
IntrospectionResponse.Action action
```
      The next action the service implementation should take.
    - clientId
```
long clientId
```
      The client ID.
    - subject
```
String subject
```
      Resource owner's user account.
    - scopes
```
String[] scopes
```
      Scopes.
    - scopeDetails
```
Scope[] scopeDetails
```
      Scope details.
      
      Since:
      
      3.16
    - existent
```
boolean existent
```
      Flag to indicate whether the access token exists.
    - usable
```
boolean usable
```
      Flag to indicate whether the access token is usable (= exists and has not expired).
    - sufficient
```
boolean sufficient
```
      Flag to indicate whether the access token covers the required scopes.
    - refreshable
```
boolean refreshable
```
      Flag to indicate whether the access token is refreshable.
    - responseContent
```
String responseContent
```
      Entity body of the response to the client.
    - expiresAt
```
long expiresAt
```
      The time at which the access token expires.
    - properties
```
Property[] properties
```
      Extra properties associated with the access token.
    - clientIdAlias
```
String clientIdAlias
```
      The client ID alias when the authorization request or the token request for the access token was made.
    - clientIdAliasUsed
```
boolean clientIdAliasUsed
```
      Flag which indicates whether the client ID alias was used when the authorization request or the token request for the access token was made.
    - certificateThumbprint
```
String certificateThumbprint
```
      Confirmation hash for MTLS-bound access tokens. Currently only the S256 type is supported and is assumed.
    - resources
```
URI[] resources
```
      The target resources specified by the initial request.
    - accessTokenResources
```
URI[] accessTokenResources
```
      The target resources of the access token.
    - authorizationDetails
```
AuthzDetails authorizationDetails
```
      The content of the "authorization_details" request parameter which was included in the request that obtained the token.
    - grantId
```
String grantId
```
      Grant ID that this access token is tied to.
    - grant
```
Grant grant
```
      Grant that this access token has inherited.
    - consentedClaims
```
String[] consentedClaims
```
      Claims that the user has consented for the client application to know.
    - serviceAttributes
```
Pair[] serviceAttributes
```
      The attributes of the service that the client belongs to.
    - clientAttributes
```
Pair[] clientAttributes
```
      The attributes of the client that the access token has been issued to.
    - forExternalAttachment
```
boolean forExternalAttachment
```
      Flag that indicates whether the token is for an external attachment.
      
      Since:
      
      3.16
- Class com.authlete.common.dto.JoseVerifyRequest extends Object implements Serializable
  
  serialVersionUID:
  
  1L
  - Serialized Fields
    - jose
```
String jose
```
      The JOSE object that will be verified.
    - mandatoryClaims
```
String[] mandatoryClaims
```
      Mandatory claims that must be included in the JOSE object. This assumes that the payload part of the JOSE object can be parsed as JSON.
    - clockSkew
```
int clockSkew
```
      Allowable clock skew in seconds for verification of exp, nbf and iat claims.
    - clientIdentifier
```
String clientIdentifier
```
      The identifier of the client application.
    - signedByClient
```
boolean signedByClient
```
      The flag which indicates whether the JOSE object has been signed by a client application with the client's private key or a shared symmetric key.
- Class com.authlete.common.dto.JoseVerifyResponse extends ApiResponse implements Serializable
  
  serialVersionUID:
  
  1L
  - Serialized Fields
    - valid
```
boolean valid
```
      The result of the verification on the JOSE object.
    - signatureValid
```
boolean signatureValid
```
      The result of the signature verification.
    - missingClaims
```
String[] missingClaims
```
      Claims that are not included although they are specified by the mandatoryClaims request parameter.
    - invalidClaims
```
String[] invalidClaims
```
      Invalid claims.
    - errorDescriptions
```
String[] errorDescriptions
```
      Error messages.
- Class com.authlete.common.dto.NamedUri extends Object implements Serializable
  
  serialVersionUID:
  
  1L
  - Serialized Fields
    - name
```
String name
```
      The name of the URI.
    - uri
```
URI uri
```
      The value of the URI.
- Class com.authlete.common.dto.Pair extends Object implements Serializable
  
  serialVersionUID:
  
  1L
  - Serialized Fields
    - key
```
String key
```
    - value
```
String value
```
- Class com.authlete.common.dto.Property extends Object implements Serializable
  
  serialVersionUID:
  
  2L
  - Serialized Fields
    - key
```
String key
```
    - value
```
String value
```
    - hidden
```
boolean hidden
```
- Class com.authlete.common.dto.PushedAuthReqRequest extends Object implements Serializable
  
  serialVersionUID:
  
  1L
  - Serialized Fields
    - parameters
```
String parameters
```
      Request parameters of the request to the pushed authorization request endpoint.
    - clientId
```
String clientId
```
      Client ID extracted from the Authorization header.
    - clientSecret
```
String clientSecret
```
      Client secret extracted from the Authorization header.
    - clientCertificate
```
String clientCertificate
```
      Client certificate.
    - clientCertificatePath
```
String[] clientCertificatePath
```
      Client certificate path.
- Class com.authlete.common.dto.PushedAuthReqResponse extends ApiResponse implements Serializable
  
  serialVersionUID:
  
  1L
  - Serialized Fields
    - action
```
PushedAuthReqResponse.Action action
```
    - responseContent
```
String responseContent
```
    - clientAuthMethod
```
ClientAuthMethod clientAuthMethod
```
    - requestUri
```
URI requestUri
```
- Class com.authlete.common.dto.RevocationRequest extends Object implements Serializable
  
  serialVersionUID:
  
  3L
  - Serialized Fields
    - parameters
```
String parameters
```
      OAuth 2.0 token revocation request parameters.
    - clientId
```
String clientId
```
      Client ID.
    - clientSecret
```
String clientSecret
```
      Client secret.
    - clientCertificate
```
String clientCertificate
```
      Client certificate.
    - clientCertificatePath
```
String[] clientCertificatePath
```
      Client certificate path.
- Class com.authlete.common.dto.RevocationResponse extends ApiResponse implements Serializable
  
  serialVersionUID:
  
  1L
  - Serialized Fields
    - action
```
RevocationResponse.Action action
```
    - responseContent
```
String responseContent
```
- Class com.authlete.common.dto.Scope extends Object implements Serializable
  
  serialVersionUID:
  
  3L
  - Serialized Fields
    - name
```
String name
```
      Scope name.
    - defaultEntry
```
boolean defaultEntry
```
      Flag that indicates whether this scope is included in the default scope list.
    - description
```
String description
```
      Description of this scope.
    - descriptions
```
TaggedValue[] descriptions
```
      Descriptions for various languages.
    - attributes
```
Pair[] attributes
```
      Attributes of this scope.
- Class com.authlete.common.dto.Scope.NameComparator extends Object implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.authlete.common.dto.Service extends Object implements Serializable
  
  serialVersionUID:
  
  55L
  - Serialized Fields
    - number
```
int number
```
      Service number.
    - serviceOwnerNumber
```
int serviceOwnerNumber
```
      Service owner number.
    - serviceName
```
String serviceName
```
      Service name.
    - apiKey
```
long apiKey
```
      API key.
    - apiSecret
```
String apiSecret
```
      API secret.
    - issuer
```
URI issuer
```
    - authorizationEndpoint
```
URI authorizationEndpoint
```
    - tokenEndpoint
```
URI tokenEndpoint
```
    - revocationEndpoint
```
URI revocationEndpoint
```
    - supportedRevocationAuthMethods
```
ClientAuthMethod[] supportedRevocationAuthMethods
```
    - userInfoEndpoint
```
URI userInfoEndpoint
```
    - jwksUri
```
URI jwksUri
```
    - jwks
```
String jwks
```
    - registrationEndpoint
```
URI registrationEndpoint
```
    - registrationManagementEndpoint
```
URI registrationManagementEndpoint
```
    - supportedScopes
```
Scope[] supportedScopes
```
    - supportedResponseTypes
```
ResponseType[] supportedResponseTypes
```
    - supportedGrantTypes
```
GrantType[] supportedGrantTypes
```
    - supportedAcrs
```
String[] supportedAcrs
```
    - supportedTokenAuthMethods
```
ClientAuthMethod[] supportedTokenAuthMethods
```
    - supportedDisplays
```
Display[] supportedDisplays
```
    - supportedClaimTypes
```
ClaimType[] supportedClaimTypes
```
    - supportedClaims
```
String[] supportedClaims
```
    - serviceDocumentation
```
URI serviceDocumentation
```
    - supportedClaimLocales
```
String[] supportedClaimLocales
```
    - supportedUiLocales
```
String[] supportedUiLocales
```
    - policyUri
```
URI policyUri
```
    - tosUri
```
URI tosUri
```
    - authenticationCallbackEndpoint
```
URI authenticationCallbackEndpoint
```
    - authenticationCallbackApiKey
```
String authenticationCallbackApiKey
```
    - authenticationCallbackApiSecret
```
String authenticationCallbackApiSecret
```
    - supportedSnses
```
Sns[] supportedSnses
```
    - snsCredentials
```
SnsCredentials[] snsCredentials
```
    - createdAt
```
long createdAt
```
    - modifiedAt
```
long modifiedAt
```
    - developerAuthenticationCallbackEndpoint
```
URI developerAuthenticationCallbackEndpoint
```
    - developerAuthenticationCallbackApiKey
```
String developerAuthenticationCallbackApiKey
```
    - developerAuthenticationCallbackApiSecret
```
String developerAuthenticationCallbackApiSecret
```
    - supportedDeveloperSnses
```
Sns[] supportedDeveloperSnses
```
    - developerSnsCredentials
```
SnsCredentials[] developerSnsCredentials
```
    - clientsPerDeveloper
```
int clientsPerDeveloper
```
    - directAuthorizationEndpointEnabled
```
boolean directAuthorizationEndpointEnabled
```
    - directTokenEndpointEnabled
```
boolean directTokenEndpointEnabled
```
    - directRevocationEndpointEnabled
```
boolean directRevocationEndpointEnabled
```
    - directUserInfoEndpointEnabled
```
boolean directUserInfoEndpointEnabled
```
    - directJwksEndpointEnabled
```
boolean directJwksEndpointEnabled
```
    - directIntrospectionEndpointEnabled
```
boolean directIntrospectionEndpointEnabled
```
    - singleAccessTokenPerSubject
```
boolean singleAccessTokenPerSubject
```
    - pkceRequired
```
boolean pkceRequired
```
    - pkceS256Required
```
boolean pkceS256Required
```
    - refreshTokenKept
```
boolean refreshTokenKept
```
    - refreshTokenDurationKept
```
boolean refreshTokenDurationKept
```
    - refreshTokenDurationReset
```
boolean refreshTokenDurationReset
```
    - errorDescriptionOmitted
```
boolean errorDescriptionOmitted
```
    - errorUriOmitted
```
boolean errorUriOmitted
```
    - clientIdAliasEnabled
```
boolean clientIdAliasEnabled
```
    - supportedServiceProfiles
```
ServiceProfile[] supportedServiceProfiles
```
    - tlsClientCertificateBoundAccessTokens
```
boolean tlsClientCertificateBoundAccessTokens
```
    - introspectionEndpoint
```
URI introspectionEndpoint
```
    - supportedIntrospectionAuthMethods
```
ClientAuthMethod[] supportedIntrospectionAuthMethods
```
    - mutualTlsValidatePkiCertChain
```
boolean mutualTlsValidatePkiCertChain
```
    - trustedRootCertificates
```
String[] trustedRootCertificates
```
    - dynamicRegistrationSupported
```
boolean dynamicRegistrationSupported
```
    - endSessionEndpoint
```
URI endSessionEndpoint
```
    - description
```
String description
```
      Description of this service.
    - accessTokenType
```
String accessTokenType
```
      Access token type.
      
      See Also:
      
      RFC 6749 (OAuth 2.0), 7.1. Access Token Types
    - accessTokenSignAlg
```
JWSAlg accessTokenSignAlg
```
      Signature algorithm of JWT-based access tokens. When this property is not null, access tokens issued by this service are JWTs. Otherwise, access tokens are random strings as before.
      Symmetric algorithms are not supported.
      
      Since:
      
      2.37
    - accessTokenDuration
```
long accessTokenDuration
```
      Duration of access tokens in seconds.
    - refreshTokenDuration
```
long refreshTokenDuration
```
      Duration of refresh tokens in seconds.
    - idTokenDuration
```
long idTokenDuration
```
      Duration of ID tokens in seconds.
    - authorizationResponseDuration
```
long authorizationResponseDuration
```
      Duration of authorization response JWTs.
      
      Since:
      
      2.28
    - pushedAuthReqDuration
```
long pushedAuthReqDuration
```
      Duration of pushed authorization requests.
      
      Since:
      
      2.51
    - metadata
```
Pair[] metadata
```
      Metadata.
      
      Since:
      
      1.39
    - accessTokenSignatureKeyId
```
String accessTokenSignatureKeyId
```
      Key ID to identify a JWK used for access token signature using an asymmetric key.
      
      Since:
      
      2.37
    - authorizationSignatureKeyId
```
String authorizationSignatureKeyId
```
      Key ID to identify a JWK used for signing authorization responses using an asymmetric key. Regarding "signing the authorization response", see Financial-grade API: JWT Secured Authorization Response Mode for OAuth 2.0 (JARM)
      
      Since:
      
      2.28
    - idTokenSignatureKeyId
```
String idTokenSignatureKeyId
```
      Key ID to identify a JWK used for ID token signature using an asymmetric key.
      
      Since:
      
      2.1
    - userInfoSignatureKeyId
```
String userInfoSignatureKeyId
```
      Key ID to identify a JWK used for User Info signature using an asymmetric key.
      
      Since:
      
      2.1
    - supportedBackchannelTokenDeliveryModes
```
DeliveryMode[] supportedBackchannelTokenDeliveryModes
```
      Supported backchannel token delivery modes. This property corresponds to the backchannel_token_delivery_modes_supported metadata.
      
      Since:
      
      2.32
    - backchannelAuthenticationEndpoint
```
URI backchannelAuthenticationEndpoint
```
      The backchannel authentication endpoint. This property corresponds to the backchannel_authentication_endpoint metadata.
      
      Since:
      
      2.32
    - backchannelUserCodeParameterSupported
```
boolean backchannelUserCodeParameterSupported
```
      Boolean flag which indicates whether "user code" is supported at the backchannel authentication endpoint. This property corresponds to the backchannel_user_code_parameter_supported metadata.
      
      Since:
      
      2.32
    - backchannelAuthReqIdDuration
```
int backchannelAuthReqIdDuration
```
      Duration of backchannel authentication request IDs issued from the backchannel authentication endpoint in seconds. This is used as the value of the expires_in property in responses from the backchannel authentication endpoint.
      
      Since:
      
      2.32
    - backchannelPollingInterval
```
int backchannelPollingInterval
```
      The minimum interval between polling requests to the token endpoint from client applications in seconds. This is used as the value of the interval property in responses from the backchannel authentication endpoint.
      
      Since:
      
      2.32
    - backchannelBindingMessageRequiredInFapi
```
boolean backchannelBindingMessageRequiredInFapi
```
      Boolean flag which indicates whether the binding_message request parameter is always required whenever a backchannel authentication request is judged as a request for Financial-grade API.
      
      Since:
      
      2.48
    - allowableClockSkew
```
int allowableClockSkew
```
      The allowable clock skew between the server and clients.
      
      Since:
      
      2.32
    - deviceAuthorizationEndpoint
```
URI deviceAuthorizationEndpoint
```
      The device authorization endpoint. This property corresponds to the device_authorization_endpoint metadata.
      
      Since:
      
      2.42
    - deviceVerificationUri
```
URI deviceVerificationUri
```
      The verification URI for the device flow.
      
      Since:
      
      2.42
    - deviceVerificationUriComplete
```
URI deviceVerificationUriComplete
```
      The verification URI for the device flow with a placeholder for a user code.
      
      Since:
      
      2.42
    - deviceFlowCodeDuration
```
int deviceFlowCodeDuration
```
      Duration of device verification codes and end-user verification codes issued from the device authorization endpoint in seconds. This is used as the value of the expires_in property in responses from the device authorization endpoint.
      
      Since:
      
      2.42
    - deviceFlowPollingInterval
```
int deviceFlowPollingInterval
```
      The minimum interval between polling requests to the token endpoint from client applications in seconds in device flow. This is used as the value of the interval property in responses from the device authorization endpoint.
      
      Since:
      
      2.42
    - userCodeCharset
```
UserCodeCharset userCodeCharset
```
      Character set for end-user verification codes (user_code) for Device Flow.
      
      Since:
      
      2.43
    - userCodeLength
```
int userCodeLength
```
      Length of end-user verification codes (user_code) for Device Flow.
      
      Since:
      
      2.43
    - pushedAuthReqEndpoint
```
URI pushedAuthReqEndpoint
```
      The URI of the pushed authorization request endpoint.
      
      Since:
      
      2.52
    - mtlsEndpointAliases
```
NamedUri[] mtlsEndpointAliases
```
      MTLS endpoint aliases.
      
      Since:
      
      2.49
    - supportedAuthorizationDetailsTypes
```
String[] supportedAuthorizationDetailsTypes
```
      Supported authorization details types for "authorization_details".
      This property was renamed from supportedAuthorizationDataTypes to align with the change made by the 5th draft of the RAR specification.
      
      Since:
      
      2.91
    - supportedTrustFrameworks
```
String[] supportedTrustFrameworks
```
      Supported trust frameworks. This property corresponds to the trust_frameworks_supported server metadata which is defined in OpenID Connect for Identity Assurance 1.0.
      
      Since:
      
      2.63
    - supportedEvidence
```
String[] supportedEvidence
```
      Supported evidence. This property corresponds to the evidence_supported server metadata which is defined in OpenID Connect for Identity Assurance 1.0.
      
      Since:
      
      2.63
    - supportedIdentityDocuments
```
String[] supportedIdentityDocuments
```
      Deprecated.
      
      Supported ID documents. This property corresponds to the id_documents_supported server metadata which was defined in old drafts of OpenID Connect for Identity Assurance 1.0.
      The third implementer's draft of OpenID Connect for Identity Assurance 1.0 renamed the id_documents_supported server metadata to documents_supported.
      
      Since:
      
      2.63
      
      See Also:
      
      supportedDocuments
    - supportedDocuments
```
String[] supportedDocuments
```
      Supported documents. This property corresponds to the documents_supported server metadata which was renamed to from id_documents_supported by the third implementer's draft of OpenID Connect for Identity Assurance 1.0.
      
      Since:
      
      3.13
    - supportedVerificationMethods
```
String[] supportedVerificationMethods
```
      Deprecated.
      
      Supported verification methods. This property corresponds to the id_documents_verification_methods_supported server metadata which was defined in old drafts of OpenID Connect for Identity Assurance 1.0.
      The third implementer's draft of OpenID Connect for Identity Assurance 1.0 renamed the id_documents_verification_methods_supported server metadata to documents_methods_supported.
      
      Since:
      
      2.63
      
      See Also:
      
      supportedDocumentsMethods
    - supportedDocumentsMethods
```
String[] supportedDocumentsMethods
```
      Supported validation and verification processes. This property corresponds to the documents_methods_supported server metadata which was renamed to from id_documents_verification_methods_supported by the third implementer's draft of OpenID Connect for Identity Assurance 1.0.
      
      Since:
      
      3.13
    - supportedDocumentsValidationMethods
```
String[] supportedDocumentsValidationMethods
```
      Supported document validation methods. This property corresponds to the documents_validation_methods_supported server metadata which was added by the third implementer's draft of OpenID Connect for Identity Assurance 1.0.
      
      Since:
      
      3.13
    - supportedDocumentsVerificationMethods
```
String[] supportedDocumentsVerificationMethods
```
      Supported document verification methods. This property corresponds to the documents_verification_methods_supported server metadata which was added by the third implementer's draft of OpenID Connect for Identity Assurance 1.0.
      
      Since:
      
      3.13
    - supportedElectronicRecords
```
String[] supportedElectronicRecords
```
      Supported electronic record types. This property corresponds to the electronic_records_supported server metadata which was added by the third implementer's draft of OpenID Connect for Identity Assurance 1.0.
      
      Since:
      
      3.13
    - supportedVerifiedClaims
```
String[] supportedVerifiedClaims
```
      Supported verified claims. This property corresponds to the claims_in_verified_claims_supported server metadata which is defined in OpenID Connect for Identity Assurance 1.0.
      
      Since:
      
      2.63
    - supportedAttachments
```
AttachmentType[] supportedAttachments
```
      Supported attachment types. This property corresponds to the attachments_supported server metadata which was added by the third implementer's draft of OpenID Connect for Identity Assurance 1.0.
      
      Since:
      
      3.13
    - supportedDigestAlgorithms
```
String[] supportedDigestAlgorithms
```
      Supported algorithms used to compute digest values of external attachments. This property corresponds to the digest_algorithms_supported server metadata which was added by the third implementer's draft of OpenID Connect for Identity Assurance 1.0.
      
      Since:
      
      3.13
    - missingClientIdAllowed
```
boolean missingClientIdAllowed
```
      The flag indicating whether token requests from public clients without the client_id request parameter are allowed when the client can be guessed from authorization_code or refresh_token.
      Don't set this flag unless you have special reasons.
      
      Since:
      
      2.68
    - parRequired
```
boolean parRequired
```
      The flag indicating whether this service requires that clients use the pushed authorization request endpoint.
      
      Since:
      
      2.77
    - requestObjectRequired
```
boolean requestObjectRequired
```
      The flag indicating whether authorization requests must utilize a request object.
      
      Since:
      
      2.80
    - traditionalRequestObjectProcessingApplied
```
boolean traditionalRequestObjectProcessingApplied
```
      The flag indicating whether traditional request object processing (rules defined in OIDC Core 1.0) is applied.
      
      Since:
      
      2.80
    - claimShortcutRestrictive
```
boolean claimShortcutRestrictive
```
      The flag indicating whether claims specified by shortcut scopes (e.g. profile) are included in the issued ID token only when no access token is issued.
      
      Since:
      
      2.81
    - scopeRequired
```
boolean scopeRequired
```
      The flag indicating whether requests that request no scope are rejected or not.
      
      Since:
      
      2.81
    - nbfOptional
```
boolean nbfOptional
```
      The flag indicating whether the nbf claim in the request object is optional even when the authorization request is regarded as a FAPI-Part2 request.
      
      Since:
      
      2.86
    - issSuppressed
```
boolean issSuppressed
```
      The flag indicating whether generation of the iss response parameter is suppressed.
      
      Since:
      
      2.86
    - attributes
```
Pair[] attributes
```
      Arbitrary attributes associated with this service.
      
      Since:
      
      2.87
    - supportedCustomClientMetadata
```
String[] supportedCustomClientMetadata
```
      Custom client metadata supported by this service.
      
      Since:
      
      2.93
    - tokenExpirationLinked
```
boolean tokenExpirationLinked
```
      The flag indicating whether the expiration date of an access token never exceeds that of the corresponding refresh token.
      
      Since:
      
      2.95
    - frontChannelRequestObjectEncryptionRequired
```
boolean frontChannelRequestObjectEncryptionRequired
```
      The flag indicating whether encryption of request object is required when the request object is passed through the front channel.
      
      Since:
      
      2.96
    - requestObjectEncryptionAlgMatchRequired
```
boolean requestObjectEncryptionAlgMatchRequired
```
      The flag indicating whether the JWE alg of encrypted request object must match the value of the request_object_encryption_alg client metadata.
      
      Since:
      
      2.96
    - requestObjectEncryptionEncMatchRequired
```
boolean requestObjectEncryptionEncMatchRequired
```
      The flag indicating whether the JWE enc of encrypted request object must match the value of the request_object_encryption_enc client metadata.
      
      Since:
      
      2.96
    - hsmEnabled
```
boolean hsmEnabled
```
      The flag indicating whether HSM (Hardware Security Module) support is enabled for this service.
      
      Since:
      
      2.97
    - hsks
```
Hsk[] hsks
```
      Hardware-secured keys. Output only.
      
      Since:
      
      2.97
    - grantManagementEndpoint
```
URI grantManagementEndpoint
```
      The URL of the grant management endpoint.
      
      Since:
      
      3.1
    - grantManagementActionRequired
```
boolean grantManagementActionRequired
```
      The flag indicating whether every authorization request must include the grant_management_action request parameter.
      
      Since:
      
      3.1
    - unauthorizedOnClientConfigSupported
```
boolean unauthorizedOnClientConfigSupported
```
      The flag indicating whether to let /api/client/registration API use ClientRegistrationResponse.Action.UNAUTHORIZED whenever appropriate.
      
      Since:
      
      3.4
    - dcrScopeUsedAsRequestable
```
boolean dcrScopeUsedAsRequestable
```
      The flag indicating whether the scope request parameter in dynamic client registration/update requests is used as requestable scopes.
      
      Since:
      
      3.5
    - predefinedTransformedClaims
```
String predefinedTransformedClaims
```
      Predefined transformed claims in JSON format. Available from Authlete 2.3 onwards.
      
      Since:
      
      3.8
    - loopbackRedirectionUriVariable
```
boolean loopbackRedirectionUriVariable
```
      The flag indicating whether the port number component of redirection URIs can be variable when the host component indicates loopback.
      
      Since:
      
      3.12
    - requestObjectAudienceChecked
```
boolean requestObjectAudienceChecked
```
      The flag indicating whether Authlete checks whether the aud claim of request objects matches the issuer identifier of this service.
      
      Since:
      
      3.14
    - accessTokenForExternalAttachmentEmbedded
```
boolean accessTokenForExternalAttachmentEmbedded
```
      The flag indicating whether Authlete generates access tokens for external attachments and embeds them in ID tokens and userinfo responses.
      
      Since:
      
      3.16
- Class com.authlete.common.dto.ServiceCreatableResponse extends Object implements Serializable
  
  serialVersionUID:
  
  1L
  - Serialized Fields
    - creatable
```
boolean creatable
```
    - count
```
int count
```
    - limit
```
int limit
```
    - plan
```
Plan plan
```
- Class com.authlete.common.dto.ServiceListResponse extends Object implements Serializable
  
  serialVersionUID:
  
  1L
  - Serialized Fields
    - start
```
int start
```
      The start index (inclusive) for the result set of the query.
    - end
```
int end
```
      The end index (exclusive) for the result set of the query.
    - totalCount
```
int totalCount
```
      The total count of services.
    - services
```
Service[] services
```
      The service list extracted from the database.
- Class com.authlete.common.dto.ServiceOwner extends Object implements Serializable
  
  serialVersionUID:
  
  2L
  - Serialized Fields
    - number
```
int number
```
    - name
```
String name
```
    - email
```
String email
```
    - loginId
```
String loginId
```
    - apiKey
```
long apiKey
```
    - apiSecret
```
String apiSecret
```
    - plan
```
Plan plan
```
- Class com.authlete.common.dto.SnsCredentials extends Object implements Serializable
  
  serialVersionUID:
  
  1L
  - Serialized Fields
    - sns
```
Sns sns
```
    - apiKey
```
String apiKey
```
    - apiSecret
```
String apiSecret
```
- Class com.authlete.common.dto.StandardIntrospectionRequest extends Object implements Serializable
  
  serialVersionUID:
  
  2L
  - Serialized Fields
    - parameters
```
String parameters
```
      OAuth 2.0 token introspection request parameters.
    - withHiddenProperties
```
boolean withHiddenProperties
```
      Flag indicating whether to include hidden properties in the output.
      
      Since:
      
      2.83
- Class com.authlete.common.dto.StandardIntrospectionResponse extends ApiResponse implements Serializable
  
  serialVersionUID:
  
  1L
  - Serialized Fields
    - action
```
StandardIntrospectionResponse.Action action
```
    - responseContent
```
String responseContent
```
- Class com.authlete.common.dto.StringArray extends Object implements Serializable
  
  serialVersionUID:
  
  1L
  - Serialized Fields
    - array
```
String[] array
```
- Class com.authlete.common.dto.TaggedValue extends Object implements Serializable
  
  serialVersionUID:
  
  1L
  - Serialized Fields
    - tag
```
String tag
```
    - value
```
String value
```
- Class com.authlete.common.dto.TokenCreateRequest extends Object implements Serializable
  
  serialVersionUID:
  
  10L
  - Serialized Fields
    - grantType
```
GrantType grantType
```
    - clientId
```
long clientId
```
    - subject
```
String subject
```
    - scopes
```
String[] scopes
```
    - accessTokenDuration
```
long accessTokenDuration
```
    - refreshTokenDuration
```
long refreshTokenDuration
```
    - properties
```
Property[] properties
```
    - clientIdAliasUsed
```
boolean clientIdAliasUsed
```
    - accessToken
```
String accessToken
```
    - refreshToken
```
String refreshToken
```
    - accessTokenPersistent
```
boolean accessTokenPersistent
```
    - certificateThumbprint
```
String certificateThumbprint
```
    - dpopKeyThumbprint
```
String dpopKeyThumbprint
```
    - authorizationDetails
```
AuthzDetails authorizationDetails
```
    - resources
```
URI[] resources
```
    - forExternalAttachment
```
boolean forExternalAttachment
```
- Class com.authlete.common.dto.TokenCreateResponse extends ApiResponse implements Serializable
  
  serialVersionUID:
  
  6L
  - Serialized Fields
    - action
```
TokenCreateResponse.Action action
```
    - grantType
```
GrantType grantType
```
    - clientId
```
long clientId
```
    - subject
```
String subject
```
    - scopes
```
String[] scopes
```
    - accessToken
```
String accessToken
```
    - tokenType
```
String tokenType
```
    - expiresIn
```
long expiresIn
```
    - expiresAt
```
long expiresAt
```
    - refreshToken
```
String refreshToken
```
    - properties
```
Property[] properties
```
    - jwtAccessToken
```
String jwtAccessToken
```
    - authorizationDetails
```
AuthzDetails authorizationDetails
```
    - forExternalAttachment
```
boolean forExternalAttachment
```
- Class com.authlete.common.dto.TokenFailRequest extends Object implements Serializable
  
  serialVersionUID:
  
  2L
  - Serialized Fields
    - ticket
```
String ticket
```
      The ticket issued by Authlete's /auth/token API.
    - reason
```
TokenFailRequest.Reason reason
```
      The reason of the failure.
- Class com.authlete.common.dto.TokenFailResponse extends ApiResponse implements Serializable
  
  serialVersionUID:
  
  1L
  - Serialized Fields
    - action
```
TokenFailResponse.Action action
```
    - responseContent
```
String responseContent
```
- Class com.authlete.common.dto.TokenIssueRequest extends Object implements Serializable
  
  serialVersionUID:
  
  4L
  - Serialized Fields
    - ticket
```
String ticket
```
      The ticket issued by Authlete's endpoint.
    - subject
```
String subject
```
      The subject (unique identifier) of the authenticated user.
    - properties
```
Property[] properties
```
      Extra properties to associate with an access token.
- Class com.authlete.common.dto.TokenIssueResponse extends ApiResponse implements Serializable
  
  serialVersionUID:
  
  8L
  - Serialized Fields
    - action
```
TokenIssueResponse.Action action
```
      The next action that the service implementation should take.
    - responseContent
```
String responseContent
```
    - accessToken
```
String accessToken
```
    - accessTokenExpiresAt
```
long accessTokenExpiresAt
```
    - accessTokenDuration
```
long accessTokenDuration
```
    - refreshToken
```
String refreshToken
```
    - refreshTokenExpiresAt
```
long refreshTokenExpiresAt
```
    - refreshTokenDuration
```
long refreshTokenDuration
```
    - clientId
```
long clientId
```
    - clientIdAlias
```
String clientIdAlias
```
    - clientIdAliasUsed
```
boolean clientIdAliasUsed
```
    - subject
```
String subject
```
    - scopes
```
String[] scopes
```
    - properties
```
Property[] properties
```
    - jwtAccessToken
```
String jwtAccessToken
```
    - accessTokenResources
```
URI[] accessTokenResources
```
    - authorizationDetails
```
AuthzDetails authorizationDetails
```
    - serviceAttributes
```
Pair[] serviceAttributes
```
    - clientAttributes
```
Pair[] clientAttributes
```
- Class com.authlete.common.dto.TokenListResponse extends Object implements Serializable
  
  serialVersionUID:
  
  1L
  - Serialized Fields
    - start
```
int start
```
      The start index (inclusive) for the result set of the query.
    - end
```
int end
```
      The end index (exclusive) for the result set of the query.
    - client
```
Client client
```
      The client associated with the access tokens.
    - subject
```
String subject
```
      The identifier of the user associated with the access tokens.
    - totalCount
```
int totalCount
```
      The total count of access tokens.
    - accessTokens
```
AccessToken[] accessTokens
```
      The access token list extracted from the database.
- Class com.authlete.common.dto.TokenRequest extends Object implements Serializable
  
  serialVersionUID:
  
  6L
  - Serialized Fields
    - parameters
```
String parameters
```
      OAuth 2.0 token request parameters.
    - clientId
```
String clientId
```
      Client ID.
    - clientSecret
```
String clientSecret
```
      Client secret.
    - clientCertificate
```
String clientCertificate
```
      Client certificate (used in MTLS auth and bound access tokens).
    - clientCertificatePath
```
String[] clientCertificatePath
```
      Client certificate path (used in PKI-based MTLS auth when certificates are validated by the Authlete service).
    - properties
```
Property[] properties
```
      Extra properties to associate with an access token.
    - dpop
```
String dpop
```
      DPoP Header
    - htm
```
String htm
```
      HTTP Method (for DPoP validation).
    - htu
```
String htu
```
      HTTP URL base (for DPoP validation).
- Class com.authlete.common.dto.TokenResponse extends ApiResponse implements Serializable
  
  serialVersionUID:
  
  11L
  - Serialized Fields
    - action
```
TokenResponse.Action action
```
    - responseContent
```
String responseContent
```
    - username
```
String username
```
    - password
```
String password
```
    - ticket
```
String ticket
```
    - accessToken
```
String accessToken
```
    - accessTokenExpiresAt
```
long accessTokenExpiresAt
```
    - accessTokenDuration
```
long accessTokenDuration
```
    - refreshToken
```
String refreshToken
```
    - refreshTokenExpiresAt
```
long refreshTokenExpiresAt
```
    - refreshTokenDuration
```
long refreshTokenDuration
```
    - idToken
```
String idToken
```
    - grantType
```
GrantType grantType
```
    - clientId
```
long clientId
```
    - clientIdAlias
```
String clientIdAlias
```
    - clientIdAliasUsed
```
boolean clientIdAliasUsed
```
    - subject
```
String subject
```
    - scopes
```
String[] scopes
```
    - properties
```
Property[] properties
```
    - jwtAccessToken
```
String jwtAccessToken
```
    - clientAuthMethod
```
ClientAuthMethod clientAuthMethod
```
    - resources
```
URI[] resources
```
    - accessTokenResources
```
URI[] accessTokenResources
```
    - authorizationDetails
```
AuthzDetails authorizationDetails
```
    - grantId
```
String grantId
```
    - serviceAttributes
```
Pair[] serviceAttributes
```
    - clientAttributes
```
Pair[] clientAttributes
```
- Class com.authlete.common.dto.TokenUpdateRequest extends Object implements Serializable
  
  serialVersionUID:
  
  7L
  - Serialized Fields
    - accessToken
```
String accessToken
```
    - accessTokenExpiresAt
```
long accessTokenExpiresAt
```
    - scopes
```
String[] scopes
```
    - properties
```
Property[] properties
```
    - accessTokenExpiresAtUpdatedOnScopeUpdate
```
boolean accessTokenExpiresAtUpdatedOnScopeUpdate
```
    - accessTokenPersistent
```
boolean accessTokenPersistent
```
    - accessTokenHash
```
String accessTokenHash
```
    - accessTokenValueUpdated
```
boolean accessTokenValueUpdated
```
    - certificateThumbprint
```
String certificateThumbprint
```
    - dpopKeyThumbprint
```
String dpopKeyThumbprint
```
    - authorizationDetails
```
AuthzDetails authorizationDetails
```
    - forExternalAttachment
```
boolean forExternalAttachment
```
- Class com.authlete.common.dto.TokenUpdateResponse extends ApiResponse implements Serializable
  
  serialVersionUID:
  
  4L
  - Serialized Fields
    - action
```
TokenUpdateResponse.Action action
```
    - accessToken
```
String accessToken
```
    - tokenType
```
String tokenType
```
    - accessTokenExpiresAt
```
long accessTokenExpiresAt
```
    - scopes
```
String[] scopes
```
    - properties
```
Property[] properties
```
    - authorizationDetails
```
AuthzDetails authorizationDetails
```
    - forExternalAttachment
```
boolean forExternalAttachment
```
- Class com.authlete.common.dto.UserInfoIssueRequest extends Object implements Serializable
  
  serialVersionUID:
  
  6L
  - Serialized Fields
    - token
```
String token
```
      The access token.
    - claims
```
String claims
```
      Claims in JSON format.
    - sub
```
String sub
```
      The value of the 'sub' claim. If this field is empty, the value of the subject that is associated with the access token is used as the value of the 'sub' claim.
    - claimsForTx
```
String claimsForTx
```
      Claim key-value pairs that are used to compute transformed claims.
    - verifiedClaimsForTx
```
String[] verifiedClaimsForTx
```
      Verified claim key-value pairs that are used to compute transformed claims.
- Class com.authlete.common.dto.UserInfoIssueResponse extends ApiResponse implements Serializable
  
  serialVersionUID:
  
  1L
  - Serialized Fields
    - action
```
UserInfoIssueResponse.Action action
```
    - responseContent
```
String responseContent
```
- Class com.authlete.common.dto.UserInfoRequest extends Object implements Serializable
  
  serialVersionUID:
  
  2L
  - Serialized Fields
    - token
```
String token
```
      The access token.
    - clientCertificate
```
String clientCertificate
```
      The client certificate used in the TLS connection established between the client application and the userinfo endpoint.
      
      Since:
      
      2.37
    - dpop
```
String dpop
```
      The DPoP header.
      
      Since:
      
      2.70
    - htm
```
String htm
```
      The HTTP method of the userinfo request.
      
      Since:
      
      2.70
    - htu
```
String htu
```
      The URL of the userinfo endpoint.
      
      Since:
      
      2.70
- Class com.authlete.common.dto.UserInfoResponse extends ApiResponse implements Serializable
  
  serialVersionUID:
  
  5L
  - Serialized Fields
    - action
```
UserInfoResponse.Action action
```
      The next action the service implementation should take.
    - clientId
```
long clientId
```
      The client ID.
    - subject
```
String subject
```
      Resource owner's user account.
    - scopes
```
String[] scopes
```
      Scopes.
    - claims
```
String[] claims
```
      Claims that are requested by the client application.
    - token
```
String token
```
      The access token that came along with the userinfo request.
    - responseContent
```
String responseContent
```
      Entity body of the response to the client.
    - properties
```
Property[] properties
```
      Extra properties associated with the access token.
    - clientIdAlias
```
String clientIdAlias
```
      The client ID alias when the authorization request for the access token was made.
    - clientIdAliasUsed
```
boolean clientIdAliasUsed
```
      Flag which indicates whether the client ID alias was used when the authorization request for the access token was made.
    - userInfoClaims
```
String userInfoClaims
```
      "userinfo" in "claims" of an authorization request.
    - transformedClaims
```
String transformedClaims
```
      "transformed_claims" in "claims" of an authorization request.
    - consentedClaims
```
String[] consentedClaims
```
      Claims that the user has consented for the client application to know.
    - requestedClaimsForTx
```
String[] requestedClaimsForTx
```
      Names of claims that will be referenced when transformed claims are computed.
    - requestedVerifiedClaimsForTx
```
StringArray[] requestedVerifiedClaimsForTx
```
      Names of verified claims that will be referenced when transformed claims are computed.
    - serviceAttributes
```
Pair[] serviceAttributes
```
      The attributes of the service that the client belongs to.
    - clientAttributes
```
Pair[] clientAttributes
```
      The attributes of the client that the access token has been issued to.

Serialized Form

Package com.authlete.common.api

Class com.authlete.common.api.AuthleteApiException extends RuntimeException implements Serializable

Serialized Fields

mStatusCode

mStatusMessage

mResponseBody

mResponseHeaders

Package com.authlete.common.assurance

Class com.authlete.common.assurance.Claims extends LinkedHashMap<String,Object> implements Serializable

Class com.authlete.common.assurance.Document extends LinkedHashMap<String,Object> implements Serializable

Class com.authlete.common.assurance.Evidence extends LinkedHashMap<String,Object> implements Serializable

Class com.authlete.common.assurance.EvidenceArray extends ArrayList<Evidence> implements Serializable

Class com.authlete.common.assurance.IDDocument extends Evidence implements Serializable

Class com.authlete.common.assurance.IdentityAssuranceException extends RuntimeException implements Serializable

Class com.authlete.common.assurance.Issuer extends LinkedHashMap<String,Object> implements Serializable

Class com.authlete.common.assurance.Provider extends LinkedHashMap<String,Object> implements Serializable

Class com.authlete.common.assurance.QES extends Evidence implements Serializable

Class com.authlete.common.assurance.UtilityBill extends Evidence implements Serializable

Class com.authlete.common.assurance.Verification extends LinkedHashMap<String,Object> implements Serializable

Class com.authlete.common.assurance.VerifiedClaims extends LinkedHashMap<String,Object> implements Serializable

Class com.authlete.common.assurance.Verifier extends LinkedHashMap<String,Object> implements Serializable

Package com.authlete.common.assurance.constraint

Class com.authlete.common.assurance.constraint.ClaimsConstraint extends LinkedHashMap<String,VerifiedClaimConstraint> implements Serializable

Serialized Fields

exists

isNull

Class com.authlete.common.assurance.constraint.ConstraintException extends RuntimeException implements Serializable

Class com.authlete.common.assurance.constraint.EvidenceArrayConstraint extends ArrayList<EvidenceConstraint> implements Serializable

Serialized Fields

exists

isNull

Package com.authlete.common.dto

Class com.authlete.common.dto.AccessToken extends Object implements Serializable

Serialized Fields

accessTokenHash

refreshTokenHash

clientId

subject

grantType

scopes

accessTokenExpiresAt

refreshTokenExpiresAt

createdAt

lastRefreshedAt

properties

Class com.authlete.common.dto.Address extends Object implements Serializable

Serialized Fields

formatted

street_address

locality

region

postal_code

country

Class com.authlete.common.dto.ApiResponse extends Object implements Serializable

Serialized Fields

resultCode

resultMessage

Class com.authlete.common.dto.AuthenticationCallbackRequest extends Object implements Serializable

Serialized Fields

serviceApiKey

clientId

id

password

claims

claimsLocales

sns

accessToken

refreshToken

expiresIn

rawTokenResponse

Class com.authlete.common.dto.AuthenticationCallbackResponse extends Object implements Serializable

Serialized Fields

authenticated

subject

claims

Class com.authlete.common.dto.AuthorizationAuthenticateRequest extends Object implements Serializable

Serialized Fields

ticket

loginId