CreateCredentialsParams

Parameters for the createCredentials operation.

Hierarchy

CreateCredentialsParams

Index

Properties

Optional credentialDetails

credentialDetails: CredentialDetails

Object containing details of the stored credentials.

Obtain credentials for your source from the administrator of the source.

environmentId

environmentId: string

The ID of the environment.

Optional headers

headers: OutgoingHttpHeaders

Optional sourceType

sourceType: SourceType | 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.

Optional status

status: Status | string

The current status of this set of credentials. connected indicates that the credentials are available to use with the source configuration of a collection. invalid refers to the credentials (for example, the password provided has expired) and must be corrected before they can be used with a collection.