Reference
DocuSign
Set up DocuSign OAuth for electronic signatures and agreement management
Overview
Section titled “Overview”Connect your users to DocuSign for electronic signature workflows, document management, and agreement automation.
| Property | Value |
|---|---|
| Provider ID | docusign |
| Category | Business |
| PKCE | Supported |
| Token refresh | Automatic |
| Redirect URI | Shown in Developer Portal |
Step 1: Create a DocuSign OAuth App
Section titled “Step 1: Create a DocuSign OAuth App”Open Apps and Keys
Sign in to DocuSign as an administrator and go to Settings > Apps and Keys — or open apps.docusign.com/admin/apps-and-keys directly. For developer accounts, use apps-d.docusign.com/admin/apps-and-keys.
Create a new application
Click ADD APP / INTEGRATION KEY, enter the App Name, and save.
Generate a secret key
Under Authentication, click Add Secret Key and copy the secret immediately — it is only displayed once.
Configure the redirect URI
Under Additional Settings, add a Redirect URI using the Alter callback URL from the Developer Portal. Match the trailing slash exactly — DocuSign requires an exact string match.
Get credentials
Copy the Integration Key (Client ID) shown on the app details page.
Step 2: Add to Alter Vault
Section titled “Step 2: Add to Alter Vault”Open the Developer Portal
Go to portal.alterauth.com and navigate to the application.
Add DocuSign provider
Go to OAuth Providers > Add Provider > DocuSign.
Enter credentials
- Client ID: Paste your DocuSign Integration Key
- Client Secret: Paste your DocuSign Secret Key
Select scopes
Choose the scopes the application needs.
Save
Click Save. The provider is now active.
Available Scopes
Section titled “Available Scopes”| Scope | Description |
|---|---|
signature | Access to DocuSign eSignature API for sending and managing envelopes |
extended | Extended access for longer-lived refresh tokens |
impersonation | Act on behalf of other users in the account |
click.manage | Manage DocuSign Click agreements |
click.send | Send DocuSign Click agreements |
organization_read | Read organization account information |
permission_read | Read permission profiles and settings |
- DocuSign requires separate sandbox and production environments. Use the sandbox (
account-d.docusign.com) for development. - The
signaturescope is required for most eSignature operations. - See the DocuSign OAuth documentation for more details.
Policy-cataloged operations
Section titled “Policy-cataloged operations”Alter policy rules can target these attested operations and families for operation-level and parameter-aware controls.
| Operation ID | Families | Method | Provider path |
|---|---|---|---|
BCCEmailArchive_PostBCCEmailArchive | admin, delete, send | POST | /v2.1/accounts/{accountId}/settings/bcc_email_archives |
BulkSendV2Batch_PutBulkSendBatchAction | send | PUT | /v2.1/accounts/{accountId}/bulk_send_batch/{bulkSendBatchId}/{bulkAction} |
BulkSendV2Batch_PutBulkSendBatchStatus | send | PUT | /v2.1/accounts/{accountId}/bulk_send_batch/{bulkSendBatchId} |
BulkSendV2CRUD_PostBulkSendList | send | POST | /v2.1/accounts/{accountId}/bulk_send_lists |
BulkSendV2CRUD_PutBulkSendList | send | PUT | /v2.1/accounts/{accountId}/bulk_send_lists/{bulkSendListId} |
BulkSendV2Send_PostBulkSendRequest | send | POST | /v2.1/accounts/{accountId}/bulk_send_lists/{bulkSendListId}/send |
BulkSendV2Test_PostBulkSendTestRequest | send | POST | /v2.1/accounts/{accountId}/bulk_send_lists/{bulkSendListId}/test |
EmailSettings_PostEmailSettings | admin, send | POST | /v2.1/accounts/{accountId}/envelopes/{envelopeId}/email_settings |
BillingPayments_PostPayment | payment | POST | /v2.1/accounts/{accountId}/billing_payments |
BillingPlan_PutBillingPlan | payment | PUT | /v2.1/accounts/{accountId}/billing_plan |
BillingPlan_PutDowngradeAccountBillingPlan | payment | PUT | /v2.1/accounts/{accountId}/billing_plan/downgrade |
EnvelopeTransferRules_DeleteEnvelopeTransferRules | delete, payment | DELETE | /v2.1/accounts/{accountId}/envelopes/transfer_rules/{envelopeTransferRuleId} |
EnvelopeTransferRules_PostEnvelopeTransferRules | payment | POST | /v2.1/accounts/{accountId}/envelopes/transfer_rules |
EnvelopeTransferRules_PutEnvelopeTransferRule | payment | PUT | /v2.1/accounts/{accountId}/envelopes/transfer_rules/{envelopeTransferRuleId} |
EnvelopeTransferRules_PutEnvelopeTransferRules | payment | PUT | /v2.1/accounts/{accountId}/envelopes/transfer_rules |
PurchasedEnvelopes_PutPurchasedEnvelopes | payment | PUT | /v2.1/accounts/{accountId}/billing_plan/purchased_envelopes |
AccountCustomFields_DeleteAccountCustomFields | delete | DELETE | /v2.1/accounts/{accountId}/custom_fields/{customFieldId} |
AccountSignatures_DeleteAccountSignature | delete | DELETE | /v2.1/accounts/{accountId}/signatures/{signatureId} |
AccountSignatures_DeleteAccountSignatureImage | delete | DELETE | /v2.1/accounts/{accountId}/signatures/{signatureId}/{imageType} |
Accounts_DeleteAccount | delete | DELETE | /v2.1/accounts/{accountId} |
Attachments_DeleteAttachments | delete | DELETE | /v2.1/accounts/{accountId}/envelopes/{envelopeId}/attachments |
BCCEmailArchive_DeleteBCCEmailArchive | admin, delete | DELETE | /v2.1/accounts/{accountId}/settings/bcc_email_archives/{bccEmailArchiveId} |
BrandLogo_DeleteBrandLogo | delete | DELETE | /v2.1/accounts/{accountId}/brands/{brandId}/logos/{logoType} |
Brand_DeleteBrand | delete | DELETE | /v2.1/accounts/{accountId}/brands/{brandId} |
Brands_DeleteBrands | delete | DELETE | /v2.1/accounts/{accountId}/brands |
Brands_DeleteGroupBrands | admin, delete | DELETE | /v2.1/accounts/{accountId}/groups/{groupId}/brands |
ConnectHMAC_CreateConnectSecret | admin, write | POST | /v2.1/accounts/{accountId}/connect/secret |
Groups_PostGroups | admin, write | POST | /v2.1/accounts/{accountId}/groups |
PermissionProfiles_PostPermissionProfiles | admin, write | POST | /v2.1/accounts/{accountId}/permission_profiles |
PermissionProfiles_PutPermissionProfiles | admin, write | PUT | /v2.1/accounts/{accountId}/permission_profiles/{permissionProfileId} |
Recipients_PostRecipientProofFileResourceToken | admin, write | POST | /v2.1/accounts/{accountId}/envelopes/{envelopeId}/recipients/{recipientId}/identity_proof_token |
AccountCustomFields_PostAccountCustomFields | write | POST | /v2.1/accounts/{accountId}/custom_fields |
BrandResources_PutBrandResources | write | PUT | /v2.1/accounts/{accountId}/brands/{brandId}/resources/{resourceContentType} |
Brands_PostBrands | write | POST | /v2.1/accounts/{accountId}/brands |
ChunkedUploads_PostChunkedUploads | write | POST | /v2.1/accounts/{accountId}/chunked_uploads |
ChunkedUploads_PutChunkedUploadPart | write | PUT | /v2.1/accounts/{accountId}/chunked_uploads/{chunkedUploadId}/{chunkedUploadPartSeq} |
ChunkedUploads_PutChunkedUploads | write | PUT | /v2.1/accounts/{accountId}/chunked_uploads/{chunkedUploadId} |
Connect_PostConnectConfiguration | write | POST | /v2.1/accounts/{accountId}/connect |
ConsumerDisclosure_PutConsumerDisclosure | write | PUT | /v2.1/accounts/{accountId}/consumer_disclosure/{langCode} |
APIRequestLog_GetRequestLog | read | GET | /v2.1/diagnostics/request_logs/{requestLogId} |
BCCEmailArchive_GetBCCEmailArchiveHistoryList | read | GET | /v2.1/accounts/{accountId}/settings/bcc_email_archives/{bccEmailArchiveId} |
BCCEmailArchive_GetBCCEmailArchiveList | read | GET | /v2.1/accounts/{accountId}/settings/bcc_email_archives |
BillingCharges_GetAccountBillingCharges | read | GET | /v2.1/accounts/{accountId}/billing_charges |
BillingInvoices_GetBillingInvoice | read | GET | /v2.1/accounts/{accountId}/billing_invoices/{invoiceId} |
BillingInvoices_GetBillingInvoices | read | GET | /v2.1/accounts/{accountId}/billing_invoices |