UserAPIKeyCredential

public struct UserAPIKeyCredential : StitchCredential

A credential which can be used to log in as a Stitch user using the User API Key authentication provider.

Initializer

  • Initializes this credential with the name of the provider, and a user API key.

    Declaration

    Swift

    public init(withProviderName providerName: String = providerType.name,
            withKey key: String)

Properties

  • The name of the provider for this credential.

    Declaration

    Swift

    public var providerName: String

  • The type of the provider for this credential.

    Declaration

    Swift

    public static let providerType: StitchProviderType

  • The contents of this credential as they will be passed to the Stitch server.

    Declaration

    Swift

    public var material: Document { get }

  • The behavior of this credential when logging in.

    Declaration

    Swift

    public var providerCapabilities: ProviderCapabilities
  • key

    The user API key contained within this credential.

    Declaration

    Swift

    public let key: String