Skip to navigation

Authentication

View as Markdown

All calls to the Docusign Admin API are authenticated using an access token that your app obtains using one of the standard OAuth 2.0 grants supported by Docusign :

Note: See Choose an OAuth type for details on when to use each authentication type.

When using the Admin API, you must request a special set of Docusign Admin scopes in addition to your other Docusign eSignature Authentication scopes.

The list of Docusign Admin scopes that you can request and the types of operations that require them are listed below:

ScopeDescription
organization_readGets lists of organizations and organization data
group_readGets lists of groups associated with an account
permission_readGets lists of permission profiles associated with an account
user_readReads user data
user_writeUpdates, creates, or deletes users
account_readGets account data
account_writeUpdates, creates, or deletes account data
domain_readGets data on reserved domains for the organization
identity_provider_readGets data on identity providers for an organization
user_data_redactDeletes personal data for closed user accounts
asset_group_account_readGets a list of organization accounts that indicates which accounts are eligible to be cloned
asset_group_account_clone_writeInitiates an account cloning process
asset_group_account_clone_readGets status and results for an account cloning process
connect_org_config_read_apiReads data for an Organization-Level Connect configuration
connect_org_config_write_apiWrites data for an Organization-Level Connect configuration
connect_org_oauth_read_apiReads data for your Organization-Level Connect configuration OAuth settings
connect_org_oauth_write_apiWrites data for your Organization-Level Connect configuration OAuth settings
connect_org_hmac_read_apiReads a list of the HMAC keys for your organization
connect_org_hmac_write_apiCreates new HMAC keys for your organization

Important: If the required Docusign Admin scopes were not explicitly requested, calls to the Docusign Admin API will fail.

Application access tokens

When obtaining an access token using the JWT Grant, you can choose to create either a user-access token that impersonates an account user or an access token that represents an application, called an application-access token.

Application-access tokens can be used only for Docusign Admin API endpoints. They cannot be used with the eSignature or other Docusign APIs.

Application-access tokens are an alternative to using the JWT Grant to impersonate a user with account admin or organization privileges.

Next steps