Cmdlets for DocuSign

Build 24.0.9060

Establishing a Connection

With the CData Cmdlets users can install a data module, set the connection properties, and start scripting. This section provides examples of using our DocuSign Cmdlets with native PowerShell cmdlets, like the CSV import and export cmdlets.

Installing and Connecting

If you have PSGet, installing the cmdlets can be accomplished from the PowerShell Gallery with the following command. You can also obtain a setup from the CData site. 

Install-Module DocuSignCmdlets

The following line is then added to your profile, loading the cmdlets on the next session: 

Import-Module DocuSignCmdlets;

You can then use the Connect-DocuSign cmdlet to create a connection object that can be passed to other cmdlets: 

$conn = Connect-DocuSign -OAuthClientId "MyClientId" -OAuthClientSecret "MyClientSecret" -CallbackURL "http://localhost:33333"

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

Desktop Applications

Follow the steps below to authenticate with the credentials for a custom OAuth app. See Creating a Custom OAuth App.

Get and Refresh the OAuth Access Token

After setting the following, you are ready to connect:

  • OAuthClientId: Set this to the Integrator Key assigned when you registered your app.
  • OAuthClientSecret: Set this to the Secret Key assigned when you registered your app.
  • CallbackURL: Set this to the redirect URI defined when you registered your app.
When you connect the cmdlet opens the OAuth endpoint in your default browser. Log in and grant permissions to the application.

Headless Machines

To configure the driver to use OAuth with a user account on a headless machine, you need to authenticate on another device that has an internet browser.

  1. Choose one of these two options:

    • Option 1: Obtain the OAuthVerifier value as described in "Obtain and Exchange a Verifier Code" below.
    • Option 2: Install the cmdlet on another machine and transfer the OAuth authentication values after you authenticate through the usual browser-based flow, as described in "Transfer OAuth Settings" below.

  2. Then configure the cmdlet to automatically refresh the access token from the headless machine.

Option 1: Obtain and Exchange a Verifier Code

To obtain a verifier code, you must authenticate at the OAuth authorization URL.

Follow the steps below to authenticate from the machine with an internet browser and obtain the OAuthVerifier connection property.

  1. Choose one of these options:

    • If you are using the Embedded OAuth Application click DocuSign OAuth endpoint to open the endpoint in your browser.
    • If you are using a custom OAuth application, create the Authorization URL by setting the following properties:
      • InitiateOAuth: Set to OFF.
      • OAuthClientId: Set to the client Id assigned when you registered your application.
      • OAuthClientSecret: Set to the client secret assigned when you registered your application.
      Then call the GetOAuthAuthorizationURL stored procedure with the appropriate CallbackURL. Open the URL returned by the stored procedure in a browser.

  2. Log in and grant permissions to the cmdlet. You are then redirected to the callback URL, which contains the verifier code.
  3. Save the value of the verifier code. Later you will set this in the OAuthVerifier connection property.
Next, you need to exchange the OAuth verifier code for OAuth refresh and access tokens. Set the following properties:

On the headless machine, set the following connection properties to obtain the OAuth authentication values:

  • InitiateOAuth: Set this to REFRESH.
  • OAuthVerifier: Set this to the verifier code.
  • OAuthClientId: Set this to the client Id in your custom OAuth application settings.
  • OAuthClientSecret: Set this to the client secret in the custom OAuth application settings.
  • OAuthSettingsLocation: Set this to the location of the file where the driver saves the OAuth token values that persist across connections.

After the OAuth settings file is generated, you need to re-set the following properties to connect:

  • InitiateOAuth: Set this to REFRESH.
  • OAuthClientId: Set this to the client Id assigned when you registered your application.
  • OAuthClientSecret: Set this to the client secret assigned when you registered your application.
  • OAuthSettingsLocation: Set this to the location containing the encrypted OAuth authentication values. Make sure this location grants read and write permissions to the cmdlet to enable the automatic refreshing of the access token.

Option 2: Transfer OAuth Settings

Prior to connecting on a headless machine, you need to create and install a connection with the driver on a device that supports an internet browser. Set the connection properties as described in "Desktop Applications" above.

After completing the instructions in "Desktop Applications", the resulting authentication values are encrypted and written to the location specified by OAuthSettingsLocation. The default filename is OAuthSettings.txt.

Once you have successfully tested the connection, copy the OAuth settings file to your headless machine.

On the headless machine, set the following connection properties to connect to data:

  • InitiateOAuth: Set this to REFRESH.
  • OAuthClientId: Set this to the client Id assigned when you registered your application.
  • OAuthClientSecret: Set this to the client secret assigned when you registered your application.
  • OAuthSettingsLocation: Set this to the location of your OAuth settings file. Make sure this location gives read and write permissions to the cmdlet to enable the automatic refreshing of the access token.

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 cmdlet:
  • OAuthJWTCert: The location of your private key. This should end with ".key".
  • OAuthJWTCertType: PEMKEY_FILE
  • OAuthJWTSubject: Your user ID.
  • OAuthJWTIssuer: Your integration key.

Retrieving Data

The Select-DocuSign cmdlet provides a native PowerShell interface for retrieving data: 

$results = Select-DocuSign -Connection $conn -Table "Account" -Columns @("Id, Name") -Where "Industry='Floppy Disks'"
The Invoke-DocuSign cmdlet provides an SQL interface. This cmdlet can be used to execute an SQL query via the Query parameter.

Piping Cmdlet Output

The cmdlets return row objects to the pipeline one row at a time. The following line exports results to a CSV file: 

Select-DocuSign -Connection $conn -Table Account -Where "Industry = 'Floppy Disks'" | Select -Property * -ExcludeProperty Connection,Table,Columns | Export-Csv -Path c:\myAccountData.csv -NoTypeInformation

You will notice that we piped the results from Select-DocuSign into a Select-Object cmdlet and excluded some properties before piping them into an Export-CSV cmdlet. We do this because the CData Cmdlets append Connection, Table, and Columns information onto each row object in the result set, and we do not necessarily want that information in our CSV file.

However, this makes it easy to pipe the output of one cmdlet to another. The following is an example of converting a result set to JSON: 

 
PS C:\> $conn  = Connect-DocuSign -OAuthClientId "MyClientId" -OAuthClientSecret "MyClientSecret" -CallbackURL "http://localhost:33333"
PS C:\> $row = Select-DocuSign -Connection $conn -Table "Account" -Columns (Id, Name) -Where "Industry = 'Floppy Disks'" | select -first 1
PS C:\> $row | ConvertTo-Json
{
  "Connection":  {

  },
  "Table":  "Account",
  "Columns":  [

  ],
  "Id":  "MyId",
  "Name":  "MyName"
}

Deleting Data

The following line deletes any records that match the criteria: 

Select-DocuSign -Connection $conn -Table Account -Where "Industry = 'Floppy Disks'" | Remove-DocuSign

Modifying Data

The cmdlets make data transformation easy as well as data cleansing. The following example loads data from a CSV file into DocuSign, checking first whether a record already exists and needs to be updated instead of inserted. 

Import-Csv -Path C:\MyAccountUpdates.csv | %{
  $record = Select-DocuSign -Connection $conn -Table Account -Where ("Id = `'"+$_.Id+"`'")
  if($record){
    Update-DocuSign -Connection $conn -Table Account -Columns @("Id","Name") -Values @($_.Id, $_.Name) -Where "Id  = `'$_.Id`'"
  }else{
    Add-DocuSign -Connection $conn -Table Account -Columns @("Id","Name") -Values @($_.Id, $_.Name)
  }
}

Copyright (c) 2024 CData Software, Inc. - All rights reserved.
Build 24.0.9060