Credentials

public struct Credentials : Codable, Equatable

Object containing credential information.

  • The source that this credentials object connects to.

    • box indicates the credentials are used to connect an instance of Enterprise Box.
    • salesforce indicates the credentials are used to connect to Salesforce.
    • sharepoint indicates the credentials are used to connect to Microsoft SharePoint Online.
    • web_crawl indicates the credentials are used to perform a web crawl. = cloud_object_storage indicates the credentials are used to connect to an IBM Cloud Object Store.
    See more

    Declaration

    Swift

    public enum SourceType : String

  • Unique identifier for this set of credentials.

    Declaration

    Swift

    public var credentialID: String?

  • The source that this credentials object connects to.

    • box indicates the credentials are used to connect an instance of Enterprise Box.
    • salesforce indicates the credentials are used to connect to Salesforce.
    • sharepoint indicates the credentials are used to connect to Microsoft SharePoint Online.
    • web_crawl indicates the credentials are used to perform a web crawl. = cloud_object_storage indicates the credentials are used to connect to an IBM Cloud Object Store.

    Declaration

    Swift

    public var sourceType: String?

  • Object containing details of the stored credentials. Obtain credentials for your source from the administrator of the source.

    Declaration

    Swift

    public var credentialDetails: CredentialDetails?

  • Object that contains details about the status of the authentication process.

    Declaration

    Swift

    public var status: StatusDetails?

  • Initialize a Credentials with member variables.

    Declaration

    Swift

    public init(
    sourceType: String? = nil,
    credentialDetails: CredentialDetails? = nil,
    status: StatusDetails? = nil
)

    Parameters

    sourceType

    The source that this credentials object connects to.

    • box indicates the credentials are used to connect an instance of Enterprise Box.
    • salesforce indicates the credentials are used to connect to Salesforce.
    • sharepoint indicates the credentials are used to connect to Microsoft SharePoint Online.
    • web_crawl indicates the credentials are used to perform a web crawl. = cloud_object_storage indicates the credentials are used to connect to an IBM Cloud Object Store.
    credentialDetails

    Object containing details of the stored credentials. Obtain credentials for your source from the administrator of the source.
    status

    Object that contains details about the status of the authentication process.

    Return Value

    An initialized Credentials.