Serialized Form (com.authlete:authlete-java-common 1.32 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.dto
- 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:
  
  2L
  - 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:
  
  5L
  - Serialized Fields
    - ticket
```
String ticket
```
      The ticket issued by Authlete's endpoint.
    - subject
```
String subject
```
      The subject (end-user) managed by the service.
    - 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.
- Class com.authlete.common.dto.AuthorizationIssueResponse extends ApiResponse implements Serializable
  
  serialVersionUID:
  
  1L
  - Serialized Fields
    - action
```
AuthorizationIssueResponse.Action action
```
    - responseContent
```
String responseContent
```
- 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:
  
  4L
  - Serialized Fields
    - action
```
AuthorizationResponse.Action action
```
    - service
```
Service service
```
    - client
```
Client client
```
    - display
```
Display display
```
    - maxAge
```
int maxAge
```
    - scopes
```
Scope[] scopes
```
    - uiLocales
```
String[] uiLocales
```
    - claimsLocales
```
String[] claimsLocales
```
    - claims
```
String[] claims
```
    - acrEssential
```
boolean acrEssential
```
    - acrs
```
String[] acrs
```
    - subject
```
String subject
```
    - loginHint
```
String loginHint
```
    - lowestPrompt
```
Prompt lowestPrompt
```
    - responseContent
```
String responseContent
```
    - ticket
```
String ticket
```
- Class com.authlete.common.dto.Client extends Object implements Serializable
  
  serialVersionUID:
  
  2L
  - Serialized Fields
    - number
```
int number
```
      Client number.
    - serviceNumber
```
int serviceNumber
```
      Service number.
    - developer
```
String developer
```
      Developer unique ID.
    - clientId
```
long clientId
```
      Client ID.
    - 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.
    - sectorIdentifier
```
URI sectorIdentifier
```
      Sector identifier.
    - 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
```
- 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.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.IntrospectionRequest extends Object implements Serializable
  
  serialVersionUID:
  
  1L
  - Serialized Fields
    - token
```
String token
```
    - scopes
```
String[] scopes
```
    - subject
```
String subject
```
- Class com.authlete.common.dto.IntrospectionResponse extends ApiResponse implements Serializable
  
  serialVersionUID:
  
  4L
  - 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.
    - 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.
- Class com.authlete.common.dto.Property extends Object implements Serializable
  
  serialVersionUID:
  
  1L
  - Serialized Fields
    - key
```
String key
```
    - value
```
String value
```
- Class com.authlete.common.dto.RevocationRequest extends Object implements Serializable
  
  serialVersionUID:
  
  2L
  - Serialized Fields
    - parameters
```
String parameters
```
      OAuth 2.0 token revocation request parameters.
    - clientId
```
String clientId
```
      Client ID.
    - clientSecret
```
String clientSecret
```
      Client secret.
- 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:
  
  2L
  - 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.
- Class com.authlete.common.dto.Scope.NameComparator extends Object implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.authlete.common.dto.Service extends Object implements Serializable
  
  serialVersionUID:
  
  10L
  - 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
```
    - userInfoEndpoint
```
URI userInfoEndpoint
```
    - jwksUri
```
URI jwksUri
```
    - jwks
```
String jwks
```
    - registrationEndpoint
```
URI registrationEndpoint
```
    - 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
```
    - singleAccessTokenPerSubject
```
boolean singleAccessTokenPerSubject
```
    - pkceRequired
```
boolean pkceRequired
```
    - 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
    - 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.
    - properties
```
String[][] properties
```
      Extra properties.
- 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.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:
  
  4L
  - Serialized Fields
    - grantType
```
GrantType grantType
```
    - clientId
```
long clientId
```
    - subject
```
String subject
```
    - scopes
```
String[] scopes
```
    - accessTokenDuration
```
long accessTokenDuration
```
    - refreshTokenDuration
```
long refreshTokenDuration
```
    - properties
```
Property[] properties
```
- Class com.authlete.common.dto.TokenCreateResponse extends ApiResponse implements Serializable
  
  serialVersionUID:
  
  2L
  - 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
```
- Class com.authlete.common.dto.TokenFailRequest extends Object implements Serializable
  
  serialVersionUID:
  
  1L
  - 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:
  
  1L
  - Serialized Fields
    - action
```
TokenIssueResponse.Action action
```
      The next action that the service implementation should take.
    - responseContent
```
String responseContent
```
- Class com.authlete.common.dto.TokenRequest extends Object implements Serializable
  
  serialVersionUID:
  
  3L
  - Serialized Fields
    - parameters
```
String parameters
```
      OAuth 2.0 token request parameters.
    - clientId
```
String clientId
```
      Client ID.
    - clientSecret
```
String clientSecret
```
      Client secret.
    - properties
```
Property[] properties
```
      Extra properties to associate with an access token.
- Class com.authlete.common.dto.TokenResponse extends ApiResponse implements Serializable
  
  serialVersionUID:
  
  2L
  - Serialized Fields
    - action
```
TokenResponse.Action action
```
    - responseContent
```
String responseContent
```
    - username
```
String username
```
    - password
```
String password
```
    - ticket
```
String ticket
```
- Class com.authlete.common.dto.UserInfoIssueRequest extends Object implements Serializable
  
  serialVersionUID:
  
  3L
  - Serialized Fields
    - token
```
String token
```
      The access token.
    - claims
```
String claims
```
      Claims in JSON format.
- 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:
  
  1L
  - Serialized Fields
    - token
```
String token
```
      The access token.
- Class com.authlete.common.dto.UserInfoResponse extends ApiResponse implements Serializable
  
  serialVersionUID:
  
  1L
  - 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.

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.dto

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

password

claims

claimsLocales

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

Serialized Fields

action

authenticated

responseContent

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

Serialized Fields

ticket

reason

description

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

Serialized Fields

action

responseContent

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

Serialized Fields

ticket

subject

authTime

acr

claims

properties

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

Serialized Fields

action

responseContent

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

Serialized Fields

parameters

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

Serialized Fields

action

service

client