STRUCT

OAuthAuthorizationResponseStep

Contents

public struct OAuthAuthorizationResponseStep: HaapiRepresentation

An OAuth 2.0 authorization response, which provides the client with response parameters such as code and state. It signals the end of the authorization request flow.

The code of the OAuth authorization can be obtained via the oauthAuthorizationResponseProperties.

Properties

oauthAuthorizationResponseProperties

public let oauthAuthorizationResponseProperties: OAuthAuthorizationResponseProperties

The OAuthAuthorizationResponse properties.

actions

public let actions: [Action] = []

Possible actions a user or the client may choose to take to continue the flow.

metadata

public let metadata: Metadata?

messages

public let messages: [UserMessage]

links

public let links: [Link]

properties

public var properties: (any Properties)?

rawJsonString

public let rawJsonString: String?

type

public let type: RepresentationType = .oauthAuthorizationResponse

Methods

init(from:)

public init(from decoder: Decoder) throws

Parameters

Name Description
decoder The decoder to read data from.

encode(to:)

public func encode(to encoder: Encoder) throws

Parameters

Name Description
encoder The encoder to write data to.

==(::)

public static func == (lhs: OAuthAuthorizationResponseStep, rhs: OAuthAuthorizationResponseStep) -> Bool

Parameters

Name Description
lhs A value to compare.
rhs Another value to compare.