AuthRedirectController class

Controller for issuing OAuth 2.0 authorization codes and tokens.

This controller provides an endpoint for creating an OAuth 2.0 authorization code or access token. An authorization code can be exchanged for an access token with an AuthController. This is known as the OAuth 2.0 'Authorization Code Grant' flow. Returning an access token is known as the OAuth 2.0 'Implicit Grant' flow.

See operation methods getAuthorizationPage and authorize for more details.

Usage:

  router
    .route("/auth/code")
    .link(() => new AuthRedirectController(authServer));
Inheritance

Constructors

AuthRedirectController(AuthServer authServer, {AuthRedirectControllerDelegate? delegate, bool allowsImplicit = true})
Creates a new instance of an AuthRedirectController.

Properties

acceptedContentTypes ↔ List<ContentType>
Types of content this ResourceController will accept.
getter/setter pairinherited
allowsImplicit → bool
When true, the controller allows for the Implicit Grant Flow
final
authServer ↔ AuthServer
A reference to the AuthServer used to grant authorization codes and access tokens.
latefinal
clientID ↔ String?
The client ID of the authenticating client.
getter/setter pair
delegate → AuthRedirectControllerDelegate?
Renders an HTML login form.
final
hashCode → int
The hash code for this object.
no setterinherited
logger → Logger
An instance of the 'conduit' logger.
no setterinherited
nextController → Controller?
Receives requests that this controller does not respond to.
no setterinherited
pathVariables → Map<String, String>
Parameters parsed from the URI of the request, if any exist.
no setterinherited
policy ↔ CORSPolicy?
The CORS policy of this controller.
getter/setter pairinherited
recycledState → void
Returns state information that is reused across instances of this type.
no setterinherited
request ↔ Request?
The request being processed by this ResourceController.
getter/setter pairinherited
responseContentType ↔ ContentType
The default content type of responses from this ResourceController.
getter/setter pairinherited
responseType ↔ String?
Must be 'code' or 'token'.
getter/setter pair
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
state ↔ String?
A randomly generated value the client can use to verify the origin of the redirect.
getter/setter pair

Methods

applyCORSHeadersIfNecessary(Request req, Response resp) → void
inherited
authorize({String? username, String? password, String? scope}) → Future<Response>
Creates a one-time use authorization code or an access token.
didAddToChannel() → void
Lifecycle callback, invoked after added to channel, but before any requests are served.
inherited
didDecodeRequestBody(RequestBody body) → void
Callback to indicate when a request body has been processed.
inherited
documentComponents(APIDocumentContext context) → void
Tells this object to add its components to context.
inherited
documentOperationDescription(APIDocumentContext context, Operation? operation) → String?
Returns a documented description for operation.
inherited
documentOperationParameters(APIDocumentContext context, Operation? operation) → List<APIParameter>
Returns a documented list of APIParameter for operation.
override
documentOperationRequestBody(APIDocumentContext context, Operation? operation) → APIRequestBody?
Returns a documented request body for operation.
override
documentOperationResponses(APIDocumentContext context, Operation? operation) → Map<String, APIResponse>
Returns a map of possible responses for operation.
override
documentOperations(APIDocumentContext context, String route, APIPath path) → Map<String, APIOperation>
Tells this object to return all APIOperations it handles.
override
documentOperationSummary(APIDocumentContext context, Operation? operation) → String?
Returns a documented summary for operation.
inherited
documentOperationTags(APIDocumentContext context, Operation? operation) → List<String>
Returns a list of tags for operation.
inherited
documentPaths(APIDocumentContext context) → Map<String, APIPath>
Tells this object to return all APIPaths it handles.
inherited
getAuthorizationPage({String? scope}) → Future<Response>
Returns an HTML login form.
handle(Request request) → FutureOr<RequestOrResponse>
The primary request handling method of this object.
inherited
handleError(Request request, dynamic caughtValue, StackTrace trace) → Future
Sends an HTTP response for a request that yields an exception or error.
inherited
Links a controller to the receiver to form a request channel.
inherited
linkFunction(FutureOr<RequestOrResponse?> handle(Request request)) → Linkable?
Links a function controller to the receiver to form a request channel.
inherited
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
receive(Request req) → Future?
Delivers req to this instance to be processed.
inherited
restore(void state) → void
Provides a instance of this type with the recycledState of this type.
inherited
toString() → String
A string representation of this object.
inherited
willDecodeRequestBody(RequestBody body) → void
Callback invoked prior to decoding a request body.
inherited
willProcessRequest(Request req) → FutureOr<RequestOrResponse>
Executed prior to handling a request, but after the request has been set.
inherited
willSendResponse(Response response) → void
Executed prior to Response being sent.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited