ServerResponse

public struct ServerResponse : Codable

A ServerResponse object represents the completion status and additional application-specific additional data that results from successful processing of a UAF operation.

  • The FIDO UAF response status code.

    Declaration

    Swift

    public let statusCode: UAFStatusCode
  • A detailed message describing the status code or providing additional information to the user.

    Declaration

    Swift

    public let description: String?
  • New authentication or authorization token(s) for the client that are not natively handled by HTTP transport.

    Declaration

    Swift

    public let additionalTokens: [Token]?
  • If present, indicates to the client web application that it should navigate to the URI contained in this field.

    Declaration

    Swift

    public let location: String?
  • If present, and in combination with location, indicates the client should POST the contents to the specified location.

    Declaration

    Swift

    public let postData: String?
  • The server may return a new UAF protocol message with this property. This might be used to supply a fresh request to retry an operation in response to a transient failure, to request additional confirmation for a transaction, or to send a deauthentication message in response to a permanent failure.

    Declaration

    Swift

    public let newUAFRequest: String?
  • Creates a new ServerResponse instance.

    Declaration

    Swift

    public init(statusCode: UAFStatusCode, description: String? = nil, additionalTokens: [Token]? = nil, location: String? = nil, postData: String? = nil, newUAFRequest: String? = nil)

    Parameters

    statusCode

    The FIDO UAF response status code.

    description

    A detailed message describing the status code or providing additional information to the user.

    additionalTokens

    New authentication or authorization token(s) for the client that are not natively handled by HTTP transport.

    location

    Indicates to the client web application that it should navigate to the URI contained in this field.

    postData

    Indicates the client should POST the contents to the specified location.

    newUAFRequest

    A new UAF protocol message returned by the server.