SignatureRequest

public class SignatureRequest

A class with all fields related to a particular login request.

  • The timestamp for the request.

    Declaration

    Swift

    public let requestTime: Date
  • The callback URL to invoke after acceptance or denial.

    Declaration

    Swift

    public let callbackUrl: URL
  • The name of the host requesting the login, for display to the user.

    Declaration

    Swift

    public let hostName: String
  • The 6-character login code for display to the user.

    Declaration

    Swift

    public let loginCode: String
  • The unique nonce for this login request, as received from the notification or pending request.

    Declaration

    Swift

    public let nonce: String
  • The username that was requested to sign.

    Declaration

    Swift

    public let username: String?
  • An array of requested OIDs, in dotted notation.

    Declaration

    Swift

    public let objectIDs: [OIDs.Dotted]
  • The URL of the document, or nil if this request is not a document signing request.

    Declaration

    Swift

    public let documentUrl: URL?
  • Optional signing message for the user.

    Declaration

    Swift

    public let message: String?
  • Enum that specifies how to invoke the callback URL.

    Declaration

    Swift

    public let callbackType: CallbackType
  • Client App identifier for this request.

    Declaration

    Swift

    public let audience: String
  • scope values of this request - passed AS-IS from the source

    Declaration

    Swift

    public let scope: String
  • claims sent in the request - passed AS-IS from the source claims will be in JSON encoded string

    Declaration

    Swift

    public let claims: String
  • getClaimsJSON - Parse claims data to JSON object

    Declaration

    Swift

    public static func getClaimsJSON (claims: String?) -> NSMutableDictionary?

    Parameters

    claims

    claims (JSON encoded string) passed as part of the payload

  • Constructor.

    Declaration

    Swift

    public init(hostName: String,
                loginCode: String,
                callbackUrl: URL,
                nonce: String,
                username: String?,
                objectIDs: [OIDs.Dotted] = [],
                documentUrl: URL? = nil,
                message: String? = nil,
                ct: CallbackType = CallbackType.UNKNOWN,
                aud: String,
                scope: String,
                claims: String)

    Parameters

    hostName

    The name of the host requesting the login, for display to the user.

    loginCode

    The 6-character login code for display to the user.

    callbackUrl

    The callback URL to invoke after acceptance or denial.

    nonce

    The unique nonce for this login request, as received from the notification or pending request.

    username

    The username that was requested to sign.

    objectIDs

    An array of requested OIDs, in dotted notation.

    documentUrl

    The URL of the document, or nil if this request is not a document signing request.

    message

    Optional signing message for the user.

    ct

    Enum that specifies how to invoke the callback URL.

    aud

    This identifier is required to identify the request.

    scope

    scope values of this request - passed AS-IS from the source

    claims

    claims will be in JSON encoded string