To use the DocuSign connector, add the <docusign.init>
element in your configuration before any other DocuSign operations. This configuration authenticates with DocuSign by configuring the user credentials using OAuth2 authentication for accessing the DocuSign account.
Info |
---|
|
In this connector, we have two authentication flow. First one is the Legacy Header Authentication and another one is oAuth. |
If you use Legacy Header Authentication use the init method as below.
Code Block |
---|
|
<docusign.init>
<apiUrl>{$ctx:apiUrl}</apiUrl>
<apiVersion>{$ctx:apiVersion}</apiVersion>
<integratorKey>{$ctx:integratorKey}</integratorKey>
<userName>{$ctx:userName}</userName>
<password>{$ctx:password}</password>
<blocking>{$ctx:blocking}</blocking>
</docusign.init> |
Properties
apiUrl:
Base endpoint URL to access the DocuSign API.apiVersion
: The version of the DocuSign API.integratorKey:
The client application's integration key.
username
: The username of the DocuSign account.
password
: The password of the DocuSign account.
blocking
: Boolean type, this property helps the connector perform blocking invocations to DocuSign.
If you use oAuth Authentication use the init method as below. Here you can get the accessToken form getOAuthToken method.
Code Block |
---|
|
<docusign.init>
<apiUrl>{$ctx:apiUrl}</apiUrl>
<apiVersion>{$ctx:apiVersion}</apiVersion>
<accessToken>{$ctx:accessToken}</accessToken>
<blocking>{$ctx:blocking}</blocking>
</docusign.init> |
Properties
apiUrl:
Base endpoint URL to access the DocuSign API.apiVersion
: The version of the DocuSign API.accessToken:
OAuth Token to send and manipulate data of DocuSign API.blocking
: Boolean type, this property helps the connector perform blocking invocations to DocuSign.
...
...
To get the OAuth access token add the <docusign.getOAuthToken>
element before the <docusign.init>
element in your configuration.
Code Block |
---|
language | xml |
---|
title | getOAuthToken |
---|
|
<docusign.getOAuthToken>
<grantType>{$ctx:grantType}</grantType>
<clientId>{$ctx:clientId}</clientId>
<username>{$ctx:username}</username>
<password>{$ctx:password}</password>
<scope>{$ctx:scope}</scope>
</docusign.getOAuthToken> |
Properties
grantType:
Use password as grantType.
clientId
: The client application’s integrator key set as clientId.
username
: The username of the DocuSign account.
password
: The password of the DocuSign account.
scope
: The scope is always set to "api".
...
Code Block |
---|
language | xml |
---|
title | revokeOAuthToken |
---|
|
<docusign.revokeOAuthToken>
<accessToken>{$ctx:accessToken}</accessToken>
</docusign.revokeOAuthToken> |
Properties
accessToken
: The access token that is to be revoked.
...
Code Block |
---|
language | xml |
---|
title | getLoginInformation |
---|
|
<docusign.getLoginInformation>
<includeApiPassword>{$ctx:includeApiPassword}</includeApiPassword>
<includeAccountIDGuid>{$ctx:includeAccountIDGuid}</includeAccountIDGuid>
<loginSetting>{$ctx:loginSetting}</loginSetting>
</docusign.getLoginInformation> |
Properties
includeApiPassword
: (optional) When set to true, returns api_password in the response.
includeAccountIDGuid
: (optional) When set to true, shows the account ID GUID in the response.
loginSetting
: (optional) Determines whether login settings are returned in the response (valid values: all
, none
).
...