Protocol

Swauthable

All of the authorization flows (AuthorizationCodeFlow, PKCEAuthorizationFlow, DeviceAuthorizationFlow) conform to this protocol.

Declaration

protocol Swauthable

Overview

Swauthable provides some default implementations.

Default implementations are methods or properties that every instance of an object conforming to the protocol will have, much like subclassing. (Every instance of AuthorizationCodeFlow, PKCEAuthorizationFlow, and DeviceAuthorizationFlow will have these properties and methods).

Topics

Default Implementations

var isAuthorized: Bool
True if the keychain instance contains tokens from a token request. If your application has been authorized by the user, will return true. Read-only.
func authenticatedRequest(for: HTTPRequest, numberOfRetries: UInt8) async throws -> HTTPRequest.Response
Sends an authenticated HTTP request to a Web API endpoint. Returns a HTTPRequest.Response.

Instance Properties

var additionalAuthorizationParams: [String : String]?
Additional a authorization parameters.

Required.

var additionalRefreshTokenBodyParams: [String : String]?
Ignore if the server not provide a refresh token. Any additional HTTP body parameters for the token refresh request. The key/value pairs for “refresh_token” and “grant_type” are handled internally when an authenticatedRequest(for:numberOfRetries:) is made.

Required.

var additionalTokenRequestParams: [String : String]?
Any additional parameters for the token request.

Required.

var authHeaderTokenType: String?
Some APIs may use a different key for their authorization header’s token type than the one provided by the token request response.

Required.

var authorizationEndpoint: URL
The server authorization endpoint URL. Is initialized.

Required.

var authorizationParams: [String : String]

Required.

var clientID: String
The client identifier issued by the server. Is initialized.

Required.

var keychain: Keychain
Instance of KeychainAccess. Is initialized.

Required.

var scopes: String?
The scopes you want your app to be authorized for, separated by spaces.

Required.

var tokenEndpoint: URL
The server’s token endpoint URL. Is initialized.

Required.

var tokenRequestParams: [String : String]
The HTTP body parameters for the token request.

Required.

Instance Methods

func authorizationResponseHandler(for: Response) async throws
Handles a Response. Sends a HTTP request to the initialized token endpoint for the tokens.

Required.

func checkRefreshToken(tokens: inout Tokens) async throws
Used Internally, refresh tokens are handled internally by the library.

Relationships

Conforming Types

See Also

Essential

Choosing the Right Authorization Flow
SwAuth provides 3 different OAuth 2.0 authorization flows to use: AuthorizationCodeFlow, PKCEAuthorizationFlow, and DeviceAuthorizationFlow. Choosing which one to use and in what context can be difficult.