CredentialDetails Structure Reference


                    
                    
                    CredentialType

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
“source_type”: “cloud_object_storage”- validcredential_types:aws4_hmac`.

Declaration

Swift

public enum CredentialType : String


                    
                    
                    SourceVersion

The type of Sharepoint repository to connect to. Only valid, and required, with a source_type of sharepoint.

Declaration

Swift

public enum SourceVersion : String


                    
                    
                    credentialType

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
“source_type”: “cloud_object_storage”- validcredential_types:aws4_hmac`.

Declaration

Swift

public var credentialType: String?


                    
                    
                    clientID

The client_id of the source that these credentials connect to. Only valid, and required, with a credential_type of oauth2.

Declaration

Swift

public var clientID: String?


                    
                    
                    enterpriseID

The enterprise_id of the Box site that these credentials connect to. Only valid, and required, with a source_type of box.

Declaration

Swift

public var enterpriseID: String?

url

The url of the source that these credentials connect to. Only valid, and required, with a credential_type of username_password, noauth, and basic.

Declaration

Swift

public var url: String?


                    
                    
                    username

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.

Declaration

Swift

public var username: String?


                    
                    
                    organizationURL

The organization_url of the source that these credentials connect to. Only valid, and required, with a credential_type of saml.

Declaration

Swift

public var organizationURL: String?


                    
                    
                    siteCollectionPath

The site_collection.path of the source that these credentials connect to. Only valid, and required, with a source_type of sharepoint.

Declaration

Swift

public var siteCollectionPath: String?


                    
                    
                    clientSecret

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.

Declaration

Swift

public var clientSecret: String?


                    
                    
                    publicKeyID

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.

Declaration

Swift

public var publicKeyID: String?


                    
                    
                    privateKey

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.

Declaration

Swift

public var privateKey: String?


                    
                    
                    passphrase

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.

Declaration

Swift

public var passphrase: String?


                    
                    
                    password

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.

Declaration

Swift

public var password: String?


                    
                    
                    gatewayID

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.

Declaration

Swift

public var gatewayID: String?


                    
                    
                    sourceVersion

The type of Sharepoint repository to connect to. Only valid, and required, with a source_type of sharepoint.

Declaration

Swift

public var sourceVersion: String?


                    
                    
                    webApplicationURL

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.

Declaration

Swift

public var webApplicationURL: String?


                    
                    
                    domain

The domain used to log in to your OnPrem SharePoint account. Only valid, and required, with a source_version of 2016.

Declaration

Swift

public var domain: String?


                    
                    
                    endpoint

The endpoint associated with the cloud object store that your are connecting to. Only valid, and required, with a credential_type of aws4_hmac.

Declaration

Swift

public var endpoint: String?


                    
                    
                    accessKeyID

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.

Declaration

Swift

public var accessKeyID: String?


                    
                    
                    secretAccessKey

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.

Declaration

Swift

public var secretAccessKey: String?


                    
                    
                    init(credentialType:clientID:enterpriseID:url:username:organizationURL:siteCollectionPath:clientSecret:publicKeyID:privateKey:passphrase:password:gatewayID:sourceVersion:webApplicationURL:domain:endpoint:accessKeyID:secretAccessKey:)

Initialize a CredentialDetails with member variables.

Declaration

Swift

public init(
    credentialType: String? = nil,
    clientID: String? = nil,
    enterpriseID: String? = nil,
    url: String? = nil,
    username: String? = nil,
    organizationURL: String? = nil,
    siteCollectionPath: String? = nil,
    clientSecret: String? = nil,
    publicKeyID: String? = nil,
    privateKey: String? = nil,
    passphrase: String? = nil,
    password: String? = nil,
    gatewayID: String? = nil,
    sourceVersion: String? = nil,
    webApplicationURL: String? = nil,
    domain: String? = nil,
    endpoint: String? = nil,
    accessKeyID: String? = nil,
    secretAccessKey: String? = nil
)

Parameters

`credentialType`	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_type`s: `oauth2` `"source_type": "salesforce"` - valid `credential_type`s: `username_password` `"source_type": "sharepoint"` - valid `credential_type`s: `saml` with source_version of `online`, or `ntlm_v1` with source_version of `2016` `"source_type": "web_crawl"` - valid `credential_type`s: `noauth` or `basic` “source_type”: “cloud_object_storage”`- valid`credential_type`s:`aws4_hmac`.
`clientID`	The client_id of the source that these credentials connect to. Only valid, and required, with a credential_type of `oauth2`.
`enterpriseID`	The enterprise_id of the Box site that these credentials connect to. Only valid, and required, with a source_type of `box`.
`url`	The url of the source that these credentials connect to. Only valid, and required, with a credential_type of `username_password`, `noauth`, and `basic`.
`username`	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`.
`organizationURL`	The organization_url of the source that these credentials connect to. Only valid, and required, with a credential_type of `saml`.
`siteCollectionPath`	The site_collection.path of the source that these credentials connect to. Only valid, and required, with a source_type of `sharepoint`.
`clientSecret`	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.
`publicKeyID`	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.
`privateKey`	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.
`passphrase`	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.
`password`	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.
`gatewayID`	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.
`sourceVersion`	The type of Sharepoint repository to connect to. Only valid, and required, with a source_type of `sharepoint`.
`webApplicationURL`	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.
`domain`	The domain used to log in to your OnPrem SharePoint account. Only valid, and required, with a source_version of `2016`.
`endpoint`	The endpoint associated with the cloud object store that your are connecting to. Only valid, and required, with a credential_type of `aws4_hmac`.
`accessKeyID`	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.
`secretAccessKey`	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.

Return Value

An initialized CredentialDetails.