Package com.authlete.common.dto

Requests to and responses from Authlete APIs and some data structures.

Class Summary

Class	Description
AccessToken	Information about an access token.
Address	Address claim that represents a physical mailing address.
ApiResponse	The base class of an API response from an Authlete API call.
AssertionProcessor	Information about an assertion processor, used by Authlete to allow a service to programmatically check assertions used passed in by clients and resource servers.
AuthenticationCallbackRequest	Authentication request from Authlete to a service implementation.
AuthenticationCallbackResponse	Authentication response from a service implementation to Authlete.
AuthorizationAuthenticateRequest	Request to Authlete's /auth/authorization/authenticate API.
AuthorizationAuthenticateResponse	Response from Authlete's /auth/authorization/authenticate API.
AuthorizationFailRequest	Request to Authlete's /auth/authorization/fail API.
AuthorizationFailResponse	Response from Authlete's /auth/authorization/fail API.
AuthorizationIssueRequest	Request to Authlete's /auth/authorization/issue API.
AuthorizationIssueResponse	Response from Authlete's /auth/authorization/issue API.
AuthorizationRequest	Request to Authlete's /auth/authorization API.
AuthorizationResponse	Response from Authlete's /auth/authorization API.
AuthorizationTicketInfo	Information about a ticket that has been issued from the /auth/authorization API.
AuthorizationTicketInfoRequest	Request to Authlete's /auth/authorization/ticket/info API.
AuthorizationTicketInfoResponse	Response from Authlete's /auth/authorization/ticket/info API.
AuthorizationTicketUpdateRequest	Request to Authlete's /auth/authorization/ticket/update API.
AuthorizationTicketUpdateResponse	Response from Authlete's /auth/authorization/ticket/update API.
AuthorizedClientListResponse	Response from Authlete's /client/authorization/get/list API.
AuthzDetails	A class that represents authorization_details which is defined in "OAuth 2.0 Rich Authorization Requests".
AuthzDetailsDeserializer	JSON deserializer for AuthzDetails.
AuthzDetailsElement	A class that represents an element in authorization_details which is defined in "OAuth 2.0 Rich Authorization Requests".
AuthzDetailsElementDeserializer	JSON deserializer for AuthzDetailsElement.
AuthzDetailsElementSerializer	JSON serializer for AuthzDetailsElement.
AuthzDetailsSerializer	JSON serializer for AuthzDetails.
BackchannelAuthenticationCompleteRequest	Request to Authlete's /api/backchannel/authentication/complete API.
BackchannelAuthenticationCompleteResponse	Response from Authlete's /api/backchannel/authentication/complete API.
BackchannelAuthenticationFailRequest	Request to Authlete's /api/backchannel/authentication/fail API.
BackchannelAuthenticationFailResponse	Response from Authlete's /api/backchannel/authentication/fail API.
BackchannelAuthenticationIssueRequest	Request to Authlete's /api/backchannel/authentication/issue API.
BackchannelAuthenticationIssueResponse	Response from Authlete's /api/backchannel/authentication/issue API.
BackchannelAuthenticationRequest	Request to Authlete's /api/backchannel/authentication API.
BackchannelAuthenticationResponse	Response from Authlete's /api/backchannel/authentication API.
ClaimRule	A rule for processing a claim.
Client	Information about a client application.
ClientAuthorizationDeleteRequest	Request to Authlete's /api/client/authorization/delete/{clientId} API.
ClientAuthorizationGetListRequest	Request to Authlete's /api/client/authorization/get/list API.
ClientAuthorizationUpdateRequest	Request to Authlete's /client/authorization/update/{clientId} API.
ClientExtension	Client extension.
ClientListResponse	Response from Authlete's /client/get/list API.
ClientLockFlagUpdateRequest	Request to Authlete's /api/client/lock_flag/update/{clientIdentifier} API.
ClientRegistrationRequest	Request to Authlete's /api/client/registration/ API.
ClientRegistrationResponse	Response from Authlete's /api/client/registration API.
ClientSecretRefreshResponse	Response from Authlete's /api/client/secret/refresh API.
ClientSecretUpdateRequest	Request to Authlete's /api/client/secret/update API.
ClientSecretUpdateResponse	Response from Authlete's /api/client/secret/update API.
CredentialBatchIssueRequest	A request to Authlete's /vci/batch/issue API.
CredentialBatchIssueResponse	A response from Authlete's /vci/batch/issue API.
CredentialBatchParseRequest	Request to the /vci/batch/parse API.
CredentialBatchParseResponse	Response from the /vci/batch/parse API.
CredentialDeferredIssueRequest	A request to Authlete's /vci/deferred/issue API.
CredentialDeferredIssueResponse	A response from Authlete's /vci/deferred/issue API.
CredentialDeferredParseRequest	A request to Authlete's /vci/deferred/issue API.
CredentialDeferredParseResponse	Response from the /vci/deferred/parse API.
CredentialIssuanceOrder	Instruction for credential issuance.
CredentialIssuerJwksRequest	Request to Authlete's /vci/jwks API.
CredentialIssuerJwksResponse	Response from Authlete's /vci/jwks API.
CredentialIssuerMetadata	A class that represents the set of credential issuer metadata.
CredentialIssuerMetadataRequest	Request to Authlete's /vci/metadata API.
CredentialIssuerMetadataResponse	Response from Authlete's /vci/metadata API.
CredentialJwtIssuerMetadataRequest	Request to Authlete's /vci/jwtissuer API.
CredentialJwtIssuerMetadataResponse	Response from Authlete's /vci/jwtissuer API.
CredentialOfferCreateRequest	Request to Authlete's /vci/offer/create API.
CredentialOfferCreateResponse	Response from Authlete's /vci/offer/create API.
CredentialOfferInfo	Information about a credential offer.
CredentialOfferInfoRequest	Request to Authlete's /vci/offer/info API.
CredentialOfferInfoResponse	Response from Authlete's /vci/offer/info API.
CredentialRequestInfo	Information about a credential request.
CredentialSingleIssueRequest	A request to Authlete's /vci/single/issue API.
CredentialSingleIssueResponse	A response from Authlete's /vci/single/issue API.
CredentialSingleParseRequest	Request to the /vci/single/parse API.
CredentialSingleParseResponse	Response from the /vci/single/parse API.
DeveloperAuthenticationCallbackRequest	Developer authentication request from Authlete to a service implementation.
DeveloperAuthenticationCallbackResponse	Developer authentication response from a service implementation to Authlete.
DeviceAuthorizationRequest	Request to Authlete's /api/device/authorization API.
DeviceAuthorizationResponse	Response from Authlete's /api/device/authorization API.
DeviceCompleteRequest	Request to Authlete's /api/device/complete API.
DeviceCompleteResponse	Response from Authlete's /api/device/complete API.
DeviceVerificationRequest	Request to Authlete's /api/device/verification API.
DeviceVerificationResponse	Response from Authlete's /api/device/verification API.
DynamicScope	Dynamic Scope.
FederationConfigurationRequest	Request to Authlete's /federation/configuration API.
FederationConfigurationResponse	Response from Authlete's /federation/configuration API.
FederationRegistrationRequest	Request to Authlete's /federation/registration API.
FederationRegistrationResponse	Response from Authlete's /federation/registration API.
GMRequest	Request to Authlete's /api/gm API.
GMResponse	Response from Authlete's /api/gm API.
Grant	Grant.
GrantDeserializer	JSON deserializer for Grant.
GrantedScopesGetResponse	Response from Authlete's /client/granted_scopes/get/{clientId} API.
GrantScope	Scope representation in a grant.
GrantSerializer	JSON serializer for Grant.
Hsk	Hardware-secured key.
HskCreateRequest	Request to Authlete's /api/hsk/create API.
HskListResponse	Response from Authlete's /api/hsk/get/list API.
HskResponse	Response from Authlete's /api/hsk/create API, /api/hsk/delete/{handle} API and /api/hsk/get/{handle} API.
IDTokenReissueRequest	A request to Authlete's /idtoken/reissue API.
IDTokenReissueResponse	A response from Authlete's /idtoken/reissue API.
IntrospectionRequest	Request to Authlete's /auth/introspection API.
IntrospectionResponse	Response from Authlete's /auth/introspection API.
JoseVerifyRequest	Request to Authlete's /api/jose/verify API.
JoseVerifyResponse	Response from Authlete's /api/jose/verify API.
NamedUri	Named URI.
Pair	A pair of a string key and a string value.
Property	Property that consists of a string key and a string value.
PushedAuthReqRequest	Request to Authlete's /api/pushed_auth_req API.
PushedAuthReqResponse	Response from Authlete's /api/pushed_auth_req API.
ResourceServerSignatureRequest	Request to Authlete's /api/rs/sign API.
ResourceServerSignatureResponse	Response from Authlete's /api/rs/sign API.
RevocationRequest	Request to Authlete's /auth/revocation API.
RevocationResponse	Response from Authlete's /auth/revocation API.
Scope	Information about a scope of a service.
Scope.NameComparator	Comparator based on scope names.
Service	Information about a service.
ServiceConfigurationRequest	The request parameters of Authlete's /service/configuration API.
ServiceCreatableResponse	Response from Authlete's /api/service/creatable API.
ServiceListResponse	Response from Authlete's /service/get/list API.
ServiceOwner	Information about a service owner.
SnsCredentials	SNS credentials (API key and API secret).
StandardIntrospectionRequest	Request to Authlete's /api/auth/introspection/standard API.
StandardIntrospectionResponse	Response from Authlete's /api/auth/introspection/standard API.
StringArray	A class that holds a string array.
TaggedValue	A string value with a language tag
TokenBatchStatus	The status of token batch.
TokenCreateBatchResponse	Response from Authlete's /auth/token/create/batch API.
TokenCreateBatchStatusRequest	The request to /auth/token/create/batch/status API.
TokenCreateBatchStatusResponse	Response from Authlete's /auth/token/create/batch/status API.
TokenCreateRequest	Request to Authlete's /auth/token/create API.
TokenCreateResponse	Response from Authlete's /auth/token/create API.
TokenFailRequest	Request for Authlete's /auth/token/fail API.
TokenFailResponse	Response from Authlete's /auth/token/fail API.
TokenInfo	Information about a token of the type "urn:ietf:params:oauth:token-type:access_token" or the type "urn:ietf:params:oauth:token-type:refresh_token".
TokenIssueRequest	Request to Authlete's /auth/token/issue API.
TokenIssueResponse	Response from Authlete's /auth/token/issue endpoint.
TokenListResponse	Response from Authlete's /auth/token/get/list API.
TokenRequest	Request to Authlete's /auth/token API.
TokenResponse	Response from Authlete's /auth/token API.
TokenRevokeRequest	Request to Authlete's /auth/token/revoke API.
TokenRevokeResponse	Response from Authlete's /auth/token/revoke API.
TokenUpdateRequest	Request to Authlete's /auth/token/update API.
TokenUpdateResponse	Response from Authlete's /auth/token/update API.
TrustAnchor	Trust anchor.
UserInfoIssueRequest	Request to Authlete's /auth/userinfo/issue API.
UserInfoIssueResponse	Response from Authlete's /auth/userinfo/issue API.
UserInfoRequest	Request to Authlete's /auth/userinfo API.
UserInfoResponse	Response from Authlete's /auth/userinfo API.

Enum Summary

Enum	Description
AuthorizationAuthenticateResponse.Action	The next action that the service implementation should take.
AuthorizationFailRequest.Reason	Failure reasons of authorization requests.
AuthorizationFailResponse.Action	The next action that the service implementation should take.
AuthorizationIssueResponse.Action	The next action that the service implementation should take.
AuthorizationResponse.Action	The next action that the service implementation should take.
AuthorizationTicketInfoResponse.Action	The result of the /auth/authorization/ticket/info API call.
AuthorizationTicketUpdateResponse.Action	The result of the /auth/authorization/ticket/update API call.
BackchannelAuthenticationCompleteRequest.Result	Types of results of end-user authentication and authorization.
BackchannelAuthenticationCompleteResponse.Action	The next action that the OpenID provider implementation should take.
BackchannelAuthenticationFailRequest.Reason	Failure reasons of backchannel authentication requests.
BackchannelAuthenticationFailResponse.Action	The next action that the OpenID provider implementation should take.
BackchannelAuthenticationIssueResponse.Action	The next action that the OpenID provider implementation should take.
BackchannelAuthenticationResponse.Action	The next action that the OpenID provider implementation should take.
ClientRegistrationResponse.Action	The next action that the implementation of client registration endpoint should take.
CredentialBatchIssueResponse.Action	The next action that the implementation of the batch credential endpoint should take.
CredentialBatchParseResponse.Action	The next action that the implementation of the batch credential endpoint should take.
CredentialDeferredIssueResponse.Action	The next action that the implementation of the deferred credential endpoint should take.
CredentialDeferredParseResponse.Action	The next action that the deferred credential endpoint should take.
CredentialIssuerJwksResponse.Action	The next action that the implementation of the JWK Set document endpoint of the credential issuer should take after getting a response from Authlete's /vci/jwks API.
CredentialIssuerMetadataResponse.Action	The next action that the implementation of the credential issuer metadata endpoint (/.well-known/openid-credential-issuer) should take after getting a response from Authlete's /vci/metadata API.
CredentialJwtIssuerMetadataResponse.Action	The next action that the implementation of the JWT issuer metadata endpoint (/.well-known/jwt-vc-issuer) should take after getting a response from Authlete's /vci/jwtissuer API.
CredentialOfferCreateResponse.Action	The result of the /vci/offer/create API call.
CredentialOfferInfoResponse.Action	The result of the /vci/offer/info API call.
CredentialSingleIssueResponse.Action	The next action that the implementation of the credential endpoint should take.
CredentialSingleParseResponse.Action
DeviceAuthorizationResponse.Action	The next action that the authorization server implementation should take.
DeviceCompleteRequest.Result	Types of results of end-user authentication and authorization.
DeviceCompleteResponse.Action	The next action that the authorization server implementation should take.
DeviceVerificationResponse.Action	The next action that the authorization server implementation should take.
FederationConfigurationResponse.Action	The next action that the implementation of the entity configuration endpoint should take after getting a response from Authlete's /federation/configuration API.
FederationRegistrationResponse.Action	The next action that the implementation of the federation registration endpoint should take.
GMResponse.Action	The next action the service implementation should take.
HskListResponse.Action	The result of the API call.
HskResponse.Action	The result of the API call.
IDTokenReissueResponse.Action	The next action that the implementation of the token endpoint should take.
IntrospectionResponse.Action	The next action the service implementation should take.
PushedAuthReqResponse.Action	The next action the authorization server should take.
ResourceServerSignatureResponse.Action	The next action the resource server implementation should take.
RevocationResponse.Action	The next action that the service implementation should take.
StandardIntrospectionResponse.Action	The next action that the implementation of the introspection endpoint of the authorization server should take.
TokenBatchStatus.BatchKind	Batch Kind.
TokenBatchStatus.Result	Batch result.
TokenCreateResponse.Action	The code indicating how the response should be interpreted.
TokenFailRequest.Reason	Failure reasons of token requests.
TokenFailResponse.Action	The next action that the service implementation should take.
TokenIssueResponse.Action	The next action that the service implementation should take.
TokenResponse.Action	The next action that the service implementation should take.
TokenUpdateResponse.Action	The code indicating how the response should be interpreted.
UserInfoIssueResponse.Action	The next action the service implementation should take.
UserInfoResponse.Action	The next action the service implementation should take.