EXTENSION

OAuthTokenManager

public extension OAuthTokenManager

Methods

fetchAccessToken(with:dpop:additionalParameters:completionHandler:)

func fetchAccessToken(with authorizationCode: String,
                      dpop: Dpop? = nil,
                      additionalParameters: [String: String]? = nil,
                      completionHandler: @escaping @Sendable OAuthCompletion)

Fetches an access token using an authorization code grant. If it succeeds then a SuccessfulTokenResponse with the access token is returned. If it fails either a ErrorTokenResponse with the error reason is returned or the result has an Error.

Parameters

Name Description
authorizationCode The authorization code.
dpop The Dpop that was used during the Haapi flow. When it is required, this value has to be used via HaapiManager.dpop.
additionalParameters The additional parameters for the request body. The default value is nil.
completionHandler A completion handler that is called when fetchAccessToken is complete.

refreshAccessToken(with:additionalParameters:completionHandler:)

func refreshAccessToken(with refreshToken: String,
                        additionalParameters: [String: String]? = nil,
                        completionHandler: @escaping @Sendable  OAuthCompletion)

Refresh an access token by providing a refresh token. If it succeeds then a SuccessfulTokenResponse with the access token is returned. If it fails either an ErrorTokenResponse with the error reason is returned or the result has an Error.

Parameters

Name Description
refreshToken The refresh token.
additionalParameters The additional parameters for the request body. The default value is nil.
completionHandler A completion handler that is called when refreshAccessToken is complete.

revokeAccessToken(with:completionHandler:)

func revokeAccessToken(with token: String,
                       completionHandler: @escaping @Sendable OAuthRevocationCompletion)

Revokes an access token. If it succeeds then a successfulRevocation is returned. If it fails an error response is returned containing an Error.

Parameters

Name Description
token The token to be revoked.
completionHandler A completion handler that is called when revokeAccessToken is complete.

revokeRefreshToken(with:completionHandler:)

func revokeRefreshToken(with token: String,
                        completionHandler: @escaping @Sendable OAuthRevocationCompletion)

Revokes a refresh token. If it succeeds then a success is returned. If it fails an error response is returned containing an Error.

Parameters

Name Description
token The token to be revoked.
completionHandler A completion handler that is called when revokeRefreshToken is complete.

fetchAccessToken(with:dpop:additionalParameters:completionHandler:)

Fetches an access token using an authorization code grant. If it succeeds then a SuccessfulTokenResponse with the access token is returned. If it fails either a ErrorTokenResponse with the error reason is returned or the result has an Error.

refreshAccessToken(with:additionalParameters:completionHandler:)

Refreshes an access token by providing a refresh token. If it succeeds then a SuccessfulTokenResponse with the access token is returned. If it fails either an ErrorTokenResponse with the error reason is returned or the result has an Error.

revokeRefreshToken(with:completionHandler:)

Revokes a refresh token. If it succeeds then a successfulRevocation is returned. If it fails an error response is returned containing an Error.