Structure

DeviceAuthorizationFlow.DeviceAuthResponse

The response returned from the deviceFlowAuthorizationRequest() method. Used as the parameter in the authorizationResponseHandler(for:) method.

Declaration

struct DeviceAuthResponse

Overview

The verificationURI and userCode properties should be displayed or otherwise communicated to the end user with instructions to visit the URI (or scan the qrCode) on a secondary device (for example a mobile phone) and enter the user code.

Example display from RFC 8628:

+-----------------------------------------------+
|                                               |
|  Using a browser on another device, visit:    |
|  https://example.com/device                   |
|                                               |
|  And enter the code:                          |
|  WDJB-MJHT                                    |
|                                               |
+-----------------------------------------------+

Example display from RFC 8628:

|-------------------------------------------------|
|                                                 |
|  Scan the QR code or, using     |------------|  |
|  a browser on another device,   |[_]..  . [_]|  |
|  visit:                         | .  ..   . .|  |
|  https://example.com/device     | . .  . ....|  |
|                                 |.   . . .   |  |
|  And enter the code:            |[_]. ... .  |  |
|  WDJB-MJHT                      |------------|  |
|                                                 |
|-------------------------------------------------|

Topics

Instance Properties

let completeVerificationURI: String?

The server may respond with a complete verification URI in addition to a verification URI (the verification URI combined with the user code). Following the complete verification URI allows the user to not have to type-in the user code. Is nil if one was not provided.

var expiresAt: Date

The time the codes expire at (UTC time zone).

let expiresIn: Double

How long the codes are good for (seconds)

var isExpired: Bool

True when the codes have expired.

var qrCode: CGImage?

A QR code of the verificationURI or completeVerificationURI as a Core Graphics CGImage. If generating the QR code fails for some reason, is nil.

let requestMade: Date

The time the request was made (UTC time zone).

let userCode: String

The user code that the end user must type-in after following the verificationURI.

let verificationURI: String

The verification URI should be displayed or otherwise communicated to the end user with instructions to follow it and type-in the userCode using a secondary device (for example a mobile phone) .

Relationships

Conforms To

Response