Important connection properties
UseSandbox
UseSandbox indicates whether current user account is sandbox or not. This is false by default. Set to true if you have sandbox account.
AccountId
AccountId is an optional connection property. It will be set automatically after the authentication succeeds. You can alternatively manually set it in the connection string if you have access to multiple Account Ids. In order to retrieve account ids, query the UserInfo view.
Authenticating to DocuSign
DocuSign uses the OAuth authentication standard. To authenticate using OAuth, you will need to create an app to obtain the OAuthClientId, OAuthClientSecret, and CallbackURL connection properties. See Using OAuth Authentication for an authentication guide.
Using OAuth Authentication
OAuth requires the authenticating user to interact with DocuSign using the browser. The provider facilitates this in various ways as described below.
Custom Credentials
You must register an app to obtain the OAuthClientId and OAuthClientSecret.
When to Create a Custom OAuth App
Creating a custom OAuth app is required in all cases in order to connect.
Creating a Custom OAuth App
See Creating a Custom OAuth App for information on how to create a custom app.
Custom Credentials
When to Use a Custom OAuth App
Creating a custom OAuth app is required in order to connect.
Desktop Authentication with a Custom OAuth App
Follow the steps below to authenticate with the credentials for a custom OAuth app. See Creating a Custom OAuth App.Get and Refresh the OAuth Access Token
After setting the following, you are ready to connect:
- OAuthClientId: Set this to the Integrator Key assigned when you registered your app.
- OAuthClientSecret: Set this to the Secret Key assigned when you registered your app.
- CallbackURL: Set this to the redirect URI defined when you registered your app.
- UseSandbox: This is false by default. Set to true if you are using sandbox account.
- InitiateOAuth: Set this to GETANDREFRESH. You can use InitiateOAuth to avoid repeating the OAuth exchange and manually setting the OAuthAccessToken.
- Extracts the access token from the callback URL and authenticates requests.
- Refreshes the access token when it expires.
- Saves OAuth values in OAuthSettingsLocation to be persisted across connections.
Web Authentication with a Custom OAuth App
When connecting via a Web application, you need to register a custom OAuth app with DocuSign. See Creating a Custom OAuth App. You can then use the provider to get and manage the OAuth token values.
Get an OAuth Access Token
Set the following connection properties to obtain the OAuthAccessToken:
- OAuthClientId: Set this to the Integrator Key assigned when you registered your app.
- OAuthClientSecret: Set this to the Secret Key assigned when you registered your app.
- UseSandbox: This is false by default. Set to true if you are using sandbox account.
You can then call stored procedures to complete the OAuth exchange:
-
Call the GetOAuthAuthorizationURL stored procedure. Set the AuthMode input to WEB and set the CallbackURL input to the Redirect URI you specified in your app settings.
The stored procedure returns the URL to the OAuth endpoint.
- Open the URL, log in, and authorize the application. You are redirected back to the callback URL.
- Call the GetOAuthAccessToken stored procedure. Set the AuthMode input to WEB. Set the Verifier input to the "code" parameter in the query string of the callback URL.
Refresh the OAuth Access Token
You can set InitiateOAuth to REFRESH to automatically refresh the OAuth access token when it expires, or you can call the RefreshOAuthAccessToken stored procedure to refresh the token manually.
Automatic Refresh
To refresh the token with InitiateOAuth, set the following on the first data connection:
- OAuthAccessToken: Set this to the access token returned by GetOAuthAccessToken.
- InitiateOAuth: Set this to REFRESH. You can use InitiateOAuth to avoid repeating the OAuth exchange and manually setting the OAuthAccessToken.
- OAuthSettingsLocation: Set this to the path where the provider will save the OAuth values, to be persisted across connections.
- OAuthClientId: Set this to the Integrator Key assigned when you registered your app.
- OAuthClientSecret: Set this to the Secret Key assigned when you registered your app.
- OAuthRefreshToken: Set this to the refresh token returned by GetOAuthAccessToken.
- UseSandbox: This is false by default. Set to true if you are using sandbox account.
On subsequent data connections, set the following:
- InitiateOAuth
- OAuthSettingsLocation
Manual Refresh
You can use the RefreshOAuthAccessToken stored procedure to manually refresh the OAuthAccessToken. Call the stored procedure after the ExpiresIn parameter value returned by GetOAuthAccessToken has elapsed. You need the following connection properties to be set:
- OAuthClientId: Set this to the Client Id in your app settings.
- OAuthClientSecret: Set this to the Client Secret in your app settings.
- UseSandbox: This is false by default. Set to true if you are using sandbox account.
You can then call RefreshOAuthAccessToken with the following parameter set:
- OAuthRefreshToken: Set this to the OAuthRefreshToken returned by GetOAuthAccessToken.
Headless Machines
Using OAuth on a Headless Machine
To create DocuSign data sources on headless servers or other machines on which the provider cannot open a browser, you need to authenticate from another machine. Authentication is a two-step process.
- Instead of installing the provider on another machine, you can follow the steps below to obtain the OAuthVerifier value. Or, you can install the provider on another machine and transfer the OAuth authentication values, after you authenticate through the usual browser-based flow.
- You can then configure the provider to automatically refresh the access token from the headless machine.
Using the Credentials for a Custom OAuth App
Create a Custom OAuth App
Creating a custom OAuth app is optional in the headless OAuth flow; you can skip creating an app by connecting with the provider's embedded OAuth credentials. You might want to create a custom OAuth app to change the information displayed when users log into DocuSign to grant permissions to the provider.
See Creating a Custom OAuth App for a procedure. You can then follow the procedures below to authenticate and connect to data.
Obtain a Verifier Code
Set the following properties on the headless machine:
- InitiateOAuth: Set this to OFF.
- OAuthClientId: Set this to the Integrator Key assigned when you specified your app.
- OAuthClientSecret: Set this to the Secret Key assigned when you specified your app.
- UseSandbox: This is false by default. Set to true if you are using sandbox account.
You can then follow the steps below to authenticate from another machine and obtain the OAuthVerifier connection property.
- Call the GetOAuthAuthorizationURL stored procedure with the CallbackURL input parameter set to the exact Redirect URI you specified in your app settings.
- Open the returned URL in a browser. Log in and grant permissions to the provider. You are then redirected to the callback URL, which contains the verifier code.
- Save the value of the verifier code. You will set this in the OAuthVerifier connection property.
On the headless machine, set the following connection properties to obtain the OAuth authentication values:
- OAuthVerifier: Set this to the verifier code.
- OAuthSettingsLocation: Set this to persist the encrypted OAuth authentication values to the specified file.
- InitiateOAuth: Set this to REFRESH
After the OAuth settings file is generated, set the following properties to connect to data:
- OAuthSettingsLocation: Set this to the file containing the encrypted OAuth authentication values. Make sure this file gives read and write permissions to the provider to enable the automatic refreshing of the access token.
- InitiateOAuth: Set this to REFRESH.
Transfer OAuth Settings
Follow the steps below to install the provider on another machine, authenticate, and then transfer the resulting OAuth values.
On a second machine, install the provider and connect with the following properties set:
- OAuthSettingsLocation: Set this to a writable text file.
- InitiateOAuth: Set this to GETANDREFRESH.
- OAuthClientId: Set this to the Integrator Key assigned when you specified your app.
- OAuthClientSecret: Set this to the Secret Key assigned when you specified your app.
- CallbackURL: Set this to the Redirect URI you specified in your app settings.
- UseSandbox: This is false by default. Set to true if you are using sandbox account.
Test the connection to authenticate. The resulting authentication values are written, encrypted, to the path specified by OAuthSettingsLocation. Once you have successfully tested the connection, copy the OAuth settings file to your headless machine. On the headless machine, set the following connection properties to connect to data:
- InitiateOAuth: Set this to REFRESH.
- OAuthSettingsLocation: Set this to the path to your OAuth settings file. Make sure this file gives read and write permissions to the provider to enable the automatic refreshing of the access token.
Creating a Custom OAuth App
When to Create a Custom OAuth App
Creating a custom app is required in order to connect.
Follow the steps below to create a custom OAuth app and obtain the connection properties in a specific OAuth authentication flow.
Create a Custom OAuth App: Desktop
Register your DocuSign app on Admin panel / Integrations / API and Keys to obtain the following connection properties:
- OAuthClientId: Set this to the Integrator Key assigned when you registered your app.
- OAuthClientSecret: Set this to the Secret Key assigned when you registered your app.
- CallbackURL: Set this to the redirect URI defined when you registered your app such as http://localhost:33333.
Create a Custom OAuth App: Web Apps
Register your DocuSign app on Admin panel / Integrations / API and Keys to obtain the following connection properties:
- OAuthClientId: Set this to the Integrator Key assigned when you registered your app.
- OAuthClientSecret: Set this to the Secret Key assigned when you registered your app.
Create a Custom OAuth App: Headless Machines
Register your DocuSign app on Admin panel / Integrations / API and Keys to obtain the following connection properties:
- OAuthClientId: Set this to the Integrator Key assigned when you registered your app.
- OAuthClientSecret: Set this to the Secret Key assigned when you registered your app.
Customizing the SSL Configuration
By default, the provider attempts to negotiate SSL/TLS by checking the server's certificate against the system's trusted certificate store. To specify another certificate, see the SSLServerCert property for the available formats to do so.
Connecting Through a Firewall or Proxy
HTTP Proxies
To connect through the Windows system proxy, you do not need to set any additional connection properties. To connect to other proxies, set ProxyAutoDetect to false.
In addition, to authenticate to an HTTP proxy, set ProxyAuthScheme, ProxyUser, and ProxyPassword, in addition to ProxyServer and ProxyPort.
Other Proxies
Set the following properties:
- To use a proxy-based firewall, set FirewallType, FirewallServer, and FirewallPort.
- To tunnel the connection, set FirewallType to TUNNEL.
- To authenticate, specify FirewallUser and FirewallPassword.
- To authenticate to a SOCKS proxy, additionally set FirewallType to SOCKS5.
Troubleshooting the Connection
To show provider activity from query execution to network traffic, use Logfile and Verbosity. The examples of common connection errors below show how to use these properties to get more context. Contact the support team for help tracing the source of an error or circumventing a performance issue.
- Authentication errors: Typically, recording a Logfile at Verbosity 4 is necessary to get full details on an authentication error.
- Queries time out: A server that takes too long to respond will exceed the provider's client-side timeout. Often, setting the Timeout property to a higher value will avoid a connection error. Another option is to disable the timeout by setting the property to 0. Setting Verbosity to 2 will show where the time is being spent.
- The certificate presented by the server cannot be validated: This error indicates that the provider cannot validate the server's certificate through the chain of trust. If you are using a self-signed certificate, there is only one certificate in the chain.
To resolve this error, you must verify yourself that the certificate can be trusted and specify to the provider that you trust the certificate. One way you can specify that you trust a certificate is to add the certificate to the trusted system store; another is to set SSLServerCert.
Other Properties
- AccountId: An optional account id that can be specified in case you have access to multiple.
- DirectoryRetrievalDepth: The depth of folders to scan when listing available folders (ie: how many subfolders deep).
- IncludeCustomFields: Set to true if you want to retrieve custom fields values for an envelope or template.
- Url: Base API url associated with your account. Defaulted just like the AccountId.
- UseSandbox: Set to true if you are using a sandbox.