Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface CreateCredentialsParams

Parameters for the createCredentials operation.

Hierarchy

  • CreateCredentialsParams

Index

Properties

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: StatusDetails

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

Generated using TypeDoc