/mod.ts | authlete_deno@v1.2.3

import * as authleteDeno from "https://deno.land/x/authlete_deno@v1.2.3/mod.ts";

Namespaces

N AuthorizationDecisionHandler
N AuthorizationFailRequest
N AuthorizationFailResponse
N AuthorizationIssueResponse
N AuthorizationResponse
N IntrospectionRequestHandler
N IntrospectionResponse
N RevocationRequestHandler
N RevocationResponse
N StandardIntrospectionResponse
N TokenFailRequest
N TokenFailResponse
N TokenIssueResponse
N TokenRequestHandler
N TokenResponse
N UserInfoIssueResponse
N UserInfoRequestHandler

Classes

c AccessTokenValidator	Access token validator.
c Address	Address claim that represents a physical mailing address. For more details, see OpenID Connect Core 1.0, 5.1.1. Address Claim.
c ApiResponse	The base class of an API response from an Authlete API.
c ApplicationType	Values for `application_type`.
c AuthleteApiException	Authlete API Exception.
c AuthleteApiFactory	The factory to create an `AuthleteApi` instance.
c AuthleteApiImpl	An implementation of `AuthleteApi` interface.
c AuthletePropertyConfiguration	Implementation of `AuthleteConfiguration` based on a properties file. This is a utility class to load a configuration file that includes properties related to Authlete.
c AuthorizationDecisionHandler	Handler for end-user's decision on the authorization request.
c AuthorizationDecisionHandler.Params	Input parameters for the 'handle' method of AuthorizationRequestHandler class.
c AuthorizationDecisionHandlerSpiAdapter	Empty implementation of `AuthorizationDecisionHandlerSpi` interface.
c AuthorizationFailRequest	Request to Authlete `/auth/authorization/fail` API.
c AuthorizationFailResponse	Response from Authlete `/auth/authorization/fail` API.
c AuthorizationIssueRequest	Request to Authlete `/auth/authorization/issue` API.
c AuthorizationIssueResponse	Response from Authlete `/auth/authorization/issue` API.
c AuthorizationPageModel	The data object to be used when rendering the authorization page.
c AuthorizationRequest	Request to Authlete `/auth/authorization` API.
c AuthorizationRequestBaseHandler abstract	The base class for request handlers that are used in the implementation of an authorization endpoint.
c AuthorizationRequestErrorHandler	Handler for error cases of authorization requests.
c AuthorizationRequestHandlerSpiAdapter	Empty implementation of `AuthorizationRequestHandlerSpi` interface.
c AuthorizationResponse	Response from Authlete `/auth/authorization` API.
c AuthzDetails	A class that represents `authorization_details` which is defined in "OAuth 2.0 Rich Authorization Requests".
c AuthzDetailsElement	A class that represents an element in `authorization_details` which is defined in "OAuth 2.0 Rich Authorization Requests".
c BaseApiRequestHandler abstract	The base class for a handler class that calls Authlete APIs.
c BaseHandler abstract	The base class for a handler class.
c BasicCredentials	Credentials in Basic authentication.
c CacheControl	`'Cache-Control'` header values.
c ClaimCollector	Collector of claim values.
c ClaimType	Claim types.
c Client	Information about a client application.
c ClientAuthMethod	Client authentication methods.
c ClientExtension	Client extension.
c ClientListResponse	Response from Authlete `/client/get/list` API.
c ClientType	Client types of OAuth 2.0 client applications.
c ConfigurationRequestHandler	Handler for requests to an OpenID Provider configuration endpoint.
c ContentType	`'Content-Type'` header values.
c DeliveryMode	Backchannel token delivery mode defined in the specification of CIBA (Client Initiated Backchannel Authentication).
c Display	Values for `display`.
c GrantType	Values for `grant_type`.
c Header	Header properties.
c IntrospectionRequest	Request to Authlete `/auth/introspection` API.
c IntrospectionRequestHandler	Handler for token introspection requests (RFC 7662).
c IntrospectionResponse	Response from Authlete `/auth/introspection` API.
c JWEAlg	`"alg"` (Algorithm) Header Parameter Values for JWE.
c JWEEnc	`"enc"` (Encryption Algorithm) Header Parameter Values for JWE.
c JwksRequestHandler	Handler for requests to an endpoint that exposes JSON Web Key Set (RFC 7517) document.
c JWSAlg	`"alg"` (Algorithm) Header Parameter Values for JWS.
c NamedUri	Named URI.
c NoInteractionHandler	Handler for the case where an authorization request should be processed without user interaction.
c NoInteractionHandlerSpiAdapter	Empty implementation of `AuthorizationRequestHandlerSpi` interface.
c Pair	A pair of a string key and a string value.
c Pragma	`'Pragma'` header values.
c Prompt	Values for `prompt`.
c Property	Property that consists of a string key and a string value.
c ResponseType	From RFC 6749 (OAuth 2.0), 3.1.1. Response Type
c RevocationRequest	Request to Authlete `/auth/revocation` API.
c RevocationRequestHandler	Handler for token revocation requests (RFC 7009).
c RevocationResponse	Response from Authlete `/auth/introspection` API.
c Scope	Information about a scope of a service.
c Service	Information about a service.
c ServiceListResponse	Response from Authlete `/service/get/list` API.
c ServiceProfile	Service profile.
c Sns
c SnsCredentials	SNS credentials (API key and API secret).
c StandardIntrospectionRequest	Request to Authlete `/auth/introspection/standard` API.
c StandardIntrospectionResponse	Request to Authlete `/auth/introspection/standard` API.
c Status	HTTP status code.
c SubjectType	Values for `subject_type`.
c TaggedValue	A string value with a language tag.
c TokenFailRequest	Request to Authlete `/auth/token/fail` API.
c TokenFailResponse	Response from Authlete `/auth/token/fail` API.
c TokenIssueRequest	Request to Authlete `/auth/token/issue` API.
c TokenIssueResponse	Response from Authlete `/auth/token/issue` API.
c TokenRequest	Request to Authlete `/auth/token` API.
c TokenRequestHandler	Handler for token requests to a token endpoint of OAuth 2.0 (RFC 6749).
c TokenRequestHandlerSpiAdapter	Empty implementation of `TokenRequestHandlerSpi` interface.
c TokenResponse	Response from Authlete `/auth/token` API.
c UserClaimProviderAdapter	Interface to get a claim value by specifying a user's subject, a claim name and optionally a language tag.
c UserCodeCharset	Character set for end-user verification codes (`user_code`) in Device Flow.
c UserInfoIssueRequest	Request to Authlete `/auth/userinfo/issue` API
c UserInfoIssueResponse	Response from Authlete `/auth/userinfo/issue` API
c UserInfoRequest	Request to Authlete `/auth/userinfo` API
c UserInfoRequestHandler	Handler for userinfo requests to a "UserInfo Endpoint" defined in OpenID Connect Core 1.0.
c UserInfoRequestHandlerSpiAdapter	Empty implementation of `UserInfoRequestHandlerSpi` interface.

Enums

E AuthorizationFailRequest.Reason	Failure reasons of authorization requests.
E AuthorizationFailResponse.Action	The next action that the service implementation should take.
E AuthorizationIssueResponse.Action	The next action that the service implementation should take.
E AuthorizationResponse.Action
E HashAlg	Hash algorithm.
E IntrospectionResponse.Action	The next action that the service implementation should take.
E RevocationResponse.Action	The next action that the service implementation should take.
E StandardClaims	Standard claims.
E StandardIntrospectionResponse.Action	The next action that the service implementation should take.
E TokenFailRequest.Reason	Failure reasons of token requests.
E TokenFailResponse.Action	The next action that the service implementation should take.
E TokenIssueResponse.Action	The next action that the service implementation should take.
E TokenResponse.Action	The next action that the service implementation should take.
E UserInfoIssueResponse.Action	The next action that the service implementation should take.

Variables

v CLAIM_SEPARATOR	Separator between a claim name and a language tag.
v STANDARD_IMPL_INFO	The information about the standard implementation of `AuthleteApi` interface.

Functions

f badRequest	Create a response of `'400 Bad Request'` formatted in `'application/json; charset=utf-8'`.
f buildResponse	Build a `Response` object.
f created	Create a response of `'201 Created'` with the given content formatted in `'application/json; charset=utf-8'`.
f forbidden	Create a response of `'403 Forbidden'` formatted in `'application/json; charset=utf-8'`.
f formUrlEncode	Convert the given object to a string formatted in `'application/x-www-form-urlencoded'`
f internalServerError	Create a response of `'500 Internal Server Error'` formatted in the given type. The `type` parameter defaults to `ContentType.APPLICATION_JSON_UTF8` (= `application/javascript; charset=utf-8`).
f invalidAction	Create a `Response` instance that indicates the value of `action` parameter contained in a response from an Authlete API is invalid.
f isEmpty	Check if the given value is empty.
f isNotEmpty	Check if the given value is not empty.
f isNotUndefined	Check if the given value is `undefined`.
f isObject	Check if the given value is an object.
f isString	Check if the given value is an object.
f isUndefined	Check if the given value is `undefined`.
f isUndefinedOrNull	Check if the given value is `undefined` or `null`.
f location	Create a response of `'302 Found'` with the given location.
f noContent	Create a response of `'204 No Content'`.
f normalizeParameters	Normalize the given parameter as `parameters` parameter for some Authlete APIs such as `/api/auth/authorization` API and `/api/auth/token` API.
f notFound	Create a response of `'404 Not Found'` formatted in `'application/json; charset=utf-8'`.
f ok	Create a response of `'200 OK'` with the given content formatted in the given type. The `type` parameter defaults to `ContentType.APPLICATION_JSON_UTF8` (= `application/javascript; charset=utf-8`).
f okHtml	Create a response of `'200 OK'` with the given content formatted in `'text/html; charset=utf-8'`.
f okJavascript	Create a response of `'200 OK'` with the given content formatted in `'application/javascript; charset=utf-8'`.
f okJson	Create a response of `'200 OK'` with the given content formatted in `'application/json; charset=utf-8'`.
f okJwt	Create a response of `'200 OK'` with the given content formatted in `'application/jwt'`.
f stringfyJson	Convert a JavaScript value to a JSON string. `null` is returned if failed to stringfy the value.
f unauthorized	Create a response of `'401 Unauthorized'` formatted in `'application/json; charset=utf-8'`.
f unknownAction	Create a `Response` instance that indicates the value of `action` parameter contained in a response from an Authlete API is unknown.
f wwwAuthenticate	Create a response with the given status and `WWW-Authenticate` header having the given challenge as its value.

Interfaces

I AuthleteApi	Authlete API Interface.
I AuthleteConfiguration	The interface for configuration.
I AuthorizationDecisionHandlerSpi	Service Provider Interface to work with `AuthorizationDecisionHandler`.
I AuthorizationRequestHandlerSpi	Service Provider Interface to work with `AuthorizationRequestHandler`.
I NoInteractionHandlerSpi	Service Provider Interface to work with `AuthorizationRequestHandler`.
I RevocationRequestHandler.Params	Input parameters for the `handle()` method of `RevocationRequestHandler` class.
I TokenRequestHandler.Params	Input parameters for the `handle()` method of `TokenRequestHandler` class.
I TokenRequestHandlerSpi	Service Provider Interface to work with `TokenRequestHandler`.
I 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).
I UserClaimProvider	Interface to get a claim value by specifying a user's subject, a claim name and optionally a language tag.
I UserInfoRequestHandler.Params	Input parameters for the `handle()` method of `UserInfoRequestHandler` class.
I UserInfoRequestHandlerSpi	Service Provider Interface to work with `UserInfoRequestHandler`.

Type Aliases

T ImplInfo	The alias for the type of an object holding information about an implementation class of `AuthleteApi` interface.
T IntrospectionRequestHandler.parametersType	The type of 'parameters' parameter passed to the `handle()` method in `IntrospectionRequestHandler` class.