All Classes

Class	Description
AccessRight	Utility class to describe the possible values used in the RAR objects when accessing the Authlete API with an access token.
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.
ApplicationType	Values for application_type.
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.
AssertionTarget	The part of the service that an assertion processor will be applied to.
AttachmentType	Values for attachments_supported.
AuthenticationCallbackRequest	Authentication request from Authlete to a service implementation.
AuthenticationCallbackResponse	Authentication response from a service implementation to Authlete.
AuthleteApi	Authlete API.
AuthleteApiException	Authlete API exception.
AuthleteApiFactory	Factory to create an AuthleteApi instance.
AuthleteApiVersion	Authlete API version.
AuthleteConfiguration	Authlete configuration.
AuthleteEnvConfiguration	Implementation of AuthleteConfiguration based on environment variables.
AuthletePropertiesConfiguration	Implementation of AuthleteConfiguration based on a properties file.
AuthleteSimpleConfiguration	POJO implementation of AuthleteConfiguration.
AuthorizationAuthenticateRequest	Request to Authlete's /auth/authorization/authenticate API.
AuthorizationAuthenticateResponse	Response from Authlete's /auth/authorization/authenticate API.
AuthorizationAuthenticateResponse.Action	The next action that the service implementation should take.
AuthorizationFailRequest	Request to Authlete's /auth/authorization/fail API.
AuthorizationFailRequest.Reason	Failure reasons of authorization requests.
AuthorizationFailResponse	Response from Authlete's /auth/authorization/fail API.
AuthorizationFailResponse.Action	The next action that the service implementation should take.
AuthorizationIssueRequest	Request to Authlete's /auth/authorization/issue API.
AuthorizationIssueResponse	Response from Authlete's /auth/authorization/issue API.
AuthorizationIssueResponse.Action	The next action that the service implementation should take.
AuthorizationRequest	Request to Authlete's /auth/authorization API.
AuthorizationResponse	Response from Authlete's /auth/authorization API.
AuthorizationResponse.Action	The next action that the service implementation should take.
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.
AuthorizationTicketInfoResponse.Action	The result of the /auth/authorization/ticket/info API call.
AuthorizationTicketUpdateRequest	Request to Authlete's /auth/authorization/ticket/update API.
AuthorizationTicketUpdateResponse	Response from Authlete's /auth/authorization/ticket/update API.
AuthorizationTicketUpdateResponse.Action	The result of the /auth/authorization/ticket/update API call.
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.
BackchannelAuthenticationCompleteRequest.Result	Types of results of end-user authentication and authorization.
BackchannelAuthenticationCompleteResponse	Response from Authlete's /api/backchannel/authentication/complete API.
BackchannelAuthenticationCompleteResponse.Action	The next action that the OpenID provider implementation should take.
BackchannelAuthenticationFailRequest	Request to Authlete's /api/backchannel/authentication/fail API.
BackchannelAuthenticationFailRequest.Reason	Failure reasons of backchannel authentication requests.
BackchannelAuthenticationFailResponse	Response from Authlete's /api/backchannel/authentication/fail API.
BackchannelAuthenticationFailResponse.Action	The next action that the OpenID provider implementation should take.
BackchannelAuthenticationIssueRequest	Request to Authlete's /api/backchannel/authentication/issue API.
BackchannelAuthenticationIssueResponse	Response from Authlete's /api/backchannel/authentication/issue API.
BackchannelAuthenticationIssueResponse.Action	The next action that the OpenID provider implementation should take.
BackchannelAuthenticationRequest	Request to Authlete's /api/backchannel/authentication API.
BackchannelAuthenticationResponse	Response from Authlete's /api/backchannel/authentication API.
BackchannelAuthenticationResponse.Action	The next action that the OpenID provider implementation should take.
BaseConstraint	The base class for classes that represent constraints in verified_claims.
BaseJsonDeserializer	The base class for implementations of JsonDeserializer.
BaseJsonSerializer	The base class for implementations of JsonSerializer.
BasicCredentials	Credentials in Basic authentication.
BearerToken	Utility class for Bearer Token defined in RFC 6750.
ClaimRule	A rule for processing a claim.
ClaimRuleOperation	The operation that a claim rule will apply to any claims it processes.
Claims	The class that represents verified_claims/claims.
ClaimsConstraint	The class that represents the constraint for verified_claims/claims.
ClaimsScope	Scopes which are used to request claims.
ClaimType	Claim types.
CLI	Command line interface for Authlete API.
Client	Information about a client application.
ClientAssertionType	Client Assertion Type.
ClientAuthMethod	Client authentication methods.
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.
ClientClaims
ClientExtension	Client extension.
ClientListResponse	Response from Authlete's /client/get/list API.
ClientLockFlagUpdateRequest	Request to Authlete's /api/client/lock_flag/update/{clientIdentifier} API.
ClientMetadataControl	Flags to control contents of a map that represents client metadata.
ClientRegistrationRequest	Request to Authlete's /api/client/registration/ API.
ClientRegistrationResponse	Response from Authlete's /api/client/registration API.
ClientRegistrationResponse.Action	The next action that the implementation of client registration endpoint should take.
ClientRegistrationType	Values for the client_registration_types RP metadata and the client_registration_types_supported OP metadata that are defined in OpenID Federation 1.0.
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.
ClientType	Client types of OAuth 2.0 client applications.
CodeChallengeMethod	Values for code_challenge_method.
Constraint	The basic interface that classes representing constraints in verified_claims implement.
ConstraintException	An exception that indicates the structure does not conform to the specification (OpenID Connect for Identity Assurance 1.0).
ConstraintValidator	Validator for constraints in verified_claims.
CredentialBatchIssueRequest	A request to Authlete's /vci/batch/issue API.
CredentialBatchIssueResponse	A response from Authlete's /vci/batch/issue API.
CredentialBatchIssueResponse.Action	The next action that the implementation of the batch credential endpoint should take.
CredentialBatchParseRequest	Request to the /vci/batch/parse API.
CredentialBatchParseResponse	Response from the /vci/batch/parse API.
CredentialBatchParseResponse.Action	The next action that the implementation of the batch credential endpoint should take.
CredentialDeferredIssueRequest	A request to Authlete's /vci/deferred/issue API.
CredentialDeferredIssueResponse	A response from Authlete's /vci/deferred/issue API.
CredentialDeferredIssueResponse.Action	The next action that the implementation of the deferred credential endpoint should take.
CredentialDeferredParseRequest	A request to Authlete's /vci/deferred/issue API.
CredentialDeferredParseResponse	Response from the /vci/deferred/parse API.
CredentialDeferredParseResponse.Action	The next action that the deferred credential endpoint should take.
CredentialIssuanceOrder	Instruction for credential issuance.
CredentialIssuerJwksRequest	Request to Authlete's /vci/jwks API.
CredentialIssuerJwksResponse	Response from Authlete's /vci/jwks API.
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.
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.
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.
CredentialJwtIssuerMetadataRequest	Request to Authlete's /vci/jwtissuer API.
CredentialJwtIssuerMetadataResponse	Response from Authlete's /vci/jwtissuer 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.
CredentialOfferCreateRequest	Request to Authlete's /vci/offer/create API.
CredentialOfferCreateResponse	Response from Authlete's /vci/offer/create API.
CredentialOfferCreateResponse.Action	The result of the /vci/offer/create API call.
CredentialOfferInfo	Information about a credential offer.
CredentialOfferInfoRequest	Request to Authlete's /vci/offer/info API.
CredentialOfferInfoResponse	Response from Authlete's /vci/offer/info API.
CredentialOfferInfoResponse.Action	The result of the /vci/offer/info API call.
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.
CredentialSingleIssueResponse.Action	The next action that the implementation of the credential endpoint should take.
CredentialSingleParseRequest	Request to the /vci/single/parse API.
CredentialSingleParseResponse	Response from the /vci/single/parse API.
CredentialSingleParseResponse.Action
DatasetExtractor	A utility to extract a dataset that meets conditions specified by a verified_claims request.
DeliveryMode	Backchannel token delivery mode defined in the specification of CIBA (Client Initiated Backchannel Authentication).
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.
DeviceAuthorizationResponse.Action	The next action that the authorization server implementation should take.
DeviceCompleteRequest	Request to Authlete's /api/device/complete API.
DeviceCompleteRequest.Result	Types of results of end-user authentication and authorization.
DeviceCompleteResponse	Response from Authlete's /api/device/complete API.
DeviceCompleteResponse.Action	The next action that the authorization server implementation should take.
DeviceVerificationRequest	Request to Authlete's /api/device/verification API.
DeviceVerificationResponse	Response from Authlete's /api/device/verification API.
DeviceVerificationResponse.Action	The next action that the authorization server implementation should take.
Display	Values for display.
Document	The class that represents id_document/document.
DocumentConstraint	The class that represents the constraint for id_document/document.
DpopToken	Utility class for DPoP Token.
DynamicScope	Dynamic Scope.
EntityType	Entity type identifiers in the context of the OpenID Federation 1.0.
ErrorCode	Values for error from OAuth 2.0 endpoints.
Evidence	The class that represents elements in verified_claims/verification/evidence.
EvidenceArray	The class that represents verified_claims/verification/evidence.
EvidenceArrayConstraint	The class that represents the constraint for verified_claims/verification/evidence.
EvidenceConstraint	The class that represents the constraint for elements in verified_claims/verification/evidence.
FapiMode	FAPI mode.
FapiUtils	Utilities for Financial-grade API (FAPI).
FederationConfigurationRequest	Request to Authlete's /federation/configuration API.
FederationConfigurationResponse	Response from Authlete's /federation/configuration API.
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.
FederationRegistrationRequest	Request to Authlete's /federation/registration API.
FederationRegistrationResponse	Response from Authlete's /federation/registration API.
FederationRegistrationResponse.Action	The next action that the implementation of the federation registration endpoint should take.
GMAction	Grant Management Action.
GMRequest	Request to Authlete's /api/gm API.
GMResponse	Response from Authlete's /api/gm API.
GMResponse.Action	The next action the service implementation should take.
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.
GrantType	Values for grant_type.
HashAlg	Hash algorithm.
HokMethod	Values for Holder-of-Key method.
Hsk	Hardware-secured key.
HskCreateRequest	Request to Authlete's /api/hsk/create API.
HskListResponse	Response from Authlete's /api/hsk/get/list API.
HskListResponse.Action	The result of the API call.
HskResponse	Response from Authlete's /api/hsk/create API, /api/hsk/delete/{handle} API and /api/hsk/get/{handle} API.
HskResponse.Action	The result of the API call.
HSM	Hardware Security Module.
IDDocument	The class that represents id_document.
IDDocumentConstraint	The class that represents the constraint for id_document.
IdentityAssuranceException	An exception that indicates the structure does not conform to the specification (OpenID Connect for Identity Assurance 1.0).
IdTokenClaims	Claims used within the ID Token for all OAuth 2.0 flows used by OpenID Connect.
IDTokenReissueRequest	A request to Authlete's /idtoken/reissue API.
IDTokenReissueResponse	A response from Authlete's /idtoken/reissue API.
IDTokenReissueResponse.Action	The next action that the implementation of the token endpoint should take.
IntrospectionRequest	Request to Authlete's /auth/introspection API.
IntrospectionResponse	Response from Authlete's /auth/introspection API.
IntrospectionResponse.Action	The next action the service implementation should take.
Issuer	The class that represents id_document/document/issuer.
IssuerConstraint	The class that represents the constraint for id_document/document/issuer.
JoseUtils	Utilities for JOSE (JavaScript Object Signing and Encryption).
JoseVerifyRequest	Request to Authlete's /api/jose/verify API.
JoseVerifyResponse	Response from Authlete's /api/jose/verify API.
JWEAlg	"alg" (Algorithm) Header Parameter Values for JWE.
JWEEnc	"enc" (Encryption Algorithm) Header Parameter Values for JWE.
JWSAlg	"alg" (Algorithm) Header Parameter Values for JWS.
LeafConstraint	The class that represents the basic set of constraints defined in "5.5.1.
MapControl	Flags to control contents of a map.
MapUtils	Utility for Map.
MutableJsonPointer	Mutable JSON Pointer.
NamedUri	Named URI.
Pair	A pair of a string key and a string value.
Plan	Plan.
Prompt	Values for prompt.
PropertiesLoader	Properties loader.
PropertiesLoader.FileLocation	File location types.
PropertiesWrapper	Properties wrapper.
Property	Property that consists of a string key and a string value.
Provider	The class that represents utility_bill/provider.
ProviderConstraint	The class that represents the constraint for utility_bill/provider.
PushedAuthReqRequest	Request to Authlete's /api/pushed_auth_req API.
PushedAuthReqResponse	Response from Authlete's /api/pushed_auth_req API.
PushedAuthReqResponse.Action	The next action the authorization server should take.
QES	The class that represents qes.
QESConstraint	The class that represents the constraint for qes.
ResourceServerSignatureRequest	Request to Authlete's /api/rs/sign API.
ResourceServerSignatureResponse	Response from Authlete's /api/rs/sign API.
ResourceServerSignatureResponse.Action	The next action the resource server implementation should take.
ResponseMode	Values for response_mode.
ResponseType	Values for response_type.
RevocationRequest	Request to Authlete's /auth/revocation API.
RevocationResponse	Response from Authlete's /auth/revocation API.
RevocationResponse.Action	The next action that the service implementation should take.
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.
ServiceProfile	Service profile.
Settings	Settings of AuthleteApi implementation.
Sns
SnsCredentials	SNS credentials (API key and API secret).
StandardClaims	Standard claims.
StandardIntrospectionRequest	Request to Authlete's /api/auth/introspection/standard API.
StandardIntrospectionResponse	Response from Authlete's /api/auth/introspection/standard API.
StandardIntrospectionResponse.Action	The next action that the implementation of the introspection endpoint of the authorization server should take.
StandardScope	Scopes defined by related specifications.
StringArray	A class that holds a string array.
StringBasedTypedProperties	This is an abstract class that provides getters and setters for key-value pairs.
SubjectType	Values for subject_type.
TaggedValue	A string value with a language tag
TimeConstraint	The class that represents the basic set of constraints + max_age.
TokenBatchStatus	The status of token batch.
TokenBatchStatus.BatchKind	Batch Kind.
TokenBatchStatus.Result	Batch result.
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.
TokenCreateResponse.Action	The code indicating how the response should be interpreted.
TokenFailRequest	Request for Authlete's /auth/token/fail API.
TokenFailRequest.Reason	Failure reasons of token requests.
TokenFailResponse	Response from Authlete's /auth/token/fail API.
TokenFailResponse.Action	The next action that the service implementation should take.
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.
TokenIssueResponse.Action	The next action that the service implementation should take.
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.
TokenResponse.Action	The next action that the service implementation should take.
TokenRevokeRequest	Request to Authlete's /auth/token/revoke API.
TokenRevokeResponse	Response from Authlete's /auth/token/revoke API.
TokenStatus	Token status.
TokenType	Token types registered at OAuth URI of OAuth Parameters of IANA (Internet Assigned Numbers Authority).
TokenUpdateRequest	Request to Authlete's /auth/token/update API.
TokenUpdateResponse	Response from Authlete's /auth/token/update API.
TokenUpdateResponse.Action	The code indicating how the response should be interpreted.
TrustAnchor	Trust anchor.
TypedProperties	This is an abstract class that provides getters and setters for key-value pairs.
URLCoder	URL encoder/decoder.
User	An interface that represents a resource owner (in the context of OAuth 2.0) or an end user (in the context of OpenID Connect).
UserCodeCharset	Character set for end-user verification codes (user_code) in Device Flow.
UserCodeGenerator	Generator for end-user verification codes (user_code) in Device Flow.
UserIdentificationHintType	Types of hints for end-user identification.
UserInfoIssueRequest	Request to Authlete's /auth/userinfo/issue API.
UserInfoIssueResponse	Response from Authlete's /auth/userinfo/issue API.
UserInfoIssueResponse.Action	The next action the service implementation should take.
UserInfoRequest	Request to Authlete's /auth/userinfo API.
UserInfoResponse	Response from Authlete's /auth/userinfo API.
UserInfoResponse.Action	The next action the service implementation should take.
UtilityBill	The class that represents utility_bill.
UtilityBillConstraint	The class that represents the constraint for utility_bill.
Utils
Verification	The class that represents verified_claims/verification.
VerificationConstraint	The class that represents the constraint for verified_claims/verification.
VerifiedClaimConstraint	The class that represents the constraint for claims in verified_claims/claims.
VerifiedClaims	The class that represents verified_claims.
VerifiedClaimsConstraint	The class that represents the constraint for verified_claims.
VerifiedClaimsContainerConstraint	The class that represents the constraint which includes verified_claims.
Verifier	The class that represents id_document/verifier.
VerifierConstraint	The class that represents the constraint for id_document/verifier.
Version	A class that represents a version number consisting of a major number, a minor number and a patch number.