ReturnUAFRequest

public struct ReturnUAFRequest : Codable

A ReturnUAFRequest object represents a response sent by a relying party server on a request message.

  • A hint to the client of the operation type of the message, useful if the server might return a different type than was requested.

    Declaration

    Swift

    public let operation: Operation?
  • The UAF status code for the operation.

    Declaration

    Swift

    public let statusCode: UAFStatusCode
  • The new UAF request message, if the server decides to issue one.

    Declaration

    Swift

    public let uafRequest: String?
  • Hint informing the client application of the lifetime of the message in milliseconds. Absent if the operation was not successful.

    Declaration

    Swift

    public let lifetime: Int?
  • Creates a new ReturnUAFRequest instance.

    Declaration

    Swift

    public init(operation: Operation, statusCode: UAFStatusCode, uafRequest: String? = nil, lifetime: Int? = nil)

    Parameters

    operation

    A hint to the client of the operation type of the message.

    statusCode

    The UAF status code for the operation.

    uafRequest

    The new UAF request message, if the server decides to issue one.

    lifetime

    Hint informing the client application of the lifetime of the message in milliseconds. Absent if the operation was not successful.