Adding a Connection to DocuSign

To add a connection to DocuSign:

1. In the application console, navigate to the Connections page.
2. At the Add Connections panel, select the icon for the connection you want to add.
3. If the DocuSign icon is not available, click the Add More icon to download and install the DocuSign connector from the CData site.

For required properties, see the Settings tab.

For connection properties that are not typically required, see the Advanced tab.

Connecting to DocuSign

UseSandbox
UseSandbox indicates whether the current user account is sandbox or not. This is false by default. Set to true if you are using a sandbox account. All the OAuth flows documented below assume that you have set UseSandbox beforehand.

AccountId
AccountId is an optional connection property. It sets automatically after the authentication succeeds. As an alternative, you can 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 must create a custom app to obtain the OAuthClientId, OAuthClientSecret, and CallbackURL connection properties. The Sync App support OAuth JWT authentication as well. See Creating a Custom OAuth App for more information about creating custom applications.

OAuth

AuthScheme must be set to OAuth in all user account flows.

OAuth JWT

Set the AuthScheme to OAuthJWT.

Obtaining a User ID

Retrieve your User ID by navigating, in the DocuSign UI, to Settings > Apps and Keys > My Account Information > User ID.

Obtaining an Integration Key

Follow the procedure below to obtain an integration key:

1. Log in to a DocuSign developer account.
2. Navigate to My Apps and Keys.
3. You will see a dialog box to enter your application's name. Give your application a short, but descriptive name.
4. Click ADD to add your application. Your application is automatically assigned an integration key (GUID) value that cannot be changed. Save this value.

Application Consent

In order to connect, you must give consent to the application. DocuSign offers three different software patterns for granting consent to an integration key. Grant consent to your application using one of the following methods.

Method 1: Administrative Consent

This is the best option for customer-oriented developers, because it requires nothing from your users.

Note: This pattern can't be used by ISVs.

This method of obtaining consent has the following prerequisites:

• Your account must include the Access Management with SSO feature, though it is not required that you install SSO.
  • If your developer demo account (demo.docusign.net) does not include this feature, send an email to [email protected] and request that the feature be added to your account. Remember to include your developer demo account ID.
• You must claim your email DNS domain via the DocuSign administration tool. A domain can be claimed both by the DocuSign developer demo system (for testing and development), and by your production DocuSign account.
• Your users’ email domains must match the claimed email domain.
• Your integration key’s management account must be one of the accounts in the DocuSign organization.

If you meet these requirements, grant consent as follows:

1. In DocuSign Admin, open your organization home page.
2. In the navigation pane on the left side of the page, select Connected Apps.
3. Click Authorize Application and choose an application from the drop-down menu.
4. In the Add New Application dialog, specify the permissions you want to grant to your application.
5. Click ADD.

Method 2: Individual Consent

This option has no prerequisites and can be used by customer-oriented developers and the customers of ISVs. Each user must perform the following steps.

To obtain individual consent:

1. Run the GetConsentURL stored procedure. The procedure returns a URL.
2. Open the returned URL in your browser. A permissions page will display.
3. Click Accept to grant consent.

Method 3: Administrative Consent for Third-party (ISV) Applications

You can grant administrative consent to third party (ISV) applications.

This method of obtaining consent has the following prerequisites:

• All prerequisites for standard Administrative Consent apply (see section above).
• ISVs should also support individual consent as a backup, since SSO not all customers will be able to use administative consent.
• If you are an ISV using the JWT grant flow, then the management account tied to your application’s integration key should be a DocuSign account that your company controls.

If you meet these requirements, obtain consent as follows. Each user must perform the following steps.

1. Run the GetConsentURL stored procedure. The procedure returns a URL.
2. Open the returned URL in your browser. A permissions page will display.
3. Click Accept to grant consent.

Configuring OAuth JWT Credentials

Using the information you gathered in the above sections, set the following connection properties in the Sync App:

• OAuthJWTCert: The location of your private key. This should end with ".key".
• OAuthJWTCertType: PEMKEY_FILE
• OAuthJWTSubject: Your user ID.
• OAuthJWTIssuer: Your integration key.

Fine Tuning Data Access

• 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.

This section details a selection of advanced features of the DocuSign Sync App.

User Defined Views

The Sync App supports the use of user defined views, virtual tables whose contents are decided by a pre-configured user defined query. These views are useful when you cannot directly control queries being issued to the drivers. For an overview of creating and configuring custom views, see User Defined Views .

SSL Configuration

Use SSL Configuration to adjust how Sync App handles TLS/SSL certificate negotiations. You can choose from various certificate formats;. For further information, see the SSLServerCert property under "Connection String Options" .

Firewall and Proxy

Configure the Sync App for compliance with Firewall and Proxy, including Windows proxies and HTTP proxies. You can also set up tunnel connections.

Query Processing

The Sync App offloads as much of the SELECT statement processing as possible to DocuSign and then processes the rest of the query in memory (client-side).

For further information, see Query Processing.

Logging

For an overview of configuration settings that can be used to refine CData logging, see Logging. Only two connection properties are required for basic logging, but there are numerous features that support more refined logging, which enables you to use the LogModules connection property to specify subsets of information to be logged.

Customizing the SSL Configuration

By default, the Sync App attempts to negotiate TLS with the server. The server certificate is validated against the default system trusted certificate store. You can override how the certificate gets validated using the SSLServerCert connection property.

To specify another certificate, see the SSLServerCert connection property.

Connecting Through a Firewall or Proxy

HTTP Proxies

To authenticate to an HTTP proxy, set the following:

• ProxyServer: the hostname or IP address of the proxy server that you want to route HTTP traffic through.
• ProxyPort: the TCP port that the proxy server is running on.
• ProxyAuthScheme: the authentication method the Sync App uses when authenticating to the proxy server.
• ProxyUser: the username of a user account registered with the proxy server.
• ProxyPassword: the password associated with the ProxyUser.

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.

Overview

This section shows the available API objects and provides more information on executing SQL to DocuSign APIs.

Key Features

• The Sync App models DocuSign entities like documents, folders, and groups as relational views, allowing you to write SQL to query DocuSign data.
• Stored procedures allow you to execute operations to DocuSign, including retrieving the access token and keeping it refreshed in OAuth 2.0.
• Live connectivity to these objects means any changes to your DocuSign account are immediately reflected when using the Sync App.

Views

Views describes the available views. Views are statically defined to model Accounts, Documents, Folders, and more.

Stored Procedures

Stored Procedures are function-like interfaces to DocuSign. Stored procedures allow you to execute operations to DocuSign, including downloading documents and moving envelopes.

Views are similar to tables in the way that data is represented; however, views are read-only.

Queries can be executed against a view as if it were a normal table.

DocuSign Connector for CData Sync Views

Name	Description
AccountBrands	The AcccountBrands resource provides methods that allow you to manage the account brand associated with an account.
AccountCustomFields	The CustomFields resource provides a method that enables you to retrieve the custom fields associated with an account.
AccountPermissionProfiles	An account permission profile is assigned to a group of users, enabling you to set permissions for all of the users in the group at the same time.
Accounts	The Accounts resource provides methods that allow you to manage your accounts.
AgentUserAuthorizations	Returns the user authorizations for which the user specified by userId is the agent user.
BillingInvoices	Retrieves a list of invoices for the account.
BillingPayments	Retrieves a list containing information about one or more payments.
BillingPlans	Retrieves the billing plan information for the specified account, including the current billing plan, successor plans, billing address, and billing credit card.
BulkSendBatch	Returns a summary of bulk send batches.
BulkSendBatchStatus	Gets the general status of a specific bulk send batch.
CloudStorage	Retrieves a list of the user's items from the specified cloud storage provider.
CloudStorageProviders	The CloudStorageProviders resource provides methods that allow you to manage the cloud storage providers associate with an account.
CustomTabs	The CustomTabs resource provides methods that allow you to manage custom tabs based on the existing DocuSign tabs.
Documents	The Documents resource provides methods that manage documents in an envelope or template.
DocumentTabs	The DocumentTabs resource provides methods that allow you to manage various tabs in envelopes or templates.
DocumentVisibility	The Document Visibility resource provides methods that manage document views and insights in an envelope or template.
EnvelopeAttachments	The EnvelopeAttachments resource provides methods that allow you to manage attachments.
EnvelopeConsumerDisclosures	The EnvelopeConsumerDisclosures resource provides a method that allows you to retrieve the consumer disclosure for an envelope.
EnvelopeFormData	Returns envelope tab data for an existing envelope.To use this feature, the Sending Setting Allow sender to download form data must be enabled for the account.
Envelopes	The Envelope provides methods that allow you to manage envelopes
EnvelopeTemplates	The EnvelopeTemplates resource provides methods that allow you to add and delete templates on envelopes and documents.
Folders	Retrieves a list of the folders for the account.
GroupBrands	The GroupBrands resource provides methods that allow you to manage brands in a group.
Groups	The Groups resource provides methods that allow you to manage groups for the account.
GroupUsers	The GroupUsers resource provides methods that allow you to manage the users in a group.
Locks	The Locks resource provides methods that allow you to manage locks on an envelope or template.
PowerForms	The PowerForms resource provides methods that allow you to manage power forms.
PrincipalUserAuthorizations	Returns the user authorizations for which the user specified by userId is the principal user.
Recipients	The Recipients resource allows you manage the recipients of an envelope or template.
RecipientTabs	The RecipientTabs resource provides methods that let you add, update, and delete tabs from an envelope or template.
SendListBulkCopies	Represents an instance or copy of an envelope
SendListRecipients	This method returns all of the details of recipents associated with a specific bulk send list that belongs to the current user.
SendLists	A list of bulk send lists belonging to the current user, as well as basic information about each list.
SharedAccessEnvelopes	Retrieves the list of information about the shared envelopes.
SharedAccessFolders	Retrieves the list of information about the shared folders.
SharedAccessTemplates	Retrieves the list of information about the shared templates.
SharedAccessUser	Retrieves the information about the user requesting the shared information.
SigningGroups	Returns data from a sample table.
SigningGroupUsers	The SigningGroupUsers resource provides methods that allow you to manage users in Signing Groups.
Templates	The Template resource provides methods that allow you to manage templates.
UserInfo	The UserInfo resource provides methods that allow you to manage your current user info.
Users	The Users resource provides methods that allow you to manage users for an account.
UserSignatures	The UserSignatures resource provides methods that allow you manage the intials and signature images for a user.
Workspaces	The Workspaces resource provides methods that allow you to manage workspaces.

The AcccountBrands resource provides methods that allow you to manage the account brand associated with an account.

View Specific Information

The Sync App will use the DocuSign API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client side within the Sync App.

• BrandId supports the '=' operator.

For example, the following query is processed server side:

SELECT * FROM AccountBrands WHERE BrandId = '4701f9c2-1038-45cf-bf35-66ae143a5656'

Columns

Name	Type	References	Description
BrandId [KEY]	String		Id of the brand.
BrandName	String		Name of the brand.
BrandCompany	String		The name of the company associated with this brand.
IsOverridingCompanyName	Boolean		When is set to true, brand name is the name of the company.
IsSendingDefault	Boolean		When is set to true, it is sending default.
IsSigningDefault	Boolean		When is set to true, it is signing default.
BrandLanguages	String		An array of two-letter codes for the languages that you want to use with the brand.
Colors	String		An array of name-value pairs specifying the colors that the brand uses for the following elements:Button background, Button text, Header background, Header text
DefaultBrandLanguage	String		The two-letter code for the language that you want to use as the brand default.

The CustomFields resource provides a method that enables you to retrieve the custom fields associated with an account.

View Specific Information

DocuSign does not support any column for filtering this view. All filters will be executed client side.

Columns

Name	Type	References	Description
FieldId [KEY]	Integer		An ID used to specify a custom field.
Name	String		The name of the custom field.
CustomFieldType	String		Type of the custom field.
ListOfValues	String		Comma separated value of the .
Show	Boolean		A boolean indicating if the value should be displayed. If this value is set to true, the custom field is displayed at the top of the certificate of completion. If this value is left blank/ or set to false, then it does not appear in the certificate of completion.
Required	Boolean		When set to true, the signer is required to fill out this tab
ConfigurationType	String		If merge field's are being used, specifies the type of the merge field. The only supported value is salesforce.

An account permission profile is assigned to a group of users, enabling you to set permissions for all of the users in the group at the same time.

View Specific Information

The Sync App uses the DocuSign API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client-side within the Sync App.

• PermissionProfileId supports the '=' operator.

For example, the following query is processed server-side:

SELECT * FROM AccountPermissionProfiles where PermissionProfileId = '20894443';

Columns

Name	Type	References	Description
PermissionProfileId [KEY]	String		The ID of the permission profile.
PermissionProfileName	String		The name of the account permission profile.
ModifiedByUsername	String		The username of the user who last modified the permission profile.
ModifiedDateTime	Datetime		The date and time when the permission profile was last modified.
UserCount	String		The total number of users in the group associated with the account permission profile.
Settings	String		This object specifies the permissions that are associated with the account permission profile.
Users	String		A list of user objects containing information about the users who are associated with the account permission profile.

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.

Name	Type	Description
Include	String		A comma-separated list of additional properties to return in the response. Valid values are: user_count, closed_users, account_management, metadata

The Accounts resource provides methods that allow you to manage your accounts.

View Specific Information

The Sync App will use the DocuSign API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the Sync App.

• AccountIdGuid supports the '='.

For example, the following queries are processed server side:

SELECT * FROM Envelopes WHERE AccountIdGuid = '764c564c-b540-42d1-a667-ccee6813ef7b'

Columns

Name	Type	References	Description
AccountId [KEY]	Integer		Id of the account.
AccountIdGuid	String		The GUID associated with the account ID.
AccountName	String		The name of the current account.
CreatedDate	Datetime		The date when account was created.
CurrencyCode	String		Specifies the ISO currency code for the account.
CurrentPlanId	String		Identifies the plan that was used create this account.
PlanName	String		The name of the Billing Plan.
PlanClassification	String		Identifies the type of plan. Examples include Business, Corporate, Enterprise, Free.
PlanStartDate	Datetime		The date that the Account started using the current plan.
PlanEndDate	Datetime		The date that the current plan will end.
PaymentMethod	String		Method of the payment.
EnvelopeUnitPrice	String		Price of an envelope.
EnvelopeSendingBlocked	Boolean		When set to true, user can not send envelopes.
BillingProfile	String		The name of the Billing Profile.
BillingPeriodStartDate	Datetime		The UTC DateTime that account billing started.
BillingPeriodEndDate	Datetime		The UTC DateTime that account billing finish.
BillingPeriodDaysRemaining	Integer		Number of remaining billing days.
BillingPeriodEnvelopesSent	Integer		Number of sent envelopes.
BillingPeriodEnvelopesAllowed	String		Specifies the allowed number of sent envelopes.
CanCancelRenewal	Boolean		When set to true, specifies that you can cancel renewal.
CanUpgrade	Boolean		When set to true, specifies that you can upgrade the account through the API.
IsDowngrade	Boolean		When set to true, specifies that your account is downgraded.
AllowTransactionRooms	Boolean		When set to true, the transaction rooms feature exposed through the Workspaces API is enabled.
ConnectPermission	String		Value is full when Connect is enabled for this account.
DistributorCode	String		The code that identifies the billing plan groups and plans for the new account.
DocuSignLandingUrl	String		URL of the landing page used to create the account.
ForgottenPasswordQuestionsCount	String		A complex element that contains up to four Question/Answer pairs for forgotten password information for a user.
SeatsAllowed	String		The number of active users the account can have at one time.
SeatsInUse	String		The number of users currently active on the account.
SuspensionDate	Date		The date on which the account was suspended.
SuspensionStatus	String		Indicates whether the account is currently suspended.

Returns the user authorizations for which the user specified by userId is the agent user.

The Sync App will use the DocuSign API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the Sync App.

• Permission supports the '=' operator.
• Email supports the '=' operator.
• Name supports the '=' operator.
• UserId supports the '=' operator.
• ActiveOnly supports the '=' operator.
• IncludeClosedUsers supports the '=' operator.

For example, the following queries are processed server side:

SELECT * FROM AgentUserAuthorizations WHERE UserId = 'b3367191-5269-458b-bb21-c177a10b6d25'

Columns

Name	Type	References	Description
AuthorizationId [KEY]	String		The ID of the user authorization.
Created	Datetime		The UTC DateTime when the workspace user authorization was created.
CreatedBy	String		The name and email of the user who created the authorization.
EndDate	Datetime		The UTC DateTime at which the authorization will expire.
Modified	Datetime		The UTC DateTime when the workspace user authorization was last updated.
ModifiedBy	String		The name and email of the user who created the authorization.
Permission	String		The permission level to grant the agent. Valid values are : Send, Manage, Sign, Edit
AccountId	String		The account ID.
Email	String		The email address of the authorization user.
Name	String		The name of the authorization user.
UserId	String		The ID of the authorization user.
StartDate	Datetime		The UTC DateTime at which the authorization will start.

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.

Name	Type	Description
ActiveOnly	Boolean		When true, only active users are returned. The default value is false.
IncludeClosedUsers	Boolean		When true, returns active and scheduled authorizations of closed users. The default value is true. This value is only applied when active_only is false.

Retrieves a list of invoices for the account.

View Specific Information

The Sync App will use the DocuSign API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the Sync App.

• InvoiceId supports the '='.

For example, the following query is processed server side:

SELECT * FROM BillingInvoices WHERE InvoiceId = '3caf8d81-1c18-4ff6-bc1b-39e4ab8c2692'

Columns

Name	Type	References	Description
InvoiceId [KEY]	String		ID for the invoices.
Amount	String		The total amount of the purchase.
Balance	String		Balance reserved for Docusign.
DueDate	Date		Due date reserved for Docusign.
InvoiceItems	String		Billing Invoice Items.
InvoiceNumber	String		Invoices number.
InvoiceUri	String		Contains a URI for an endpoint that you can use to retrieve invoice information.
NonTaxableAmount	String		Non Taxable Amount
PdfAvailable	String		Pdf Available
TaxableAmount	String		Taxable Amount

Retrieves a list containing information about one or more payments.

View Specific Information

The Sync App will use the DocuSign API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the Sync App.

• PaymentId supports the '='.

For example, the following query is processed server side:

SELECT * FROM BillingPayments WHERE PaymentId = '3caf8d81-1c18-4ff6-bc1b-39e4ab8c2692'

Columns

Name	Type	References	Description
PaymentId [KEY]	String		The ID of the payment.
Amount	String		The total amount of the purchase.
Description	String		A sender-defined description of the line item.
PaymentDate	Date		The date of the payment.
PaymentNumber	String		When true, a PDF version of the invoice is available.

Retrieves the billing plan information for the specified account, including the current billing plan, successor plans, billing address, and billing credit card.

View Specific Information

DocuSign does not support any column for filtering this view. All filters will be executed client side.

Columns

Name	Type	References	Description
PlanId [KEY]	String		Docusign's ID for the account plan.
AppStoreReceiptExpirationDate	Date		App Store Receipt Expiration Date.
AppStoreReceiptPurchaseDate	Date		App Store Receipt Purchase Date.
BillingPlanAddOns	String		Billing Plan Add Ons.
BillingAddress1	String		The first line of the address.
BillingAddress2	String		The second line of the address.
BillingAddressCity	String		The city associated with the address.
BillingAddressCountry	String		The country associated with the address.
BillingAddressEmail	String		The email address associated with the account.
BillingAddressFax	String		The fax number associated with the account.
BillingAddressFirstName	String		The first name of the user associated with the account
BillingAddressLastName	String		The last name of the user associated with the account.
BillingAddressPhone	String		The phone number associated with the account.
BillingAddressPostalCode	String		The postal code associated with the address.
BillingAddressState	String		The state or province associated with the address
BillingAddressIsCreditCardAddress	Boolean		When true, the credit card address information is the same as that returned as the billing address. If false, then the billing address is considered a billing contact address, and the credit card address can be different.
CanUpgrade	Boolean		When true, specifies that you can upgrade the account through the API. For GET methods, you must set the include_metadata query parameter to true for this property to appear in the response.
CreditCardAddress1	String		The first line of the user's address.
CreditCardAddress2	String		The second line of the user's address
CreditCardCity	String		The user's city.
CreditCardCountry	String		The user's country.
CreditCardFax	String		A fax number associated with the address, if one is available.
CreditCardPhone	String		A phone number associated with the address.
CreditCardPostalCode	String		The user's postal code.
CreditCardState	String		The user's state or province.
CardLastDigits	Integer		The Card Last Digits.
CardNumber	String		The Card Number.
CardType	String		The Card Type.
CVNumber	Integer		The cv Number.
CurrencyCode	String		Specifies the ISO 4217 currency code to use for the account.
OtherDiscountPercent	String		Any other percentage discount for the plan.
EnableSupport	Boolean		When true, customer support is provided as part of the account plan.
ExpirationMonth	String		The Expiration Month for Card.
ExpirationYear	String		The Expiration Year for Card.
IncludedSeats	String		The number of seats (users) included in the plan.
NameOnCard	String		The exact name as it appears on the credit card.
OtherDiscountPercent	String		Any other percentage discount for the plan.
PaymentCycle	String		The payment cycle associated with the plan. Valid values are Monthly,Annually
PaymentMethod	String		The payment method used with the plan. Valid values are CreditCard, PurchaseOrder, Premium, or Freemium.
PerSeatPrice	String		The per-seat price associated with the plan.
PaymentMethod	String		The payment method used for the billing plan.Valid values are NotSupported, CreditCard, PurchaseOrder, Premium, Freemium, FreeTrial, AppStore, DigitalExternal, DirectDebit
PlanClassification	String		Identifies the type of plan.
PlanName	String		The name of the Billing Plan.
PlanStartDate	String		The date that the Account started using the current plan.
SeatDiscounts	String		A complex type that contains any seat discount information.
SubscriptionStartDate	Date		Subscription Start Date
SuccessorPlans	String		A list of billing plans that the current billing plan can be rolled into.
SupportIncidentFee	String		The support incident fee charged for each support incident.
SupportPlanFee	String		The support plan fee charged for this plan.

Returns a summary of bulk send batches.

View Specific Information

The Sync App uses the DocuSign API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client-side within the Sync App.

• BatchId supports the '=, IN' operators.
• DateToSearch supports the '=, <, <=, >, >=' operators.
• Status supports the '=' operator.
• UserId supports the '=' operator.

For example, the following queries are processed server-side:

SELECT * FROM BulkSendBatch where batchid = '3b85e723-dee0-44db-ab3d-c45f5db88b6f';
SELECT * FROM BulkSendBatch where batchid in ('3b85e723-dee0-44db-ab3d-c45f5db88b6f','0afbac04-dc4a-4586-8740-7e05f658aa08');
SELECT * FROM BulkSendBatch where status = 'queued';
SELECT * FROM BulkSendBatch where datetosearch = '2017-01-02';
SELECT * FROM BulkSendBatch where datetosearch <= '2024-12-12';
SELECT * FROM BulkSendBatch where datetosearch < '2024-12-12';
SELECT * FROM BulkSendBatch where datetosearch >= '2017-01-02';
SELECT * FROM BulkSendBatch where datetosearch > '2017-01-02'; 
SELECT * FROM BulkSendBatch where userid = 'b3367191-5269-458b-bb21-c177a10b6d26';

Columns

Name	Type	References	Description
BatchId [KEY]	String		The batch ID.
BatchName	String		The name of the batch.
BatchSize	String		The number of envelopes in the batch.
BatchUri	String		The batch details URI.
Failed	String		Number of envelopes that failed to send.
Action	String		Action of batch.
ActionStatus	String		Action status of batch.
Queued	String		Number of envelopes pending processing.
Sent	String		Number of envelopes that have been sent.
SubmittedDate	Datetime		The time stamp of when the batch was created in ISO 8601 format.

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.

Name	Type	Description
DateToSearch	Datetime		Date to search for a date range in UTC DateTime format. The default value is 2016-01-01.
Status	String		The kind of results to collect. Must be one of: all, failed, sent, queued The allowed values are all, failed, sent, queued.
UserId	String		The User ID.

Gets the general status of a specific bulk send batch.

View Specific Information

In order to make a successful request on this view, you must specify:

• BulkSendBatchId - Id of bulk send batch.

For example:

SELECT * FROM BulkSendBatchStatus where bulksendbatchid='2a554c07-6c-bccda356db31'

Columns

Name	Type	References	Description
BulkSendBatchId	String		An identifier that can be used to retrieve a more detailed status of individual bulk recipient batches.
BatchSize	Integer		The number of items returned in this response.
EnvelopesUri	String		The Uri of the bulk envelopes.
SubmittedDate	Datetime		The date the request is submitted.
Sent	Integer		The number of entries with a status of sent.
Failed	Integer		The number of entries with a status of failed.
Queued	Integer		The number of entries with a status of queued.
EnvelopeIdOrTemplateId	String		The EnvelopeId or TemplateId.
Action	String		The action taken.
ActionStatus	String		The status of the action taken.
BatchName	String		The batch name.
BulkErrors	String		Bulk errors.
EnvelopesInfo	String		Envelopes Info.
MailingListId	String		The ID of the mailing list used to create the batch.
MailingListName	String		The name of the mailing list used to create the batch.
OwnerUserId	String		The Owner's User Id.
ResendsRemaining	String		The number of resends remaining.
SenderUserId	String		The sender's User Id.

Retrieves a list of the user's items from the specified cloud storage provider.

View Specific Information

The Sync App will use the DocuSign API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the Sync App.

• FolderId supports the '='.
• UserId supports the '='.
• Serviceid supports the '='.

For example, the following query is processed server side:

select * from CLOUDSTORAGE where UserId='6de49590-65cf-41d4-ac62-399bd97dc1b3' and serviceid='10834292' and folderid='722ad244-59a0-4e30-99a8-45561090b784'

Columns

Name	Type	References	Description
Id [KEY]	String		The storage provider's ID for the file or folder.
UserId	String		Id of the user account
Serviceid	String		The ID of the service to access.Valid values are the service name (Box) or the numerical serviceId (4136).
FolderId	String		The ID of the folder.
ModifiedDate	Datetime		The UTC date and time that the file or folder was last modified.
Img	String		The file extension for a file.
Name	String		The full name of a file.
Size	String		The size of the file. The file size limit varies based on the cloud storage provider.
Supported	Boolean		When true, Docusign supports the file type for upload.
Type	String		The type of cloud storage item. Valid values are file and folder.
Uri	String		The URI for the file or folder.

The CloudStorageProviders resource provides methods that allow you to manage the cloud storage providers associate with an account.

View Specific Information

In order to make a successful request on this view, you have to specify UserId.

For example:

SELECT * FROM CloudStorageProviders WHERE UserId = '9de4ad10-2704-4af7-ae3e-acf27a4bcf0a'

The Sync App will use the DocuSign API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the Sync App.

• ServiceId supports the '='.

For example, the following query is processed server side:

SELECT * FROM CloudStorageProviders WHERE userId = '9de4ad10-2704-4af7-ae3e-acf27a4bcf0a' AND ServiceId = '440189'

Columns

Name	Type	References	Description
UserId	String		Id of the user account
ServiceId	String		The DocuSign generated ID for the cloud storage provider
Service [KEY]	String		The service name for the cloud storage provider.
AuthenticationUrl	String		The authentication URL used for the cloud storage provider.
RedirectUrl	String		The URL the user is redirected to after the cloud storage provider authenticates the user.

The CustomTabs resource provides methods that allow you to manage custom tabs based on the existing DocuSign tabs.

View Specific Information

The Sync App will use the DocuSign API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the Sync App.

• CustomTabId supports the '='.

For example, the following query is processed server side:

SELECT * FROM CustomTabs WHERE CustomTabId = '926770b6-1cb6-487c-918c-dacf8c9caa2a'

Columns

Name	Type	References	Description
CustomTabId [KEY]	String		The DocuSign generated custom tab ID for the custom tab to be applied.
Name	String		Name of the tab.
Type	String		The type of this tab.
TabLabel	String		The label string associated with the tab.
Font	String		The font to be used for the tab value.
Bold	Boolean		When set to true, the information in the tab is bold.
Italic	Boolean		When set to true, the information in the tab is italic.
Underline	Boolean		When set to true, the information in the tab is underlined.
FontColor	String		The font color used for the information in the tab. Possible values are: Black, BrightBlue, BrightRed, DarkGreen, DarkRed, Gold, Green, NavyBlue, Purple, White.
FontSize	String		The font size used for the information in the tab. Possible values are: Size7, Size8, Size9, Size10, Size11, Size12, Size14, Size16, Size18, Size20, Size22, Size24, Size26, Size28, Size36, Size48, Size72.
Width	Integer		Width of the tab in pixels.
Height	Integer		Height of the tab in pixels.
Editable	Boolean		When set to true, the custom tab is editable. Otherwise the custom tab cannot be modified.
DisableAutoSize	Boolean		When set to true, disables the auto sizing of single line text boxes in the signing screen when the signer enters data.
CreatedByUserId	String		The userId of the DocuSign user who created this object.
CreatedByDisplayName	String		The user name of the DocuSign user who created this object.
Locked	Boolean		When set to true, the signer cannot change the data of the custom tab.
LastModified	Datetime		The UTC DateTime this object was last modified. This is in ISO8601 format.
LastModifiedByUserId	String		The userId of the DocuSign user who last modified this object.
LastModifiedByDisplayName	String		The User Name of the DocuSign user who last modified this object.

The Documents resource provides methods that manage documents in an envelope or template.

View Specific Information

In order to make a successful request on this view, you have to specify:

• Type - Possible options are envelopes or templates.
• Id - Id of the envelope or template.

For example:

SELECT * FROM Documents WHERE Type = 'envelopes' AND Id = '764c564c-b540-42d1-a667-ccee6813ef7b'
SELECT * FROM Documents WHERE Type = 'templates' AND Id = 'd5c67830-b37a-4171-9e87-3de377b35a90'

Columns

Name	Type	References	Description
Id [KEY]	String		Id of the Envelope or Template.
Type	String		Specifies where the tab is applied. Possible options are envelopes or templates
DocumentId [KEY]	String		Specifies the document Id number that the tab is placed on. This must refer to an existing Document's ID attribute.
DocumentName	String		Specifies the document name.
DocumentType	String		Specifies the document type.
Uri	String		Uri of the document.
Display	String		This string sets the display and behavior properties of the document during signing. The possible values are: modal - The document is shown as a supplement action strip and can be viewed, downloaded, or printed in a modal window. download - The document is shown as a supplement action strip and can be viewed, downloaded, or printed in a new browser window. inline - The document is shown in the normal signing window.
Order	Integer		An optional value that sets the direction order used to sort the item list. Valid values are: asc = ascending sort order. desc = descending sort order.
Pages	String		Detail of the pages in a document.
DocumentGroup	String		Group of the document.
AttachmentTabId	String		Id of the attachment tab.
AuthoritativeCopy	Boolean		Specifies whether all documents in this envelope are authoritative copies. A document can set its own authoritativeCopy property to override this value. For example you can set the authoritativeCopy on an envelope level to true but can turn it off for a specific document.
ContainsPdfFormFields	String		Indicates pdf form fields.
IncludeInDownload	Boolean		When set to true, the document is included in the combined document download. The default value is true.
SignerMustAcknowledge	String		Sets how the signer interacts with the supplemental document. The possible values are: no_interaction - No recipient action is required. view- The recipient is required to view the document. accept - The recipient is required to accept the document by selecting accept during signing, but is not required to view the document. view_accept - The recipient is required to view and accept the document.
AddedRecipientIds	String		If recipients were added by converting form fields into tabs, their IDs appear here. This property is read-only.
AvailableDocumentTypes	String		Signature Type.
TemplateLocked	String		When true, the sender cannot change any attributes of the recipient. Used only when working with template recipients.
TemplateRequired	String		When true, the sender may not remove the recipient. Used only when working with template recipients.

The DocumentTabs resource provides methods that allow you to manage various tabs in envelopes or templates.

View Specific Information

In order to make a successful request on this view, you have to specify:

• Type - Possible options are envelopes or templates.
• Id - Id of the envelope or template.
• DocumentId - Id of the document.

For example:

SELECT * FROM DocumentTabs WHERE Type = 'templates' AND Id = '32fc6a47-fdd6-40bc-a980-3052d939103e' AND DocumentId = '1'
SELECT * FROM DocumentTabs WHERE Type = 'envelopes' AND Id = 'e8b0dc7a-e914-42b7-a803-36d69e748993' AND DocumentId = '1'

The Sync App will use the DocuSign API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the Sync App.

• PageNumber supports the '='.

For example, the following queries are processed server side:

SELECT * FROM DocumentTabs WHERE Type = 'templates' AND Id = '32fc6a47-fdd6-40bc-a980-3052d939103e' AND DocumentId = '1' AND PageNumber = 1
SELECT * FROM DocumentTabs WHERE Type = 'envelopes' AND Id = 'e8b0dc7a-e914-42b7-a803-36d69e748993' AND DocumentId = '1' AND PageNumber = 3

Columns

Name	Type	References	Description
Id	String		Id of the Envelope or Template.
Type	String		Specifies where the tab is applied. Possible options are envelopes or templates
DocumentId	String	Documents.DocumentId	Specifies the document ID that the tab is placed on.
RecipientId	String		Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document.
PageNumber	Integer		Specifies the page number on which the tab is located. Must be 1 for supplemental documents.
TabId [KEY]	String		The unique identifier for the tab.
CustomTabId	String		The DocuSign generated custom tab ID for the custom tab to be applied.
TabName	String		Name of the tab.
Value	String		Specifies the value of the tab.
Status	String		Status of the tab.
TabLabel	String		The label string associated with the tab.
Font	String		The font to be used for the tab value.
Bold	Boolean		When set to true, the information in the tab is bold.
Italic	Boolean		When set to true, the information in the tab is italic.
Underline	Boolean		When set to true, the information in the tab is underlined.
FontColor	String		The font color used for the information in the tab. Possible values are: Black, BrightBlue, BrightRed, DarkGreen, DarkRed, Gold, Green, NavyBlue, Purple, White.
FontSize	String		The font size used for the information in the tab. Possible values are: Size7, Size8, Size9, Size10, Size11, Size12, Size14, Size16, Size18, Size20, Size22, Size24, Size26, Size28, Size36, Size48, Size72.
XPosition	Integer		This indicates the horizontal offset of the object on the page. DocuSign uses 72 DPI when determining position. Required. May be zero.
YPosition	Integer		This indicates the vertical offset of the object on the page. DocuSign uses 72 DPI when determining position.
AnchorString	String		Specifies the anchor string.
AnchorXOffset	String		Specifies the X axis location of the tab, in achorUnits, relative to the anchorString.
AnchorYOffset	String		Specifies the Y axis location of the tab, in achorUnits, relative to the anchorString.
AnchorUnits	String		Specifies units of the X and Y offset. Units could be pixels, millimeters, centimeters, or inches.
AnchorIgnoreIfNotPresent	Boolean		When set to true, this tab is ignored if anchorString is not found in the document.
TemplateLocked	Boolean		When set to true, the sender cannot change any attributes of the recipient. Used only when working with template recipients.
TemplateRequired	Boolean		When set to true, the sender may not remove the recipient. Used only when working with template recipients.
ConditionalParentLabel	String		For conditional fields this is the TabLabel of the parent tab that controls this tab's visibility.
ConditionalParentValue	String		For conditional fields, this is the value of the parent tab that controls the tab's visibility.

The Document Visibility resource provides methods that manage document views and insights in an envelope or template.

View Specific Information

In order to make a successful request on this view, you have to specify:

• Type - Possible options are envelopes or templates.
• Id - Id of the envelope or template.
• RecipientId - Id of the recipient.

For example:

SELECT * FROM DocumentVisibility WHERE Type = 'envelopes' AND Id = '764c564c-b540-42d1-a667-ccee6813ef7b' AND RecipientId = 77419544
SELECT * FROM DocumentVisibility WHERE Type = 'templates' AND Id = 'd194aa0a-723e-4db9-a8be-801dffbb63ff' AND RecipientId = 75619544

Columns

Name	Type	References	Description
Id [KEY]	String		Id of the Envelope or Template.
Type	String		Specifies where the tab is applied. Possible options are envelopes or templates
RecipientId	Integer		Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document.
DocumentId	String	Documents.DocumentId	Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute.
Visible	Boolean		When set to true, the document is visible.
Rights	String		Rights of the recipient for this document.

The EnvelopeAttachments resource provides methods that allow you to manage attachments.

View Specific Information

In order to make a successful request on this view, you have to specify EnvelopeId.

For example:

SELECT * FROM EnvelopeAttachments WHERE EnvelopeId = '56e3ca38-8008-441e-a29e-eb23dd3269e1'

Columns

Name	Type	References	Description
EnvelopeId	String	Envelopes.EnvelopeId	The envelope ID.
AttachmentId [KEY]	String		Id of the attachment.
AttachmentType	String		Type of the attachment.
Name	String		Name of the attachment.
Label	String		Label of the attachment.
AccessControl	String		AccessControl of the attachment.

The EnvelopeConsumerDisclosures resource provides a method that allows you to retrieve the consumer disclosure for an envelope.

View Specific Information

In order to make a successful request on this view, you have to specify EnvelopeId and RecipientId.

For example:

SELECT * FROM [EnvelopeConsumerDisclosures] WHERE EnvelopeId = '7cc4251f-31ca-4a79-8221-53451222292d' AND RecipientId = 68364179

Columns

Name	Type	References	Description
EnvelopeId	String		The envelope ID.
RecipientId	String		Unique Id for the recipient.
AccountEsignId [KEY]	String		A GUID identifying the account associated with the consumer disclosure.
CompanyName	String		The name of the company associated with the consumer disclosure.
CompanyPhone	String		The phone number of the company associated with the consumer disclosure.
ChangeEmail	String		Email of the account.
ChangeEmailOther	String		Other email information.
CopyCostPerPage	String		Copy cost for a page.
CopyFeeCollectionMethod	String		Specifies the fee collection method for cases in which the customer requires paper copies of the document.
EnableEsign	String		When is set to true, Esign is enabled.
EsignAgreement	String		The Electronic Record and Signature Disclosure text. The disclosure text includes the html formatting.
EsignText	String		Text of the Esign.
MustAgreeToEsign	String		When is set ti true, customer must agree.
PdfId	String		The pdfId property in the consumer_disclosure PUT request is deprecated. For security reasons going forward, any value provided in the request packet must be ignored.
AllowCDWithdraw	String		Indicates whether the customer can withdraw their acceptance of the consumer disclosure.
WithdrawAddressLine1	String		Contains the first address line of the postal address to which a customer can send a consent withdrawal notification.
WithdrawAddressLine2	String		Contains the second address line of the postal address to which a customer can send a consent withdrawal notification.
WithdrawByEmail	String		Indicates whether the customer can withdraw consent by email.
WithdrawByMail	String		Indicates whether the customer can withdraw consent by postal mail.
WithdrawByPhone	String		Indicates whether the customer can withdraw consent by phone.
WithdrawCity	String		Contains the city of the postal address to which a customer can send a consent withdrawal notification.
WithdrawConsequences	String		Indicates the consequences of withdrawing consent.
WithdrawEmail	String		Contains the email address to which a customer can send a consent withdrawal notification.
WithdrawOther	String		Indicates other information need to withdraw consent.
WithdrawPhone	String		Contains the phone number which a customer can call to register consent withdrawal notification.
withdrawPostalCode	String		Contains the postal code of the postal address to which a customer can send a consent withdrawal notification.
WithdrawState	String		Contains the state of the postal address to which a customer can send a consent withdrawal notification.
CopyRequestEmail	String		The email address to which the customer should send a request for copies of a document.
Custom	String		When true, indicates that the consumer disclosure is a custom disclosure. The default is false.
LanguageCode	String		The code for the language version of the disclosure.
UseConsumerDisclosureWithinAccount	String		When true, specifies that recipients in the same account as the sender must agree to eSign an Electronic Record and Signature Disclosure Statement.

Returns envelope tab data for an existing envelope.To use this feature, the Sending Setting Allow sender to download form data must be enabled for the account.

View Specific Information

In order to make a successful request on this view, you have to specify EnvelopeId and AccountId.

For example:

SELECT * FROM EnvelopeFormData WHERE EnvelopeId='ea5f242a-0cb8-4e81-ae69-2be80ceabd84' AND AccountId='5cbbef28-5902-402d-a065-6da3525c9d9d'

Columns

Name	Type	References	Description
EnvelopeId [KEY]	String		The envelope ID.
AccountId	String		The ID of the account.
PreFillFormDataSenderEmail	String		The sender's email address.
PreFillFormDataFormData	String		An array of Pre FillForm Form Data.
PreFillFormDataSendUserId	String		The User ID of the sender.
PreFillFormDataSenderName	String		The sender's name.
FormData	String		An array of formDataItem objects.
EmailSubject	String		The subject line of the email message that is sent to all recipients.
Status	String		Indicates the envelope status. Valid values are: sent,created.
SentDateTime	Datetime		Indicates the sent date time
RecipientFormData	String		An array of form data for each recipient of the envelope.

The Envelope provides methods that allow you to manage envelopes

View Specific Information

The Sync App will use the DocuSign API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the Sync App.

• EnvelopeId supports the '='.
• Status supports the '='.
• DateToSearch supports the '=,>,>=,<,<='.

For example, the following queries are processed server side:

SELECT * FROM Envelopes WHERE EnvelopeId = '764c564c-b540-42d1-a667-ccee6813ef7b'
SELECT * from Envelopes where DateToSearch <= '2024-05-15 10:55:11'
SELECT * from Envelopes where DateToSearch >= '2024-05-15 10:55:11'

Columns

Name	Type	References	Description
EnvelopeId [KEY]	String		The envelope ID.
EnvelopeUri	String		Contains a URI for an endpoint that you can use to retrieve the envelope or envelopes.
Status	String		Indicates the envelope status. Valid values are: completed - The envelope has been completed and all tags have been signed. created - The envelope is created as a draft. It can be modified and sent later. declined - The envelope has been declined by the recipients. delivered - The envelope has been delivered to the recipients. sent - The envelope is sent to the recipients. signed - The envelope has been signed by the recipients. voided - The envelope is no longer valid and recipients cannot access or sign the envelope.
EnvelopeIdStamping	String		When set to true, Envelope ID Stamping is enabled.
EmailSubject	String		Specifies the subject of the email that is sent to all recipients.
EmailBlurb	String		This is the same as the email body.
SenderUserName	String		The sender username associated with the envelope.
SenderUserId	String		The sender user ID associated with the envelope.
SenderAccountId	String		The sender account ID associated with the envelope.
SenderEmail	String		The sender email associated with the envelope.
DocumentsUri	String		Contains a URI for an endpoint that you can use to retrieve the documents.
DocumentsCombinedUri	String		Contains a URI for an endpoint that you can use to retrieve the combined documents.
AttachmentsUri	String		Contains a URI for an endpoint that you can use to retrieve the attachments.
RecipientsUri	String		Contains a URI for an endpoint that you can use to retrieve the recipients.
CustomFieldsUri	String		Contains a URI for an endpoint to retrieve the custom fields.
CertificateUri	String		Retrieves a URI for an endpoint allowing you to easily retrieve certificate information.
NotificationUri	String		Contains a URI for an endpoint that you can use to retrieve the notifications.
SigningLocation	String		Specifies the physical location where the signing takes place. It can have two enumeration values; InPerson and Online. The default value is Online.
BrandId	String		The unique identifier of a brand.
BrandLock	String		Lock of the brand.
SentDateTime	Datetime		The date and time the envelope was sent.
CompletedDateTime	Datetime		Specifies the date and time this item was completed.
CreatedDateTime	Datetime		Indicates the date and time the item was created.
DeclinedDateTime	Datetime		The date and time the recipient declined the document.
LastModifiedDateTime	Datetime		The date and time the item was last modified.
DeletedDateTime	Datetime		Specifies the data and time the item was deleted.
StatusChangedDateTime	Datetime		The data and time the status changed.
VoidedDateTime	Datetime		The date and time the envelope was voided.
VoidedReason	String		The reason the envelope was voided.
MessageLock	String		When set to true, prevents senders from changing the contents of emailBlurb and emailSubject properties for the envelope.
RecipientsLock	String		When set to true, prevents senders from changing, correcting, or deleting the recipient information for the envelope.
PurgeState	String		Shows the current purge state for the envelope. The possible values are: unpurged: There has been no successful request to purge documents. documents_queued: The envelope documents have been added to the purge queue, but have not been purged. documents_dequeued: The envelope documents have been taken out of the purge queue. documents_and_metadata_queued: The envelope documents and metadata have been added to the purge queue, but have not yet been purged. documents_purged: The envelope documents have been successfully purged. documents_and_metadata_purged: The envelope documents and metadata have been successfully purged.
EnableWetSign	String		When set to true, the signer is allowed to print the document and sign it on paper.
EnforceSignerVisibility	String		When set to true, documents with tabs can only be viewed by signers that have a tab on that document. Recipients that have an administrative role (Agent, Editor, or Intermediaries) or informational role (Certified Deliveries or Carbon Copies) can always see all the documents in an envelope, unless they are specifically excluded using this setting when an envelope is sent.
AllowReassign	String		When set to true, the recipient can redirect an envelope to a more appropriate recipient.
AllowMarkup	String		When set to true, Document Markup is enabled for envelope.
Asynchronous	String		When set to true, the envelope is queued for processing and the value of the status property is set to 'Processing'. Additionally, get status calls return 'Processing' until completed.
AuthoritativeCopy	String		Specifies whether all documents in this envelope are authoritative copies.
AuthoritativeCopyDefault	String		The default authoritativeCopy setting for documents in this envelope that do not have authoritativeCopy set.
AutoNavigation	String		Specifies whether auto navigation is set for the recipient.
ItemURL	String		Contains a ItemUrl to retrieve the envelopes.

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.

Name	Type	Description
DateToSearch	Datetime		Date to search.

The EnvelopeTemplates resource provides methods that allow you to add and delete templates on envelopes and documents.

View Specific Information

In order to make a successful request on this view, you have to specify EnvelopeId.

For example:

SELECT * FROM EnvelopeTemplates WHERE EnvelopeId = '11dc472d-5675-47b7-ac4e-96c47e473dfe'

The Sync App will use the DocuSign API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client side within the Sync App.

• DocumentId supports the '=' operator.

For example, the following query is processed server side:

SELECT * FROM EnvelopeTemplates WHERE EnvelopeId = 'cd7a0feb-2911-4595-a28e-deaa4a51f55d' AND DocumentId = '3'

Columns

Name	Type	References	Description
EnvelopeId [KEY]	String	Envelopes.EnvelopeId	The envelope ID.
TemplateId	String	Templates.TemplateId	The unique identifier of the template. If this is not provided, DocuSign will generate a value.
Name	String		Name of the template.
DocumentId	String	Documents.DocumentId	Specifies the document ID number.
DocumentName	String		Name of the document.
Applied	Boolean		When set to true, template is applied.
Uri	String		Uri of the template.

Retrieves a list of the folders for the account.

View Specific Information

DocuSign does not support any column for filtering this view. All filters will be executed client side.

Columns

Name	Type	References	Description
FolderId [KEY]	String		The ID of the folder being accessed.
ParentFolderId	String		Id of the parent folder.
ParentFolderUri	String		Uri of the parent folder.
Name	String		Name of the folder.
Type	String		Type of the folder.
Uri	String		Uri of the folder.
OwnerUserId	String		Owner id of the folder.
OwnerUserName	String		Owner name of the folder.
OwnerEmail	String		Owner email of the folder.
ItemURL	String		ItemUrl of the folder.
HasSubFolders	String		When true, the folder has subfolders
ItemCount	String		The number of items in the folder.

The GroupBrands resource provides methods that allow you to manage brands in a group.

View Specific Information

In order to make a successful request on this view, you have to specify GroupId.

For example:

SELECT * FROM GroupBrands WHERE GroupId = 6160665

Columns

Name	Type	References	Description
GroupId	Integer	Groups.GroupId	The DocuSign group ID for the group.
BrandId [KEY]	String	AccountBrands.BrandId	Id of the brand.
InternalId	String		Internal Id of the brand.
BrandName	String		Name of the brand.
BrandCompany	String		The name of the company associated with this brand.
BrandLanguages	String		An array of two-letter codes for the languages that you want to use with the brand
Colors	String		An array of name-value pairs specifying the colors that the brand uses.
DefaultBrandLanguage	String		The two-letter code for the language that you want to use as the brand default.
ErrorDetails	String		This object describes errors that occur. It is only valid for responses and ignored in requests.
IsOrganizationBrand	String		IsOrganizationBrand
IsOrganizationBrandLogo	String		IsOrganizationBrandLogo
IsOverridingCompanyName	String		When true, the brandCompany property is overriding the name of the company in the account settings.
IsSendingDefault	String		When true, the sending brand is the default brand for sending new envelopes
IsSigningDefault	String		When true, the siging brand is the default brand for the signing experience.
LandingPages	String		An array of name/value pairs specifying the pages to which the user is redirected after the following events occur: Signing Completed, Viewed Exit, Finish Later, Decline, Session Timeout, Authentication Failure.If you do not specify landing pages, the Docusign default pages are used.
Links	String		An array of brandLink objects that contain information about the links that the brand uses.
Logos	String		The URIs for retrieving the logos that are associated with the brand.

The Groups resource provides methods that allow you to manage groups for the account.

The Sync App will use the DocuSign API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the Sync App.

• GroupType supports the '='.

For example, the following query is processed server side:

SELECT * FROM Groups WHERE GroupType = 'everyoneGroup'

Columns

Name	Type	References	Description
GroupId [KEY]	Integer		The DocuSign group ID for the group.
GroupName	String		The name of the group.
GroupType	String		The group type.
UsersCount	Integer		Total number of users of the group.
PermissionProfileId	String		The ID of the permission profile associated with the group.

The GroupUsers resource provides methods that allow you to manage the users in a group.

View Specific Information

In order to make a successful request on this view, you have to specify GroupId.

For example:

SELECT * FROM GroupUsers WHERE GroupId = 6071932

Columns

Name	Type	References	Description
GroupId [KEY]	Integer	Groups.GroupId	The DocuSign group ID for the group.
UserId [KEY]	String	Users.UserId	Id of the user account
UserName	String		Name of the user account
Email	String		Email of the user account
UserType	String		Type of the user account
UserStatus	String		Status of the user account. One of: ActivationRequired, ActivationSent, Active, Closed, Disabled.
Uri	String		Uri of the user account
LoginStatus	String		Status of login.
SendActivationEmail	Boolean		When set to true, an activation email can be sent.
ActivationAccessCode	String		Activation code for access.

The Locks resource provides methods that allow you to manage locks on an envelope or template.

View Specific Information

In order to make a successful request on this view, you have to specify:

• Type - Possible options are envelopes or templates.
• Id - Id of the envelope or template.

For example:

SELECT * FROM Locks WHERE Type = 'templates' AND Id = '22093429-0c89-47d3-a984-8b919768b963'
SELECT * FROM Locks WHERE Type = 'envelopes' AND Id = '03ea05dc-b5ba-45d2-8b0c-3bf0f5ae8d59'

Columns

Name	Type	References	Description
Id [KEY]	String	Envelopes.EnvelopeId or Templates.TemplateId	Id of the Envelope or Template.
Type	String		Specifies where the tab is applied. Possible options are envelopes or templates
LockedByUserName	String		Name of the user.
LockedByUserId	String		The user ID of the user being accessed.
LockedByUserEmail	String		Email of the user.
LockedByUri	String		Uri of the user.
LockedByApp	String		Specifies the friendly name of the application that is locking the envelope.
LockType	String		The type of envelope lock. Currently
LockToken	String		A unique identifier provided to the owner of the envelope lock. Used to prove ownership of the lock.
LockedUntilDateTime	Datetime		The datetime until the envelope lock expires.
LockDurationInSeconds	String		Sets the time, in seconds, until the lock expires when there is no activity on the envelope.
UseScratchPad	String		Indicates whether a scratchpad is used for editing information.

The PowerForms resource provides methods that allow you to manage power forms.

View Specific Information

The Sync App will use the DocuSign API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the Sync App.

• PowerFormId supports the '='.

For example, the following query is processed server side:

SELECT * FROM PowerForms WHERE PowerFormId = '3caf8d81-1c18-4ff6-bc1b-39e4ab8c2692'

Columns

Name	Type	References	Description
PowerFormId [KEY]	String		The unique identifier of the power form.
Name	String		PowerForm name.
PowerFormUrl	String		Contains a URI for an endpoint that you can use to retrieve the PowerForms.
PowerFormV2Url	String		Contains V2 URI for an endpoint that you can use to retrieve the PowerForms.
Uri	String		Uri of the powerforms.
TemplateId	String	Templates.TemplateId	The unique identifier of the template. If this is not provided, DocuSign will generate a value.
TemplateName	String		Name of the template.
CreatedBy	String		Creator name.
CreatedDateTime	Datetime		Indicates the date and time the item was created.
SenderName	String		Name of the sender.
SenderUserId	String		User Id of the sender.
EmailBody	String		Email body of the message sent to the recipient.
EmailSubject	String		The subject of the email that is sent to all recipients.
SigningMode	String		Specifies the mode of the signing.
Instructions	String		Specifies the PowerForm instructions.
IsActive	Boolean		Indicates the status of the PowerForm.
TimesUsed	Integer		Indicates number of times the item was used.
LastUsed	Datetime		Indicates the date and time the item was used for the last time.
MaxUseEnabled	Boolean		The maximum of using times for the item.
UsesRemaining	Integer		The remaining number of times the item can be used.
LimitUseIntervalEnabled	Boolean		Status of the LimitUseInterval.
LimitUseInterval	String		Specifies the interval of the uses limit.
LimitUseIntervalUnits	String		Unit type of the LimitUseInterval.

Returns the user authorizations for which the user specified by userId is the principal user.

The Sync App will use the DocuSign API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the Sync App.

• Permission supports the '=' operator.
• Email supports the '=' operator.
• Name supports the '=' operator.
• UserId supports the '=' operator.
• ActiveOnly supports the '=' operator.
• IncludeClosedUsers supports the '=' operator.

For example, the following queries are processed server side:

SELECT * FROM PrincipalUserAuthorizations WHERE UserId = 'b3367191-5269-458b-bb21-c177a10b6d25'

Columns

Name	Type	References	Description
AuthorizationId [KEY]	String		The ID of the user authorization.
Created	Datetime		The UTC DateTime when the workspace user authorization was created.
CreatedBy	String		The name and email of the user who created the authorization.
EndDate	Datetime		The UTC DateTime at which the authorization will expire.
Modified	Datetime		The UTC DateTime when the workspace user authorization was last updated.
ModifiedBy	String		The name and email of the user who created the authorization.
Permission	String		The permission level to grant the agent. Valid values are : Send, Manage, Sign, Edit
AccountId	String		The account ID.
Email	String		The email address of the authorization user.
Name	String		The name of the authorization user.
UserId	String		The ID of the authorization user.
StartDate	Datetime		The UTC DateTime at which the authorization will start.
AgentUserId	String		The ID of the authorization user agent.
AgentName	String		The name of the authorization user agent.
AgentEmail	String		The email of the authorization user agent.

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.

Name	Type	Description
ActiveOnly	Boolean		When true, only active users are returned. The default value is false.
IncludeClosedUsers	Boolean		When true, returns active and scheduled authorizations of closed users. The default value is true. This value is only applied when active_only is false.

The Recipients resource allows you manage the recipients of an envelope or template.

View Specific Information

In order to make a successful request on this view, you have to specify:

• Type - Possible options are envelopes or templates.
• Id - Id of the envelope or template.

For example:

SELECT * FROM Recipients WHERE Type = 'templates' AND Id = '22093429-0c89-47d3-a984-8b919768b963'
SELECT * FROM Recipients WHERE Type = 'envelopes' AND Id = '03ea05dc-b5ba-45d2-8b0c-3bf0f5ae8d59'

Columns

Name	Type	References	Description
Type	String		Specifies where the tab is applied. Possible options are envelopes or templates
Id	String		Id of the Envelope or Template.
RecipientId [KEY]	Integer		Unique Id for the recipient.
RecipientIdGuid	String		Id guid of the recipient.
RecipientType	String		Type of the recipient.
UserId	String		The user ID of the user being accessed.
Name	String		Name of the recipient.
Email	String		Email of the recipient.
RoleName	String		Optional element. Specifies the role name associated with the recipient.
Note	String		A note sent to the recipient in the signing email. This note is unique to this recipient.
CreationReason	String		Reason of the creation.
ClientUserId	String		Specifies whether the recipient is embedded or remote. If the clientUserId property is not null then the recipient is embedded. Use this field to associate the signer with their userId in your app. Authenticating the user is the responsibility of your app when you use embedded signing.
AccessCode	String		If a value is provided, the recipient must enter the value as the access code to view and sign the envelope.
RequireIdLookup	Boolean		When set to true, the recipient is required to use the specified ID check method (including Phone and SMS authentication) to validate their identity.
DeliveryMethod	String		Method of the delivery.
DeliveredDateTime	Datetime		Date and time of the delivery.
SignedDateTime	Datetime		The date and time the envelope was signed.
SigningGroupId	String		The display Id for the signing group.
SigningGroupName	String		The display name for the signing group.
CanSignOffline	Boolean		When set to true, specifies that the signer can perform the signing ceremony offline.
Status	String		Recipient status.
Agents	String		A list of agent recipients assigned to the documents.
CarbonCopies	String		A list of carbon copy recipients assigned to the documents.
CertifiedDeliveries	String		A complex type containing information on a recipient the must receive the completed documents for the envelope to be completed, but the recipient does not need to sign, initial, date, or add information to any of the documents.
CurrentRoutingOrder	String		The routing order of the current recipient. If this value equals a particular signer's routing order, it indicates that the envelope has been sent to that recipient, but he or she has not completed the required actions.
InPersonSigners	String		Specifies a signer that is in the same physical location as a Docusign user who will act as a Signing Host for the transaction. The recipient added is the Signing Host and new separate Signer Name field appears after Sign in person is selected.
Intermediaries	String		Identifies a recipient that can, but is not required to, add name and email information for recipients at the same or subsequent level in the routing order (until subsequent Agents, Editors or Intermediaries recipient types are added).
Notaries	String		A list of notary recipients on the envelope.
Seals	String		A list of electronic seals to apply to the documents
RecipientCount	String		The number of recipients in the envelope.

The RecipientTabs resource provides methods that let you add, update, and delete tabs from an envelope or template.

View Specific Information

In order to make a successful request on this view, you have to specify:

• Type - Possible options are envelopes or templates.
• Id - Id of the envelope or template.
• RecipientId - Id of the recipient.

For example:

SELECT * FROM RecipientTabs WHERE Type = 'templates' AND Id = '32fc6a47-fdd6-40bc-a980-3052d939103e' AND RecipientId = 7296558
SELECT * FROM RecipientTabs WHERE Type = 'envelopes' AND Id = 'e8b0dc7a-e914-42b7-a803-36d69e748993' AND RecipientId = 44407249

Columns

Name	Type	References	Description
Id	String		Id of the Envelope or Template.
Type	String		Specifies where the tab is applied. Possible options are envelopes or templates
DocumentId	String	Documents.DocumentId	Specifies the document ID number that the tab is placed on.
RecipientId	Integer	Recipients.RecipientId	Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document.
TabId [KEY]	String		The unique identifier for the tab.
CustomTabId	String	CustomTabs.CustomTabId	The DocuSign generated custom tab ID for the custom tab to be applied.
Name	String		Name of the tab.
Status	String		Status of the tab.
TabLabel	String		The label string associated with the tab.
Font	String		The font to be used for the tab value.
Bold	Boolean		When set to true, the information in the tab is bold.
Italic	Boolean		When set to true, the information in the tab is italic.
Underline	Boolean		When set to true, the information in the tab is underlined.
FontColor	String		The font color used for the information in the tab. Possible values are: Black, BrightBlue, BrightRed, DarkGreen, DarkRed, Gold, Green, NavyBlue, Purple, White.
FontSize	String		The font size used for the information in the tab. Possible values are: Size7, Size8, Size9, Size10, Size11, Size12, Size14, Size16, Size18, Size20, Size22, Size24, Size26, Size28, Size36, Size48, Size72.
TabOrder	String		A positive integer that sets the order the tab is navigated to during signing.
PageNumber	Integer		Specifies the page number on which the tab is located. Must be 1 for supplemental documents.
XPosition	Integer		This indicates the horizontal offset of the object on the page. DocuSign uses 72 DPI when determining position. Required. May be zero.
YPosition	Integer		This indicates the vertical offset of the object on the page. DocuSign uses 72 DPI when determining position.
AnchorString	String		Specifies the anchor string.
AnchorXOffset	String		Specifies the X axis location of the tab, in achorUnits, relative to the anchorString.
AnchorYOffset	String		Specifies the Y axis location of the tab, in achorUnits, relative to the anchorString.
AnchorUnits	String		Specifies units of the X and Y offset. Units could be pixels, millimeters, centimeters, or inches.
AnchorIgnoreIfNotPresent	String		When set to true, this tab is ignored if anchorString is not found in the document.
TemplateLocked	Boolean		When set to true, the sender cannot change any attributes of the recipient. Used only when working with template recipients.
TemplateRequired	Boolean		When set to true, the sender may not remove the recipient. Used only when working with template recipients.
ConditionalParentLabel	String		For conditional fields this is the TabLabel of the parent tab that controls this tab's visibility.
ConditionalParentValue	String		For conditional fields, this is the value of the parent tab that controls the tab's visibility.
IsSealSignTab	String		IsSealSignTab.
ScaleValue	String		The Value for scale
StampType	String		The type of stamp.

Represents an instance or copy of an envelope

View Specific Information

The Sync App uses the DocuSign API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the Sync App.

• BulkSendListId supports the '='.

For example, the following queries are processed server side:

SELECT * FROM SendListBulkCopies
SELECT * FROM SendListBulkCopies WHERE BulkSendListId = 'asd-wdas-dw'

Columns

Name	Type	References	Description
BulkSendListId	String	SendLists.BulkSendListId	The GUID of the bulk send list.
Recipients	String		Unique Id for the recipient.
DocGenFormFields	String		Specifies the recipient's email address.
EmailBlurb	String		The email body for this copy of the envelope.
EmailSubject	String		The email subject line for this copy of the envelope.
CustomFields	String		An optional array of strings that allows the sender to provide custom data about the recipient.

This method returns all of the details of recipents associated with a specific bulk send list that belongs to the current user.

View Specific Information

The Sync App uses the DocuSign API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the Sync App.

• BulkSendListId supports the '='.

For example, the following queries are processed server side:

SELECT * FROM SendListRecipients
SELECT * FROM SendListRecipients WHERE BulkSendListId = 'asd-wdas-dw'

Columns

Name	Type	References	Description
BulkSendListId	String	SendLists.BulkSendListId	The GUID of the bulk send list.
RecipientId	String		Unique Id for the recipient.
Email	String		Specifies the recipient's email address.
Name	String		Specifies the recipient's name.
ClientUserId	String		Specifies whether the recipient is embedded or remote.
CustomFields	String		An optional array of strings that allows the sender to provide custom data about the recipient.
DeliveryMethod	String		The delivery method.
EmailNotification	String		This optional property allows you to set a specific email subject and body for this recipient's notification email.
EmbeddedRecipientStartURL	String		Specifies a sender-provided valid URL string for redirecting an embedded recipient.
HostEmail	String		The email address of the signing host.
HostName	String		The name of the signing host.
IdCheckConfigurationName	String		The name of the authentication check to use.
IdCheckInformationInput	String		An object that contains input information related to a recipient ID check.
IdentificationMethod	String		Identification Method.
IdentityVerification	String		Specifies the ID Verification workflow applied on an envelope by workflow ID.
PhoneAuthentication	String		When idCheckConfigurationName is set to Phone Auth \$, you use this complex type to provide the recipient authentication method details.
RecipientSignatureProviders	String		The default signature provider is the DocuSign Electronic signature system.
RoleName	String		The name of the role associated with the recipient.
Note	String		A note sent to the recipient in the signing email. This note is unique to this recipient.
SignerName	String		The in-person signer's full legal name.
SigningGroupId	String		The ID of the signing group.
AccessCode	String		If a value is provided, the recipient must enter the value as the access code to view and sign the envelope.
PhoneNumber	String		This is only used if the Identification field value is Phone or SMS.
SMSAuthentication	String		When idCheckConfigurationName is set to SMS Auth \$, you use this complex type to provide the recipient authentication method details.
Tabs	String		A list of tabs associated with the recipient.

A list of bulk send lists belonging to the current user, as well as basic information about each list.

View Specific Information

DocuSign does not support any column for filtering this view. All filters are executed client side.

Columns

Name	Type	References	Description
BulkSendListId	String		The GUID of the bulk send list.
CreatedByUser	String		The GUID of the user who created the bulk send list.
CreatedDate	Datetime		The UTC DateTime that the bulk send list was created.
Name	String		Specifies the recipient's name.

Retrieves the list of information about the shared envelopes.

The Sync App will use the DocuSign API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the Sync App.

• UserUserId supports the '=' and 'IN' operators.
• UserUserStatus supports the '=' operator.
• SearchText supports the '=' operator.
• Shared supports the '=' operator.

For example, the following queries are processed server side:

SELECT * FROM SharedAccessEncelopes

Columns

Name	Type	References	Description
UserUserId [KEY]	String		Information about the user who owns the shared item. The ID of the user to access.
Shared	String		How the item is shared. One of: not_shared, shared_to, shared_from, shared_to_and_from.
UserAccountId	String		Information about the user who owns the shared item. The account ID associated with the envelope.
UserAccountName	String		Information about the user who owns the shared item. The name on the account.
UserActivationAccessCode	String		Information about the user who owns the shared item. Access code provided to the user to activate the account.
UserEmail	String		Information about the user who owns the shared item. The user's email address.
UserIpAddress	String		Information about the user who owns the shared item. The user's ip address.
UserLoginStatus	String		Information about the user who owns the shared item. When true, indicates that the user is logged in.
UserMembershipId	String		Information about the user who owns the shared item. The user's membership ID.
UserUri	String		Information about the user who owns the shared item. A URI containing the user ID.
UserUserName	String		Information about the user who owns the shared item. The name of the user.
UserUserStatus	String		Information about the user who owns the shared item. Status of the user's account. One of: ActivationRequired, ActivationSent, Active, Closed, Disabled.
UserUserType	String		Information about the user who owns the shared item. The type of user.

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.

Name	Type	Description
SearchText	String		Filter user names based on the specified string. The wild-card '*' (asterisk) can be used in the string.

Retrieves the list of information about the shared folders.

The Sync App will use the DocuSign API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the Sync App.

• FolderId supports the '=' and 'IN' operators.
• UserUserId supports the '=' and 'IN' operators.
• UserUserStatus supports the '=' operator.
• SearchText supports the '=' operator.
• Shared supports the '=' operator.

For example, the following queries are processed server side:

SELECT * FROM SharedAccessFolders

Columns

Name	Type	References	Description
FolderId [KEY]	String		The ID of the folder.
FolderName	String		The name of the folder.
OwnerAccountId	String		Information about the user who owns the folder. The account ID associated with the folder.
OwnerAccountName	String		Information about the user who owns the folder. The name on the account.
OwnerActivationAccessCode	String		Information about the user who owns the folder. Access code provided to the user to activate the account.
OwnerEmail	String		Information about the user who owns the folder. The user's email address.
OwnerIpAddress	String		Information about the user who owns the folder. The user's ip address.
OwnerLoginStatus	String		Information about the user who owns the folder. When true, indicates that the user is logged in.
OwnerMembershipId	String		Information about the user who owns the folder. The user's membership ID.
OwnerUri	String		Information about the user who owns the folder. A URI containing the user ID.
OwnerUserId	String		Information about the user who owns the folder. The ID of the user to access.
OwnerUserName	String		Information about the user who owns the folder. The name of the user.
OwnerUserStatus	String		Information about the user who owns the folder. Status of the user's account. One of: ActivationRequired, ActivationSent, Active, Closed, Disabled.
OwnerUserType	String		Information about the user who owns the folder. The type of user.
ParentFolderId	String		The ID of the parent folder.
ParentFolderUri	String		The URI for the parent folder.
Shared	String		Indicates how the folder is shared. Valid values are: shared_to, not_shared.
SharedGroups	String		A list of groups that shared the folder.
SharedUsers	String		A list of users who share the folder.
Uri	String		A URI containing the user ID.
UserAccountId	String		Information about the user associated with the folder. The account ID associated with the folder.
UserAccountName	String		Information about the user associated with the folder. The name on the account.
UserActivationAccessCode	String		Information about the user associated with the folder. Access code provided to the user to activate the account.
UserEmail	String		Information about the user associated with the folder. The user's email address.
UserIpAddress	String		Information about the user associated with the folder. The user's ip address.
UserLoginStatus	String		Information about the user associated with the folder. When true, indicates that the user is logged in.
UserMembershipId	String		Information about the user associated with the folder. The user's membership ID.
UserUri	String		Information about the user associated with the folder. A URI containing the user ID.
UserUserId	String		Information about the user associated with the folder. The ID of the user to access.
UserUserName	String		Information about the user associated with the folder. The name of the user.
UserUserStatus	String		Information about the user associated with the folder. Status of the user's account. One of: ActivationRequired, ActivationSent, Active, Closed, Disabled.
UserUserType	String		Information about the user associated with the folder. The type of user.

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.

Name	Type	Description
SearchText	String		Filter user names based on the specified string. The wild-card '*' (asterisk) can be used in the string.

Retrieves the list of information about the shared templates.

The Sync App will use the DocuSign API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the Sync App.

• TemplateId supports the '=' and 'IN' operators.
• SearchText supports the '=' operator.
• Shared supports the '=' operator.

For example, the following queries are processed server side:

SELECT * FROM SharedAccessTemplates

Columns

Name	Type	References	Description
TemplateId [KEY]	String		The unique identifier of the template. If this is not provided, Docusign will generate a value.
TemplateName	String		The name of the shared template.
OwnerAccountId	String		Information about the user who owns the template. The account ID associated with the envelope.
OwnerAccountName	String		Information about the user who owns the template. The name on the account.
OwnerActivationAccessCode	String		Information about the user who owns the template. Access code provided to the user to activate the account.
OwnerEmail	String		Information about the user who owns the template. The user's email address.
OwnerIpAddress	String		Information about the user who owns the template. The user's ip address.
OwnerLoginStatus	String		Information about the user who owns the template. When true, indicates that the user is logged in.
OwnerMembershipId	String		Information about the user who owns the template. The user's membership ID.
OwnerUri	String		Information about the user who owns the template. A URI containing the user ID.
OwnerUserId	String		Information about the user who owns the template. The ID of the user to access.
OwnerUserName	String		Information about the user who owns the template. The name of the user.
OwnerUserStatus	String		Information about the user who owns the template. Status of the user's account. One of: ActivationRequired, ActivationSent, Active, Closed, Disabled
OwnerUserType	String		Information about the user who owns the template. The type of user.
Password	String		The user's password.
Shared	String		How the template is shared. One of: not_shared, shared_to.
SharedGroups	String		List of groups that share the template.
SharedUsers	String		List of users that share the template.

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.

Name	Type	Description
SearchText	String		Filter user names based on the specified string. The wild-card '*' (asterisk) can be used in the string.

Retrieves the information about the user requesting the shared information.

The Sync App will use the DocuSign API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the Sync App.

• UserId supports the '=' and 'IN' operators.
• UserStatus supports the '=' operator.
• SearchText supports the '=' operator.

For example, the following queries are processed server side:

SELECT * FROM SharedAccessUser

Columns

Name	Type	References	Description
UserId [KEY]	String		The ID of the user to access.
AccountId	String		The account ID associated with the envelope.
AccountName	String		The name on the account.
ActivationAccessCode	String		Access code provided to the user to activate the account.
Email	String		The user's email address.
IpAddress	String		The user's ip address.
LoginStatus	String		When true, indicates that the user is logged in.
MembershipId	String		The user's membership ID.
Uri	String		A URI containing the user ID.
UserName	String		The name of the user.
UserStatus	String		Status of the user's account. One of: ActivationRequired, ActivationSent, Active, Closed, Disabled
UserType	String		The type of user.

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.

Name	Type	Description
SearchText	String		Filter user names based on the specified string. The wild-card '*' (asterisk) can be used in the string.

Returns data from a sample table.

View Specific Information

The Sync App will use the DocuSign API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the Sync App.

• SigningGroups supports the '='.

For example, the following queries are processed server side:

SELECT * FROM SigningGroups WHERE SigningGroupId = '9degfd10-2704-4af4-ae3e-ac6r4d4bcf0a'

Columns

Name	Type	References	Description
SigningGroupId [KEY]	String		Id of the signing group.
GroupName	String		The name of the group. The search_text provided in the call automatically performs a wild card search on group_name.
GroupType	String		The group type.
GroupEmail	String		Email of the group.
Created	String		The UTC DateTime when the workspace user authorization was created.
CreatedBy	String		Creator of the group.
Modified	Datetime		The UTC DateTime when the workspace user authorization was modified.
ModifiedBy	String		Modifier of the group.

The SigningGroupUsers resource provides methods that allow you to manage users in Signing Groups.

View Specific Information

In order to make a successful request on this view, you have to specify SigningGroupId.

For example:

SELECT * FROM SigningGroupUsers WHERE SigningGroupId = '6071932'

Columns

Name	Type	References	Description
SigningGroupId [KEY]	String	SigningGroups.SigningGroupId	Id of the signing group.
UserName	String		The name of the group member.
Email [KEY]	String		The email of the group member.

The Template resource provides methods that allow you to manage templates.

The Sync App will use the DocuSign API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the Sync App.

• TemplateId supports the '='.
• FolderId supports the '=' and 'IN'. In order to filter by FolderId, showCustomFiled property must be set to false.

For example, the following queries are processed server side:

SELECT * FROM Templates WHERE TemplateId = '5fe47399-31e9-4ddc-bbd1-5200760e4658'
SELECT * FROM Templates WHERE FolderId = '7137682d-f33c-4425-96a2-d556389df80f'
SELECT * FROM Templates WHERE FolderId IN ('7137682d-f33c-4425-96a2-d556389df80f', 'ff7cc98e-4502-4009-93ce-8d3ad96485a6')

Columns

Name	Type	References	Description
TemplateId [KEY]	String		Id of the template.
Name	String		Name of the template.
Password	String		Password of the template.
Description	String		Description of the template.
Shared	String		When set to true, this template is shared.
Created	Datetime		The date and time the item was created.
LastModified	Datetime		The date and time the item was last modified.
PageCount	String		Number of pages.
Uri	String		Contains a URI to retrieve the templates.
FolderName	String		Name of the template folder.
FolderId	String	Folders.FolderId	Id of the folder.
FolderUri	String		Uri of the folder.
OwnerUserName	String		Name of the user.
OwnerEmail	String		Email of the user.
OwnerUserId	String		Id of the user.
EmailBlurb	String		Blurb of the email
EmailSubject	String		Subject of the email.
AllowReassign	String		When set to true, the recipient can redirect an envelope to a more appropriate recipient.
AuthoritativeCopy	String		Specifies whether all documents in this template are authoritative copies. A document can set its own authoritativeCopy property to override this value.
EnableWetSign	String		When set to true, the signer is allowed to print the document and sign it on paper.
EnforceSignerVisibility	String		When set to true, documents with tabs can only be viewed by signers that have a tab on that document.
ItemURL	String		Contains a ItemUrl to retrieve the templates.
FolderIds	String		A comma-separated list of folder ID GUIDs.

The UserInfo resource provides methods that allow you to manage your current user info.

Columns

Name	Type	References	Description
AccountId [KEY]	String		The ID of the account.
AccountName	String		The name associated with this account.
Url	String		The base URI that is used for making API calls on behalf of this account.
IsDefault	Boolean		If true, this account is the account holder's default account.

The Users resource provides methods that allow you to manage users for an account.

View Specific Information

The Sync App will use the DocuSign API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the Sync App.

• Users supports the '='.
• UserStatus supports the '='.

For example, the following queries are processed server side:

SELECT * FROM Users WHERE UserId = '9degfd10-2704-4af4-ae3e-ac6r4d4bcf0a'
SELECT * FROM Users WHERE UserStatus = 'Active'

Columns

Name	Type	References	Description
UserId [KEY]	String		The user ID of the user being accessed.
UserName	String		The user's full name.
UserStatus	String		Status of the user's account. One of: ActivationRequired, ActivationSent, Active, Closed, Disabled.
UserType	String		The user type.
IsAdmin	Boolean		Determines if the feature set is actively set as part of the plan.
Email	String		The user's email address.
Uri	String		Uri of the user.
PermissionProfileId	Integer		User's permission profile id.
permissionProfileName	String		User's permission profile name.
JobTitle	String		Title of the job.
Title	String		Salutation for the user, such as Ms, Dr, Capt., etc.
CreatedDateTime	Datetime		Indicates the date and time the item was created.
LastLogin	Datetime		The date-time when the user last logged on to the system.
Company	String		The name of the user's company.
FirstName	String		The user's first name
IsAlternateAdmin	String		When true, the user is an alternate administrator. This user is not an administrator but will be set as such if all administrator memberships are closed.
LastName	String		The user's last name.
MiddleName	String		The user's middle name.

The UserSignatures resource provides methods that allow you manage the intials and signature images for a user.

View Specific Information

In order to make a successful request on this view, you have to specify UserId.

For example:

SELECT * FROM UserSignatures WHERE UserId = '9de4ad10-2704-4af7-ae3e-acf27a4bcf0a'

The Sync App will use the DocuSign API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the Sync App.

• UserId supports the '='.
• UserSignatures supports the '='.

For example, the following queries are processed server side:

SELECT * FROM UserSignatures WHERE UserId = '6de49590-65cf-41d4-ac62-399bd97dc1b3'
SELECT * FROM UserSignatures WHERE SignatureId = '956359'

Columns

Name	Type	References	Description
UserId	String	Users.UserId	The user ID of the user being accessed.
SignatureId [KEY]	String		Specifies the signature ID associated with the signature name.
SignatureImageUri	String		Contains the URI for an endpoint that you can use to retrieve the signature image.
InitialsImageUri	String		Contains the URI for an endpoint that you can use to retrieve the initials image.
SignatureInitials	String		The initials associated with the signature.
UserSignatureName	String		Specifies the user signature name.
SignatureType	String		Type of the signature.
CreatedDateTime	Datetime		Indicates the date and time the item was created.
AdoptedDateTime	Datetime		The date and time the user adopted their signature.
IsDefault	Boolean		Specifies if the signature is default or not.
DisallowUserResizeStamp	String		When true, users may not resize the stamp.
Initials150ImageId	String		The ID of the user's initials image.
NrdsId	String		The National Association of Realtors (NAR) membership ID for a user who is a realtor.
NrdsLastName	String		The realtor's last name.
NrdsStatus	String		The realtor's NAR membership status.
PhoneticName	String		The phonetic spelling of the signatureName.
Signature150ImageId	String		The ID of the user's signature image.
SignatureFont	String		The font type for the signature, if the signature is not drawn. The supported font types are:7_DocuSign,1_DocuSign, 6_DocuSign, 8_DocuSign, 3_DocuSign, Mistral, 4_DocuSign, 2_DocuSign, 5_DocuSign, Rage Italic
SignatureRights	String		The rights that the user has to the signature. Valid values are: none, read and admin.
StampFormat	String		The format of a stamp.
StampImageUri	String		The URI for retrieving the image of the user's stamp.
StampSizeMM	String		The physical height of the stamp image (in millimeters) that the stamp vendor recommends for displaying the image in PDF documents.
StampType	String		The type of stamp.
Status	String		Indicates the envelope status.

The Workspaces resource provides methods that allow you to manage workspaces.

View Specific Information

The Sync App will use the DocuSign API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the Sync App.

• Workspaces supports the '='.

For example, the following queries are processed server side:

SELECT * FROM Workspaces WHERE WorkspaceId = '9degfd10-2704-4af4-ae3e-ac6r4d4bcf0a'

Columns

Name	Type	References	Description
WorkspaceId [KEY]	String		The id of the workspace, always populated.
WorkspaceName	String		The name of the workspace.
WorkspaceUri	String		The relative URI that may be used to access the workspace.
WorkspaceBaseUrl	String		The relative URL that may be used to access the workspace.
Created	Datetime		The UTC DateTime when the workspace user authorization was created.
LastModified	Datetime		Utc date and time the comment was last updated (can only be done by creator.)
Status	String		Workspace status.

The connection string properties are the various options that can be used to establish a connection. This section provides a complete list of the options you can configure in the connection string for this provider. Click the links for further details.

For more information on establishing a connection, see Establishing a Connection.

Authentication

---

Property	Description
AuthScheme	The type of authentication to use when connecting to DocuSign.

OAuth

---

Property	Description
OAuthClientId	Specifies the client Id that was assigned the custom OAuth application was created. (Also known as the consumer key.) This ID registers the custom application with the OAuth authorization server.
OAuthClientSecret	Specifies the client secret that was assigned when the custom OAuth application was created. (Also known as the consumer secret ). This secret registers the custom application with the OAuth authorization server.

JWT OAuth

---

Property	Description
OAuthJWTCert	The JWT Certificate store.
OAuthJWTCertType	The type of key store containing the JWT Certificate.
OAuthJWTCertPassword	The password for the OAuth JWT certificate used to access a certificate store that requires a password. If the certificate store does not require a password, leave this property blank.
OAuthJWTCertSubject	The subject of the OAuth JWT certificate used to locate a matching certificate in the store. Supports partial matches and the wildcard '*' to select the first certificate.
OAuthJWTIssuer	The issuer of the Java Web Token.
OAuthJWTSubject	The user subject for which the application is requesting delegated access.

SSL

---

Property	Description
SSLServerCert	Specifies the certificate to be accepted from the server when connecting using TLS/SSL.

Firewall

---

Property	Description
FirewallType	Specifies the protocol the provider uses to tunnel traffic through a proxy-based firewall.
FirewallServer	Identifies the IP address, DNS name, or host name of a proxy used to traverse a firewall and relay user queries to network resources.
FirewallPort	Specifies the TCP port to be used for a proxy-based firewall.
FirewallUser	Identifies the user ID of the account authenticating to a proxy-based firewall.
FirewallPassword	Specifies the password of the user account authenticating to a proxy-based firewall.

Proxy

---

Property	Description
ProxyAutoDetect	Specifies whether the provider checks your system proxy settings for existing proxy server configurations, rather than using a manually specified proxy server.
ProxyServer	The hostname or IP address of the proxy server that you want to route HTTP traffic through.
ProxyPort	The TCP port on your specified proxy server (set in the ProxyServer connection property) that has been reserved for routing HTTP traffic to and from the client.
ProxyAuthScheme	Specifies the authentication method the provider uses when authenticating to the proxy server specified in the ProxyServer connection property.
ProxyUser	The username of a user account registered with the proxy server specified in the ProxyServer connection property.
ProxyPassword	The password associated with the user specified in the ProxyUser connection property.
ProxySSLType	The SSL type to use when connecting to the proxy server specified in the ProxyServer connection property.
ProxyExceptions	A semicolon separated list of destination hostnames or IPs that are exempt from connecting through the proxy server set in the ProxyServer connection property.

Logging

---

Property	Description
LogModules	Specifies the core modules to include in the log file. Use a semicolon-separated list of module names. By default, all modules are logged.

Schema

---

Property	Description
Location	Specifies the location of a directory containing schema files that define tables, views, and stored procedures. Depending on your service's requirements, this may be expressed as either an absolute path or a relative path.
BrowsableSchemas	Optional setting that restricts the schemas reported to a subset of all available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC .
Tables	Optional setting that restricts the tables reported to a subset of all available tables. For example, Tables=TableA,TableB,TableC .
Views	Optional setting that restricts the views reported to a subset of the available tables. For example, Views=ViewA,ViewB,ViewC .

Miscellaneous

---

Property	Description
AccountId	AccountId of the currently authenticated user.
DirectoryRetrievalDepth	The depth to scan for available folders.
FolderType	FolderType of the folders for currently authenticated user. This property is only specific to Folders table.
IncludeCustomFields	Set to true if you want to retrieve custom fields values for an envelope or template.
MaxRows	Specifies the maximum rows returned for queries without aggregation or GROUP BY.
Other	Specifies additional hidden properties for specific use cases. These are not required for typical provider functionality. Use a semicolon-separated list to define multiple properties.
PseudoColumns	Specifies the pseudocolumns to expose as table columns. Use the format 'TableName=ColumnName;TableName=ColumnName'. The default is an empty string, which disables this property.
Timeout	Specifies the maximum time, in seconds, that the provider waits for a server response before throwing a timeout error. The default is 60 seconds. Set to 0 to disable the timeout.
URL	Base API url associated with your account.
UserDefinedViews	Specifies a filepath to a JSON configuration file defining custom views. The provider automatically detects and uses the views specified in this file.
UseSandbox	Set to true if you you are using sandbox account.

This section provides a complete list of the Authentication properties you can configure in the connection string for this provider.

---

Property	Description
AuthScheme	The type of authentication to use when connecting to DocuSign.

The type of authentication to use when connecting to DocuSign.

Remarks

• OAuth: Set this to perform OAuth authentication.
• OAuthJWT: Set this to perform OAuthJWT authentication.

This section provides a complete list of the OAuth properties you can configure in the connection string for this provider.

---

Property	Description
OAuthClientId	Specifies the client Id that was assigned the custom OAuth application was created. (Also known as the consumer key.) This ID registers the custom application with the OAuth authorization server.
OAuthClientSecret	Specifies the client secret that was assigned when the custom OAuth application was created. (Also known as the consumer secret ). This secret registers the custom application with the OAuth authorization server.

Specifies the client Id that was assigned the custom OAuth application was created. (Also known as the consumer key.) This ID registers the custom application with the OAuth authorization server.

Remarks

OAuthClientId is one of a handful of connection parameters that need to be set before users can authenticate via OAuth. For details, see Establishing a Connection.

Specifies the client secret that was assigned when the custom OAuth application was created. (Also known as the consumer secret ). This secret registers the custom application with the OAuth authorization server.

Remarks

OAuthClientSecret is one of a handful of connection parameters that need to be set before users can authenticate via OAuth. For details, see Establishing a Connection.

This section provides a complete list of the JWT OAuth properties you can configure in the connection string for this provider.

---

Property	Description
OAuthJWTCert	The JWT Certificate store.
OAuthJWTCertType	The type of key store containing the JWT Certificate.
OAuthJWTCertPassword	The password for the OAuth JWT certificate used to access a certificate store that requires a password. If the certificate store does not require a password, leave this property blank.
OAuthJWTCertSubject	The subject of the OAuth JWT certificate used to locate a matching certificate in the store. Supports partial matches and the wildcard '*' to select the first certificate.
OAuthJWTIssuer	The issuer of the Java Web Token.
OAuthJWTSubject	The user subject for which the application is requesting delegated access.

The JWT Certificate store.

Remarks

The name of the certificate store for the client certificate.

The OAuthJWTCertType field specifies the type of the certificate store specified by OAuthJWTCert. If the store is password protected, specify the password in OAuthJWTCertPassword.

OAuthJWTCert is used in conjunction with the OAuthJWTCertSubject field in order to specify client certificates. If OAuthJWTCert has a value, and OAuthJWTCertSubject is set, a search for a certificate is initiated. Please refer to the OAuthJWTCertSubject field for details.

Designations of certificate stores are platform-dependent.

The following are designations of the most common User and Machine certificate stores in Windows:

MY	A certificate store holding personal certificates with their associated private keys.
CA	Certifying authority certificates.
ROOT	Root certificates.
SPC	Software publisher certificates.

In Java, the certificate store normally is a file containing certificates and optional private keys.

When the certificate store type is PFXFile, this property must be set to the name of the file. When the type is PFXBlob, the property must be set to the binary contents of a PFX file (i.e. PKCS12 certificate store).

The type of key store containing the JWT Certificate.

Remarks

This property can take one of the following values:

USER	For Windows, this specifies that the certificate store is a certificate store owned by the current user. Note: This store type is not available in Java.
MACHINE	For Windows, this specifies that the certificate store is a machine store. Note: this store type is not available in Java.
PFXFILE	The certificate store is the name of a PFX (PKCS12) file containing certificates.
PFXBLOB	The certificate store is a string (base-64-encoded) representing a certificate store in PFX (PKCS12) format.
JKSFILE	The certificate store is the name of a Java key store (JKS) file containing certificates. Note: this store type is only available in Java.
JKSBLOB	The certificate store is a string (base-64-encoded) representing a certificate store in Java key store (JKS) format. Note: this store type is only available in Java.
PEMKEY_FILE	The certificate store is the name of a PEM-encoded file that contains a private key and an optional certificate.
PEMKEY_BLOB	The certificate store is a string (base64-encoded) that contains a private key and an optional certificate.
PUBLIC_KEY_FILE	The certificate store is the name of a file that contains a PEM- or DER-encoded public key certificate.
PUBLIC_KEY_BLOB	The certificate store is a string (base-64-encoded) that contains a PEM- or DER-encoded public key certificate.
SSHPUBLIC_KEY_FILE	The certificate store is the name of a file that contains an SSH-style public key.
SSHPUBLIC_KEY_BLOB	The certificate store is a string (base-64-encoded) that contains an SSH-style public key.
P7BFILE	The certificate store is the name of a PKCS7 file containing certificates.
PPKFILE	The certificate store is the name of a file that contains a PPK (PuTTY Private Key).
XMLFILE	The certificate store is the name of a file that contains a certificate in XML format.
XMLBLOB	The certificate store is a string that contains a certificate in XML format.
BCFKSFILE	The certificate store is the name of a file that contains an Bouncy Castle keystore.
BCFKSBLOB	The certificate store is a string (base-64-encoded) that contains a Bouncy Castle keystore.

The password for the OAuth JWT certificate used to access a certificate store that requires a password. If the certificate store does not require a password, leave this property blank.

Remarks

This property specifies the password needed to open the certificate store, but only if the store type requires one. To determine if a password is necessary, refer to the documentation or configuration for your specific certificate store.

The subject of the OAuth JWT certificate used to locate a matching certificate in the store. Supports partial matches and the wildcard '*' to select the first certificate.

Remarks

The value of this property is used to locate a matching certificate in the store. The search process works as follows:

• If an exact match for the subject is found, the corresponding certificate is selected.
• If no exact match is found, the store is searched for certificates whose subjects contain the property value.
• If no match is found, no certificate is selected.

You can set the value to '*' to automatically select the first certificate in the store. The certificate subject is a comma-separated list of distinguished name fields and values. For example: CN=www.server.com, OU=test, C=US, [email protected]. Common fields include:

Field	Meaning
CN	Common Name. This is commonly a host name like www.server.com.
O	Organization
OU	Organizational Unit
L	Locality
S	State
C	Country
E	Email Address

If a field value contains a comma, enclose it in quotes. For example: "O=ACME, Inc.".

The issuer of the Java Web Token.

Remarks

The issuer of the Java Web Token. This is typically either the Client Id or Email Address of the OAuth Application.

The user subject for which the application is requesting delegated access.

Remarks

The user subject for which the application is requesting delegated access. Typically, the user account name or email address.

This section provides a complete list of the SSL properties you can configure in the connection string for this provider.

---

Property	Description
SSLServerCert	Specifies the certificate to be accepted from the server when connecting using TLS/SSL.

Specifies the certificate to be accepted from the server when connecting using TLS/SSL.

Remarks

If using a TLS/SSL connection, this property can be used to specify the TLS/SSL certificate to be accepted from the server. Any other certificate that is not trusted by the machine is rejected.

This property can take the following forms:

Description	Example
A full PEM Certificate (example shortened for brevity)	-----BEGIN CERTIFICATE----- MIIChTCCAe4CAQAwDQYJKoZIhv......Qw== -----END CERTIFICATE-----
A path to a local file containing the certificate	C:\cert.cer
The public key (example shortened for brevity)	-----BEGIN RSA PUBLIC KEY----- MIGfMA0GCSq......AQAB -----END RSA PUBLIC KEY-----
The MD5 Thumbprint (hex values can also be either space or colon separated)	ecadbdda5a1529c58a1e9e09828d70e4
The SHA1 Thumbprint (hex values can also be either space or colon separated)	34a929226ae0819f2ec14b4a3d904f801cbb150d

If not specified, any certificate trusted by the machine is accepted.

Use '*' to signify to accept all certificates. Note that this is not recommended due to security concerns.

This section provides a complete list of the Firewall properties you can configure in the connection string for this provider.

---

Property	Description
FirewallType	Specifies the protocol the provider uses to tunnel traffic through a proxy-based firewall.
FirewallServer	Identifies the IP address, DNS name, or host name of a proxy used to traverse a firewall and relay user queries to network resources.
FirewallPort	Specifies the TCP port to be used for a proxy-based firewall.
FirewallUser	Identifies the user ID of the account authenticating to a proxy-based firewall.
FirewallPassword	Specifies the password of the user account authenticating to a proxy-based firewall.

Specifies the protocol the provider uses to tunnel traffic through a proxy-based firewall.

Remarks

A proxy-based firewall (or proxy firewall) is a network security device that acts as an intermediary between user requests and the resources they access. The proxy accepts the request of an authenticated user, tunnels through the firewall, and transmits the request to the appropriate server.

Because the proxy evaluates and transfers data backets on behalf of the requesting users, the users never connect directly with the servers, only with the proxy.

Note: By default, the Sync App connects to the system proxy. To disable this behavior and connect to one of the following proxy types, set ProxyAutoDetect to false.

The following table provides port number information for each of the supported protocols.

Protocol	Default Port	Description
TUNNEL	80	The port where the Sync App opens a connection to DocuSign. Traffic flows back and forth via the proxy at this location.
SOCKS4	1080	The port where the Sync App opens a connection to DocuSign. SOCKS 4 then passes theFirewallUser value to the proxy, which determines whether the connection request should be granted.
SOCKS5	1080	The port where the Sync App sends data to DocuSign. If the SOCKS 5 proxy requires authentication, set FirewallUser and FirewallPassword to credentials the proxy recognizes.

To connect to HTTP proxies, use ProxyServer and ProxyPort. To authenticate to HTTP proxies, use ProxyAuthScheme, ProxyUser, and ProxyPassword.

Identifies the IP address, DNS name, or host name of a proxy used to traverse a firewall and relay user queries to network resources.

Remarks

A proxy-based firewall (or proxy firewall) is a network security device that acts as an intermediary between user requests and the resources they access. The proxy accepts the request of an authenticated user, tunnels through the firewall, and transmits the request to the appropriate server.

Because the proxy evaluates and transfers data backets on behalf of the requesting users, the users never connect directly with the servers, only with the proxy.

Specifies the TCP port to be used for a proxy-based firewall.

Remarks

A proxy-based firewall (or proxy firewall) is a network security device that acts as an intermediary between user requests and the resources they access. The proxy accepts the request of an authenticated user, tunnels through the firewall, and transmits the request to the appropriate server.

Because the proxy evaluates and transfers data backets on behalf of the requesting users, the users never connect directly with the servers, only with the proxy.

Identifies the user ID of the account authenticating to a proxy-based firewall.

Remarks

A proxy-based firewall (or proxy firewall) is a network security device that acts as an intermediary between user requests and the resources they access. The proxy accepts the request of an authenticated user, tunnels through the firewall, and transmits the request to the appropriate server.

Because the proxy evaluates and transfers data backets on behalf of the requesting users, the users never connect directly with the servers, only with the proxy.

Specifies the password of the user account authenticating to a proxy-based firewall.

Remarks

A proxy-based firewall (or proxy firewall) is a network security device that acts as an intermediary between user requests and the resources they access. The proxy accepts the request of an authenticated user, tunnels through the firewall, and transmits the request to the appropriate server.

Because the proxy evaluates and transfers data backets on behalf of the requesting users, the users never connect directly with the servers, only with the proxy.

This section provides a complete list of the Proxy properties you can configure in the connection string for this provider.

---

Property	Description
ProxyAutoDetect	Specifies whether the provider checks your system proxy settings for existing proxy server configurations, rather than using a manually specified proxy server.
ProxyServer	The hostname or IP address of the proxy server that you want to route HTTP traffic through.
ProxyPort	The TCP port on your specified proxy server (set in the ProxyServer connection property) that has been reserved for routing HTTP traffic to and from the client.
ProxyAuthScheme	Specifies the authentication method the provider uses when authenticating to the proxy server specified in the ProxyServer connection property.
ProxyUser	The username of a user account registered with the proxy server specified in the ProxyServer connection property.
ProxyPassword	The password associated with the user specified in the ProxyUser connection property.
ProxySSLType	The SSL type to use when connecting to the proxy server specified in the ProxyServer connection property.
ProxyExceptions	A semicolon separated list of destination hostnames or IPs that are exempt from connecting through the proxy server set in the ProxyServer connection property.

Specifies whether the provider checks your system proxy settings for existing proxy server configurations, rather than using a manually specified proxy server.

Remarks

When this connection property is set to True, the Sync App checks your system proxy settings for existing proxy server configurations (no need to manually supply proxy server details).

This connection property takes precedence over other proxy settings. Set to False if you want to manually configure the Sync App to connect to a specific proxy server.

To connect to an HTTP proxy, see ProxyServer. For other proxies, such as SOCKS or tunneling, see FirewallType.

The hostname or IP address of the proxy server that you want to route HTTP traffic through.

Remarks

The Sync App only routes HTTP traffic through the proxy server specified in this connection property when ProxyAutoDetect is set to False. If ProxyAutoDetect is set to True, which is the default, the Sync App instead routes HTTP traffic through the proxy server specified in your system proxy settings.

The TCP port on your specified proxy server (set in the ProxyServer connection property) that has been reserved for routing HTTP traffic to and from the client.

Remarks

The Sync App only routes HTTP traffic through the proxy server port specified in this connection property when ProxyAutoDetect is set to False. If ProxyAutoDetect is set to True, which is the default, the Sync App instead routes HTTP traffic through the proxy server port specified in your system proxy settings.

For other proxy types, see FirewallType.

Specifies the authentication method the provider uses when authenticating to the proxy server specified in the ProxyServer connection property.

Remarks

The authentication type can be one of the following:

• BASIC: The Sync App performs HTTP BASIC authentication.
• DIGEST: The Sync App performs HTTP DIGEST authentication.
• NTLM: The Sync App retrieves an NTLM token.
• NEGOTIATE: The Sync App retrieves an NTLM or Kerberos token based on the applicable protocol for authentication.
• NONE: Set this when the ProxyServer does not require authentication.

For all values other than "NONE", you must also set the ProxyUser and ProxyPassword connection properties.

If you need to use another authentication type, such as SOCKS 5 authentication, see FirewallType.

The username of a user account registered with the proxy server specified in the ProxyServer connection property.

Remarks

The ProxyUser and ProxyPassword connection properties are used to connect and authenticate against the HTTP proxy specified in ProxyServer.

After selecting one of the available authentication types in ProxyAuthScheme, set this property as follows:

ProxyAuthScheme Value	Value to set for ProxyUser
BASIC	The user name of a user registered with the proxy server.
DIGEST	The user name of a user registered with the proxy server.
NEGOTIATE	The username of a Windows user who is a valid user in the domain or trusted domain that the proxy server is part of, in the format user@domain or domain\user.
NTLM	The username of a Windows user who is a valid user in the domain or trusted domain that the proxy server is part of, in the format user@domain or domain\user.
NONE	Do not set the ProxyPassword connection property.

The Sync App only uses this username if ProxyAutoDetect is set to False. If ProxyAutoDetect is set to True, which is the default, the Sync App instead uses the username specified in your system proxy settings.

The password associated with the user specified in the ProxyUser connection property.

Remarks

The ProxyUser and ProxyPassword connection properties are used to connect and authenticate against the HTTP proxy specified in ProxyServer.

After selecting one of the available authentication types in ProxyAuthScheme, set this property as follows:

ProxyAuthScheme Value	Value to set for ProxyPassword
BASIC	The password associated with the proxy server user specified in ProxyUser.
DIGEST	The password associated with the proxy server user specified in ProxyUser.
NEGOTIATE	The password associated with the Windows user account specified in ProxyUser.
NTLM	The password associated with the Windows user account specified in ProxyUser.
NONE	Do not set the ProxyPassword connection property.

For SOCKS 5 authentication or tunneling, see FirewallType.

The Sync App only uses this password if ProxyAutoDetect is set to False. If ProxyAutoDetect is set to True, which is the default, the Sync App instead uses the password specified in your system proxy settings.

The SSL type to use when connecting to the proxy server specified in the ProxyServer connection property.

Remarks

This property determines when to use SSL for the connection to the HTTP proxy specified by ProxyServer. You can set this connection property to the following values :

AUTO	Default setting. If ProxyServer is set to an HTTPS URL, the Sync App uses the TUNNEL option. If ProxyServer is set to an HTTP URL, the component uses the NEVER option.
ALWAYS	The connection is always SSL enabled.
NEVER	The connection is not SSL enabled.
TUNNEL	The connection is made through a tunneling proxy. The proxy server opens a connection to the remote host and traffic flows back and forth through the proxy.

A semicolon separated list of destination hostnames or IPs that are exempt from connecting through the proxy server set in the ProxyServer connection property.

Remarks

The ProxyServer is used for all addresses, except for addresses defined in this property. Use semicolons to separate entries.

Note that the Sync App uses the system proxy settings by default, without further configuration needed. If you want to explicitly configure proxy exceptions for this connection, set ProxyAutoDetect to False.

This section provides a complete list of the Logging properties you can configure in the connection string for this provider.

---

Property	Description
LogModules	Specifies the core modules to include in the log file. Use a semicolon-separated list of module names. By default, all modules are logged.