The access key ID associated with the cloud object store. Only valid, and required, with a
credential_type of aws4_hmac. This value is never returned and is only used when creating or modifying
credentials. For more infomation, see the cloud object store
documentation.
The client_id of the source that these credentials connect to. Only valid, and required, with a
credential_type of oauth2.
The client_secret of the source that these credentials connect to. Only valid, and required, with a
credential_type of oauth2. This value is never returned and is only used when creating or modifying
credentials.
The authentication method for this credentials definition. The credential_type specified must be supported by the source_type. The following combinations are possible:
"source_type": "box" - valid credential_types: oauth2"source_type": "salesforce" - valid credential_types: username_password"source_type": "sharepoint" - valid credential_types: saml with source_version of online, or
ntlm_v1 with source_version of 2016"source_type": "web_crawl" - valid credential_types: noauth or basic- validcredential_types:aws4_hmac`.The domain used to log in to your OnPrem SharePoint account. Only valid, and required, with a
source_version of 2016.
The endpoint associated with the cloud object store that your are connecting to. Only valid, and required,
with a credential_type of aws4_hmac.
The enterprise_id of the Box site that these credentials connect to. Only valid, and required, with a
source_type of box.
The ID of the gateway to be connected through (when connecting to intranet sites). Only valid with a
credential_type of noauth, basic, or ntlm_v1. Gateways are created using the
/v1/environments/{environment_id}/gateways methods.
The organization_url of the source that these credentials connect to. Only valid, and required, with a
credential_type of saml.
The passphrase of the source that these credentials connect to. Only valid, and required, with a
credential_type of oauth2. This value is never returned and is only used when creating or modifying
credentials.
The password of the source that these credentials connect to. Only valid, and required, with
credential_types of saml, username_password, basic, or ntlm_v1.
Note: When used with a source_type of salesforce, the password consists of the Salesforce password and
a valid Salesforce security token concatenated. This value is never returned and is only used when creating or
modifying credentials.
The private_key of the source that these credentials connect to. Only valid, and required, with a
credential_type of oauth2. This value is never returned and is only used when creating or modifying
credentials.
The public_key_id of the source that these credentials connect to. Only valid, and required, with a
credential_type of oauth2. This value is never returned and is only used when creating or modifying
credentials.
The secret access key associated with the cloud object store. Only valid, and required, with a
credential_type of aws4_hmac. This value is never returned and is only used when creating or modifying
credentials. For more infomation, see the cloud object store
documentation.
The site_collection.path of the source that these credentials connect to. Only valid, and required, with
a source_type of sharepoint.
The type of Sharepoint repository to connect to. Only valid, and required, with a source_type of
sharepoint.
The url of the source that these credentials connect to. Only valid, and required, with a
credential_type of username_password, noauth, and basic.
The username of the source that these credentials connect to. Only valid, and required, with a
credential_type of saml, username_password, basic, or ntlm_v1.
SharePoint OnPrem WebApplication URL. Only valid, and required, with a source_version of 2016. If a
port is not supplied, the default to port 80 for http and port 443 for https connections are used.
Generated using TypeDoc
Object containing details of the stored credentials. Obtain credentials for your source from the administrator of the source.