DocuSign

Docusign Admin API

An API for an organization administrator to manage organizations, accounts and users

Other#openapi

Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.

Overview

An API for an organization administrator to manage organizations, accounts and users

Endpoints 74

IdentityProviders

  • GETReturns the list of identity providers for an organization./v2/organizations/:organizationId/identity_providersReturns the list of identity providers for an organization. Required authentication scopes: identity_provider_read.

ReservedDomains

  • GETReturns the list of reserved domains for the organization./v2/organizations/:organizationId/reserved_domainsReturns the list of reserved domains for the organization. Required authentication scopes: domain_read.

Users

  • POSTUpdates a user's email address./v2/organizations/:organizationId/users/email_addressesUpdates a user's email address. Required authentication scopes: user_write.
  • GETReturns information about the users in an organization./v2/organizations/:organizationId/users?start=0&take=0&end=0&email=string&email_user_name_like=string&status=string&membership_status=string&account_id=3fa85f64-5717-4562-b3fc-2c963f66afa6&organization_reserved_domain_id=3fa85f64-5717-4562-b3fc-2c963f66afa6&last_modified_since=string&include_ds_groups=true&include_license=trueReturns information about the users in an organization. You must include at least one of the following query parameters in the request: account_id: The ID of…

eSignUserManagement

  • GETReturns the list of permission profiles in an account./v2/organizations/:organizationId/accounts/:accountId/permissionsReturns the list of permission profiles in an account. Required authentication scopes: permission_read. Related topics How to create a new active eSignature…
  • GETReturns the list of groups in an account./v2/organizations/:organizationId/accounts/:accountId/groups?start=0&take=0&end=0Returns the list of groups in an account. Required authentication scopes: group_read. Related topics How to create a new active eSignature user
  • POSTUpdates a user's information./v2/organizations/:organizationId/users/profiles?apply_license_override=trueUpdates a user's information. Required authentication scopes: user_write.
  • DELETECloses a user's memberships./v2/organizations/:organizationId/users/:userId/accountsCloses a user's memberships. Required authentication scopes: user_write. This method requires user authentication. It will fail with an application access…
  • POSTCreates a new eSignature user./v2/organizations/:organizationId/usersCreates a new eSignature user and automatically activates the user's account. Required authentication scopes: user_write. Related topics How to create a new…
  • POSTActivates user memberships./v2/organizations/:organizationId/users/:userId/memberships/:membershipIdActivates user memberships. Required authentication scopes: user_write.
  • GETReturns historical information about users with a specific email address. /v2/organizations/:organizationId/users/profile?email=string&include_license=trueReturns historical information about users with a specific email address. Note: The email query parameter is _required_. To get a list of users in an…
  • DELETEDelete user identities for a specified identity provider./v2/organizations/:organizationId/users/:userId/identitiesDeletes all user identities linked to a specified identity provider. The id request body property specifies the identity provider. To get the ID, call…
  • POSTAdds users to an account./v2/organizations/:organizationId/accounts/:accountId/usersAdds users to an account. Required authentication scopes: user_write. Related topics How to create a new active eSignature user

MultiProductUserManagement

  • GETReturns a list of DSGroups./v2.1/organizations/:organizationId/accounts/:accountId/dsgroups?page=0&page_size=0Returns a list of DSGroups. Required authentication scopes: user_read. Related topics How to create a new active user for CLM and eSignature
  • POSTCreates a new DSGroup./v2.1/organizations/:organizationId/accounts/:accountId/dsgroupsCreates a new DSGroup. Required authentication scopes: user_write.
  • GETReturns details about a single DSGroup./v2.1/organizations/:organizationId/accounts/:accountId/dsgroups/:dsGroupIdReturns details about a single DSGroup. Required authentication scopes: user_read.
  • DELETEDeletes a DSGroup./v2.1/organizations/:organizationId/accounts/:accountId/dsgroups/:dsGroupIdDeletes a DSGroup. Required authentication scopes: user_write.
  • GETGets a list of users in a DSGroup./v2.1/organizations/:organizationId/accounts/:accountId/dsgroups/:dsGroupId/users?page=0&page_size=0Gets a list of users in a DSGroup. Required authentication scopes: user_read.
  • POSTAdds a list of users to a DSGroup./v2.1/organizations/:organizationId/accounts/:accountId/dsgroups/:dsGroupId/usersAdds a list of users to a DSGroup. Required authentication scopes: user_write.
  • DELETERemoves a list of users from a DSGroup./v2.1/organizations/:organizationId/accounts/:accountId/dsgroups/:dsGroupId/usersRemoves a list of users from a DSGroup. In the request body, you can specify users by ID or email address. If both parameters are included, the email address…
  • GETGets products associated with the account and the available permission profiles./v2.1/organizations/:organizationId/accounts/:accountId/products/permission_profilesGets products associated with the account and the available permission profiles. Required authentication scopes: user_read. Related topics How to create a new…
  • GETRetrieves a user's product permission profiles by user ID./v2.1/organizations/:organizationId/accounts/:accountId/products/users/:userId/permission_profilesRetrieves a list of a user's permission profiles for each account's product. The user is specified by the ID provided in the userId path parameter. Required…
  • POSTAssigns permission profiles for a user by user ID./v2.1/organizations/:organizationId/accounts/:accountId/products/users/:userId/permission_profilesSets permission profiles for one or more products for a given user. The user is specified by the userId path parameter. Required authentication scopes:…
  • POSTCreates or updates a multi-product user./v2.1/organizations/:organizationId/accounts/:accountId/usersCreates or updates a multi-product (eSignature and CLM) user. When you use this method to create a user, the user's account is automatically activated.…
  • GETRetrieves the DS profile for a user specified by email address./v2.1/organizations/:organizationId/users/dsprofile?email=string&sort=true&include_license=trueGets information about a user specified by the email query parameter. Required authentication scopes: user_read.
  • GETRetrieves the DS profile for a user specified by ID./v2.1/organizations/:organizationId/users/:userId/dsprofile?sort=true&include_license=trueGets information about a user specified by the userId query parameter. Required authentication scopes: user_read. Related topics How to retrieve the user's…
  • DELETERevokes a user's access to one or more products./v2.1/organizations/:organizationId/accounts/:accountId/products/usersRevokes a specified user's access to one or more products. Required authentication scopes: user_write. Related topics How to delete user data from an account…
  • GETRetrieves a user's product permission profiles by email address./v2.1/organizations/:organizationId/accounts/:accountId/products/permission_profiles/users?email=stringRetrieves a list of a user's permission profiles for each account's product. The user is specified by the email address provided in the email query parameter.…
  • POSTAssigns permission profiles for a user by email address./v2.1/organizations/:organizationId/accounts/:accountId/products/permission_profiles/usersSets permission profiles for one or more products for a given user. The user is specified by the email property in the request body. Required authentication…

UserExport

  • GETReturns a list of pending and completed export requests./v2/organizations/:organizationId/exports/user_listReturns a list of pending and completed export requests. Required authentication scopes: user_read.
  • POSTCreates a user list export request./v2/organizations/:organizationId/exports/user_listCreate a user list export request. This method initiates a user list export request. You specify the type of export request as JSON in the body of method,…
  • GETReturns the results for single user list export request./v2/organizations/:organizationId/exports/user_list/:exportIdReturns the results for single user list export request. Given an export ID, this method returns the results of a single user list export request. To get a…
  • DELETEDeletes a single user list export request./v2/organizations/:organizationId/exports/user_list/:exportIdDeletes a single user list export request. Use this method to delete pending or completed user export requests. Required authentication scopes: user_read.

AccountSettingsExport

  • GETReturns a list of pending and completed account settings export request./v2/organizations/:organizationId/exports/account_settingsReturns a list of pending and completed account settings export requests. Required authentication scopes: account_read.
  • POSTCreates a new account settings export request./v2/organizations/:organizationId/exports/account_settingsCreates a new account settings export request. To learn more about exporting account settings, see [Account Settings Export][guide-export] in the Docusign…
  • GETReturns the results for a single account settings export request./v2/organizations/:organizationId/exports/account_settings/:exportIdReturns the results for a single account settings export request. Given an export ID, this method returns the results of an account settings export request.…
  • DELETEDeletes a single account settings export request./v2/organizations/:organizationId/exports/account_settings/:exportIdDeletes a single account settings export request. Any data associated with the request is also deleted. Required authentication scopes: account_read.

UserImport

  • POSTCreates a request to import new users into an account./v2/organizations/:organizationId/imports/bulk_users/addCreates a request to import new users. Your CSV import file is made up of a header row with the column headers and a row of user or account data for each user…
  • POSTBulk updates information for existing users./v2/organizations/:organizationId/imports/bulk_users/updateBulk updates information for existing users. Your CSV import file is made up of a header row with the column headers and a row of user or account data for…
  • POSTCreates a request to close the accounts of existing users./v2/organizations/:organizationId/imports/bulk_users/closeCreates a request to close the accounts of existing users. Given a CSV list of users, close their accounts. Your CSV import file is made up of a header row…
  • POSTCloses external memberships./v2/organizations/:organizationId/imports/bulk_users/close_externalCloses external memberships. External memberships are users who have an email address at a verified domain but do not belong to the organization. Required…
  • GETGets a list of all of the user import requests./v2/organizations/:organizationId/imports/bulk_usersGets a list of all of the user import requests. Required authentication scopes: user_read.
  • GETReturns the details of a single user import request./v2/organizations/:organizationId/imports/bulk_users/:importIdReturns the details of a single user import request. Use this method to check the status of the request by looking at the status property of the response.…
  • DELETEDeletes a specific user import request./v2/organizations/:organizationId/imports/bulk_users/:importIdDeletes a specific import request and its results. To delete a user, see closeBulkUserImportRequest. Required authentication scopes: user_write.
  • GETGiven the ID of a user import request, return the CSV file that was imported./v2/organizations/:organizationId/imports/bulk_users/:importId/results_csvReturns the contents of the CSV file associated with a user import request. The results have an additional column, ProcessingResults, that describes the…

Organization

  • GETReturns a list of organizations that the authenticated user belongs to./v2/organizations?mode=stringReturns a list of organizations that the authenticated user belongs to. Note that the Docusign Admin API only returns JSON, not XML. Required authentication…

AccountSettingsImport

  • GETReturns the details and metadata for Bulk Account Settings Import requests in the organization./v2/organizations/:organizationId/imports/account_settingsReturns the details and metadata for Bulk Account Settings Import requests in the organization. Required authentication scopes: account_read.
  • POSTCreates a new account settings import request./v2/organizations/:organizationId/imports/account_settingsCreates a new account settings import request. The request for this method consists of the contents of a CSV file. You can export your current settings as a…
  • GETReturns the details/metadata for a Bulk Account Settings Import request./v2/organizations/:organizationId/imports/account_settings/:importIdReturns the details/metadata for a Bulk Account Settings Import request. Given an import ID, this method returns the results of an account settings import…
  • DELETEDeletes a Bulk Account Settings Import request./v2/organizations/:organizationId/imports/account_settings/:importIdDeletes a single account settings import request. Any data associated with the request is also deleted. Required authentication scopes: account_write.

SingleAccountUserImport

  • POSTImport request for adding a user to a single account within the organization./v2/organizations/:organizationId/accounts/:accountId/imports/bulk_users/addImport request for adding a user to a single account within the organization. This method lets you upload user information without requiring an AccountId…
  • POSTImport request for updating users for a single account within the organization./v2/organizations/:organizationId/accounts/:accountId/imports/bulk_users/updateImport request for updating users for a single account within the organization. This method lets you upload user information without requiring an AccountId…

DataDeletion

  • POSTDeletes membership data for a user on an account./v2/data_redaction/accounts/:accountId/userDeletes the data for a single account membership for a specified user. To call this endpoint: * You must be an administrator (or delegated administrator) of…
  • POSTDeletes data for one or more of a user's account memberships./v2/data_redaction/organizations/:organizationId/userDeletes data for one or more of a user's account memberships. To call this endpoint: * You must be an organization administrator (or delegated administrator)…

AccountCloning

  • GETGet asset group accounts for an organization./v2/organizations/:organizationId/assetGroups/accounts?compliant=trueReturns a list of asset group accounts for an organization. An asset group is a set of modules, products, plans, and charges purchased for your organization.…
  • POSTClone an existing Docusign account./v2/organizations/:organizationId/assetGroups/accountCloneClones an existing Docusign account. Cloning an account copies the plan items and eSignature settings. Users, templates, and permission profiles are _not_…
  • GETGets all asset group account clones for an organization./v2/organizations/:organizationId/assetGroups/accountClones?since_updated_date=2024-01-01T00:00:00Z&include_details=trueRetrieves all the cloned accounts for an organization. To call this endpoint: * You must be an administrator for the specified organization. Required scopes:…
  • GETGets information about a single cloned account./v2/organizations/:organizationId/assetGroups/:assetGroupId/accountClones/:assetGroupWorkId?include_details=trueGets information about a cloned account by the assetGroupWorkId. To call this endpoint: * You must be an administrator for the specified organization.…

AccountCreation

  • GETGet information about plan items within an organization./v2/organizations/:organizationId/planItemsGets the plan items and subscription information for an organization. To call this endpoint: * You must be an administrator for the specified organization…
  • POSTCreates a new Docusign account using the plan and modules specified in request body./v2/organizations/:organizationId/assetGroups/accountCreateCreates a new Docusign account within an organization. In the request body, specify the subscription and plan IDs for the new account. You can get these IDs…
  • GETGet all ongoing account creation processes for an Organization./v2/organizations/:organizationId/subAccountsCreated?since_updated_date=2024-01-01T00:00:00Z&include_details=trueGet ongoing account creation processes by organizationId. To call this endpoint: * You must be an administrator for the specified organization Required…
  • GETGet a single account creation process./v2/organizations/:organizationId/assetGroup/:assetGroupId/subAccountCreated/:assetGroupWorkId?include_details=trueGets information about an account creation process by the assetGroupId. To call this endpoint: * You must be an administrator for the specified organization…

Connect

  • GETOrganizationConnect_GetOrganizationConnectConfigs/v2/organizations/:organizationId/connect?sortBy=string&siteId=0&accountId=3fa85f64-5717-4562-b3fc-2c963f66afa6&allowEnvelopePublish=true&q=string
  • POSTOrganizationConnect_CreateOrganizationConnectConfig/v2/organizations/:organizationId/connect
  • GETOrganizationConnect_GetOrganizationConnectConfig/v2/organizations/:organizationId/connect/:connectId
  • PUTOrganizationConnect_UpdateOrganizationConnectConfig/v2/organizations/:organizationId/connect/:connectId
  • DELETEOrganizationConnect_DeleteOrganizationConnectConfig/v2/organizations/:organizationId/connect/:connectId
  • GETOrganizationConnectOAuthConfiguration_GetOrganizationConnectOAuthConfiguration/v2/organizations/:organizationId/connect/oauth
  • PUTOrganizationConnectOAuthConfiguration_PutOrganizationConnectOAuthConfiguration/v2/organizations/:organizationId/connect/oauth
  • POSTOrganizationConnectOAuthConfiguration_PostOrganizationConnectOAuthConfiguration/v2/organizations/:organizationId/connect/oauth
  • DELETEOrganizationConnectOAuthConfiguration_DeleteOrganizationConnectOAuthConfiguration/v2/organizations/:organizationId/connect/oauth
  • GETOrganizationConnectHmac_GetConnectHmacSecrets/v2/organizations/:organizationId/connect/secret
  • POSTOrganizationConnectHmac_PostConnectHmacSecret/v2/organizations/:organizationId/connect/secret
  • DELETEOrganizationConnectHmac_DeleteConnectHmacSecret/v2/organizations/:organizationId/connect/secret/:keyId

API details

Base URL
https://api.docusign.net/Management
Authentication
OAuth 2.0 (authorization code flow) with 21 scopes
Operations
74 operations on 53 pathsGET 34POST 26DELETE 12PUT 2
Main resources
MultiProductUserManagement 16Connect 12eSignUserManagement 9UserImport 8AccountCloning 4AccountCreation 4AccountSettingsExport 4AccountSettingsImport 4UserExport 4DataDeletion 2
Response formats
application/json
Description format
Swagger 2.0, API version v2.1

How to test the Docusign Admin API in Swastik Codes

  1. Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
  2. Fork it into your workspaceChoose a workspace. You get your own copy of the Docusign Admin API collection, without the publisher's secrets.
  3. Add your credentialsThis API uses OAuth 2.0 (authorization code flow) with 21 scopes. Add yours in the collection's variables or an environment; the requests already reference it.
  4. Send a requestPick an endpoint, for example “Returns the list of identity providers for an organization.” (GET /v2/organizations/:organizationId/identity_providers), and press Send. Check the response, add tests and run the whole collection with the runner.

Frequently asked questions

What is the Docusign Admin API?

An API for an organization administrator to manage organizations, accounts and users It is listed under Other and has 74 endpoints.

Who publishes the Docusign Admin API?

It is listed from DocuSign's public API description (an OpenAPI document), not published by DocuSign on Swastik Codes. Anyone who controls docusign.com can claim the profile by adding a DNS TXT record.

What is the base URL of the Docusign Admin API?

Requests go to https://api.docusign.net/Management. Endpoint paths are added to this base URL.

How do I authenticate with the Docusign Admin API?

With OAuth 2.0 (authorization code flow) with 21 scopes.

How many endpoints does the Docusign Admin API have?

74 operations on 53 paths (34 GET, 26 POST, 12 DELETE, 2 PUT). The largest groups are MultiProductUserManagement, Connect, eSignUserManagement, UserImport.

Is forking the Docusign Admin API free?

Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.

Suggest an API

Tell us which public API is missing. We check it, then add it here with its endpoints when it has an OpenAPI (Swagger) description.