The Docusign Admin API enables organizations to automate and programmatically execute administrative tasks for their Docusign accounts. It provides capabilities for managing organizations, accounts, and users, including user provisioning, permission management, and account configuration at scale.
openapi: 3.0.1
info:
title: DocuSign Admin API
description: "An API for an organization administrator to manage organizations, accounts and users"
termsOfService: https://www.docusign.com/company/terms-and-conditions/developers
contact:
name: DocuSign Developer Center
url: https://developers.docusign.com
email: [email protected]
version: v2.1
servers:
- url: https://api.docusign.net/Management
tags:
- name: AccountSettingsExport
description: Methods and objects to get account information.
- name: AccountSettingsImport
description: Methods and objects to update account settings.
- name: eSignUserManagement
description: Methods to manage eSignature users in an account.
- name: IdentityProviders
description: Methods to get a list of identity providers.
- name: MultiProductUserManagement
description: Methods to manage multi-product users in an account.
- name: Organization
description: Methods for working with organizations.
- name: ReservedDomains
description: Methods to get a list of reserved domains.
- name: SingleAccountUserImport
description: Methods to import users.
- name: UserExport
description: Methods for exporting a user list.
- name: UserImport
description: |-
Methods to import users.
To ensure your CSV is properly formatted, use the
[Sample Bulk Add CSV file](https://admin.docusign.com/static-resources/organization-user-import.csv)
as a template.
You can add up to 2,000 users to an account and include up to 50 accounts per import. The maximum number of users per import is 8,000.
- name: Users
description: Methods to manage users in an account.
paths:
/v2/organizations:
get:
tags:
- Organization
summary: Docusign Returns a list of organizations that the authenticated user belongs to.
description: |-
Returns a list of organizations that the authenticated user belongs to.
- Required scopes: `organization_read`.
Note that the DocuSign Admin API only returns JSON, not XML.
operationId: Organization_Organization_GetListV2
parameters:
- name: mode
in: query
description: |-
Specifies how to select the organizations. Valid values:
- `org_admin`: Returns organizations for which the authenticated user is an admin.
- `account_membership`: Returns organizations that contain an account of which the authenticated user is a member
Default value: `org_admin`
schema:
type: string
responses:
"200":
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/OrganizationsResponse'
security:
- accessCode:
- organization_read
x-ds-methodname: getOrganizations
x-ds-method: getOrganizations
x-ds-service: Accounts
x-ds-in-sdk: true
/v2/organizations/{organizationId}/accounts/{accountId}/permissions:
get:
tags:
- eSignUserManagement
summary: Docusign Returns the list of permission profiles in an account.
description: |+
Returns the list of permission profiles in an account.
- Required scopes: `permission_read`
operationId: Account_Accounts_GetPermissionProfilesV2
parameters:
- name: organizationId
in: path
description: The organization ID Guid
required: true
schema:
type: string
format: uuid
- name: accountId
in: path
description: The account ID Guid
required: true
schema:
type: string
format: uuid
responses:
"200":
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/PermissionsResponse'
security:
- accessCode:
- permission_read
x-ds-methodname: getPermissions
x-ds-method: getPermissions
x-ds-service: Accounts
x-ds-in-sdk: true
/v2/organizations/{organizationId}/accounts/{accountId}/groups:
get:
tags:
- eSignUserManagement
summary: Docusign Returns the list of groups in an account.
description: |
Returns the list of groups in an account.
- Required scopes: `group_read`
operationId: Account_Accounts_GetGroupsV2
parameters:
- name: organizationId
in: path
description: The organization ID Guid
required: true
schema:
type: string
format: uuid
- name: accountId
in: path
description: The account ID Guid
required: true
schema:
type: string
format: uuid
- name: start
in: query
description: Index of first item to include in the response. The default value is 0.
schema:
type: integer
format: int32
- name: take
in: query
description: Page size of the response. The default value is 20.
schema:
type: integer
format: int32
- name: end
in: query
description: Index of the last item to include in the response. Ignored if `take` parameter is specified.
schema:
type: integer
format: int32
responses:
"200":
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/MemberGroupsResponse'
security:
- accessCode:
- group_read
x-ds-methodname: getGroups
x-ds-method: getGroups
x-ds-service: Accounts
x-ds-in-sdk: true
/v2/organizations/{organizationId}/exports/user_list:
get:
tags:
- UserExport
summary: Docusign Returns a list of pending and completed export requests.
description: |
Returns a list of pending and completed export requests.
- Required scopes: `user_read`
operationId: OrganizationExport_OrganizationExport_Get
parameters:
- name: organizationId
in: path
description: The organization ID Guid
required: true
schema:
type: string
format: uuid
responses:
"200":
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/OrganizationExportsResponse'
security:
- accessCode:
- user_read
x-ds-methodname: getUserListExports
x-ds-method: getUserListExports
x-ds-service: BulkExports
x-ds-in-sdk: true
post:
tags:
- UserExport
summary: Docusign Creates a user list export request.
description: "Create a user list export request.\n\n- Required scopes: `user_read`\n\nThis method initiates a user list export request. You specify the type of export request as JSON in the body of method, like this:\n\n``` json\n{\n\t\"type\": \"organization_memberships_export\"\n}\n```\n\n\n\n\nThe export request type is one of three values:\n\n| Value | Description |\n| :----------------------------------------- | :------------------------------------------------------------------------------------------------------ |\n| `organization_memberships_export` | Every user in every account in the organization. Users in multiple accounts will appear more than once. |\n| `organization_domain_users_export` | All users of the reserved domains. |\n| `organization_external_memberships_export` | Users whose email address domain is *not* linked to the organization. |\n"
operationId: OrganizationExport_OrganizationExport_Insert
parameters:
- name: organizationId
in: path
description: The organization ID Guid
required: true
schema:
type: string
format: uuid
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/OrganizationExportRequest'
required: true
responses:
"200":
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/OrganizationExportResponse'
security:
- accessCode:
- user_read
x-ds-methodname: createUserListExport
x-ds-method: createUserListExport
x-ds-service: BulkExports
x-ds-in-sdk: true
x-codegen-request-body-name: request
/v2/organizations/{organizationId}/exports/account_settings:
get:
tags:
- AccountSettingsExport
summary: Docusign Returns a list of pending and completed account settings export request.
description: |
Returns a list of pending and completed account settings export request.
- Required scopes: `account_read`
operationId: OrganizationExport_OrganizationExport_GetAccountCompare
parameters:
- name: organizationId
in: path
description: The organization ID Guid
required: true
schema:
type: string
format: uuid
responses:
"200":
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/OrganizationExportsResponse'
security:
- accessCode:
- account_read
x-ds-methodname: getAccountSettingsExports
x-ds-method: getAccountSettingsExports
x-ds-service: BulkExports
x-ds-in-sdk: true
post:
tags:
- AccountSettingsExport
summary: Docusign Creates a new account settings export request.
description: "Creates a new account settings export request.\n\nSpecify the accounts whose settings you are requesting as JSON in the body of method, like this:\n\n``` json\n{\n \"accounts\":\t[\n \t{ \"account_id\": \"9ca037f4-xxxx-xxxx-xxxx-212e57d4f22e\"},\n \t{ \"account_id\": \"624e3e00-xxxx-xxxx-xxxx-43918c520dab\"}\n\n ]\n}\n```\n"
operationId: OrganizationExport_OrganizationExport_AccountCompare
parameters:
- name: organizationId
in: path
description: The organization ID Guid
required: true
schema:
type: string
format: uuid
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/OrganizationAccountsRequest'
required: true
responses:
"200":
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/OrganizationExportResponse'
security:
- accessCode:
- account_read
x-ds-methodname: createAccountSettingsExport
x-ds-method: createAccountSettingsExport
x-ds-service: BulkExports
x-ds-in-sdk: true
x-codegen-request-body-name: request
/v2/organizations/{organizationId}/exports/user_list/{exportId}:
get:
tags:
- UserExport
summary: Docusign Returns the results for single user list export request.
description: |-
Returns the results for single user list export request.
- Required scopes: `user_read`
Given an export id, this method returns the results of a single user list export request.
To get a list of all the export requests, use `getUserListExports`.
Note that the `metadata_url` property of the response from `createUserListExport` is a read-to-use HTTP GET request to get the status.
You can find the actual list of users at `results[n].url` in the response.
operationId: OrganizationExport_OrganizationExport_GetByExportId
parameters:
- name: organizationId
in: path
description: The organization ID Guid
required: true
schema:
type: string
format: uuid
- name: exportId
in: path
description: The export ID GUID for the request.
required: true
schema:
type: string
format: uuid
responses:
"200":
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/OrganizationExportResponse'
security:
- accessCode:
- user_read
x-ds-methodname: getUserListExport
x-ds-method: getUserListExport
x-ds-service: BulkExports
x-ds-in-sdk: true
delete:
tags:
- UserExport
summary: Docusign Deletes a single user list export request.
description: |+
Deletes a single user list export request.
Use this method to delete pending or completed user export requests.
- Required scopes: `user_read`
operationId: OrganizationExport_OrganizationExport_DeleteByExportId
parameters:
- name: organizationId
in: path
description: The organization ID Guid
required: true
schema:
type: string
format: uuid
- name: exportId
in: path
description: The export ID GUID for the request.
required: true
schema:
type: string
format: uuid
responses:
"200":
description: OK
content:
application/json:
schema:
type: object
security:
- accessCode:
- user_read
x-ds-methodname: deleteUserListExport
x-ds-method: deleteUserListExport
x-ds-service: BulkExports
x-ds-in-sdk: true
/v2/organizations/{organizationId}/exports/account_settings/{exportId}:
get:
tags:
- AccountSettingsExport
summary: Docusign Returns the results for a single account settings export request.
description: |
Returns the results for a single account settings export request.
- Required scopes: `account_read`
Given an export id, this method returns the results of an account settings export request.
To get a list of all the export requests, use `getAccountSettingsExports`.
You can find the actual list of settings at `results[n].url` in the response. The settings export is formatted like this:
``` json
{
"accounts": [
{
"account_id": "9ca037f4-xxxx-xxxx-xxxx-212e57d4f22e",
"name": "The Happy Company",
. . .
},
{
"account_id": "624e3e00-xxxx-xxxx-xxxx-43918c520dab",
"name": "LoanCo",
. . .
}
],
"settings": [
. . .
{
"category": "Signing",
"name": "SignerCanSignOnMobile",
"account_values": [
{
"account_id": "9ca037f4-xxxx-xxxx-xxxx-212e57d4f22e",
"value": "true",
"rights": "editable"
},
{
"account_id": "624e3e00-xxxx-xxxx-xxxx-43918c520dab",
"value": "true",
"rights": "editable"
}
]
},
. . .
]
}
```
operationId: OrganizationExport_OrganizationExport_GetAccountSettingsExportByExportId
parameters:
- name: organizationId
in: path
description: The organization ID Guid
required: true
schema:
type: string
format: uuid
- name: exportId
in: path
description: The export ID GUID for the request.
required: true
schema:
type: string
format: uuid
responses:
"200":
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/OrganizationExportResponse'
security:
- accessCode:
- account_read
x-ds-methodname: getAccountSettingsExport
x-ds-method: getAccountSettingsExport
x-ds-service: BulkExports
x-ds-in-sdk: true
delete:
tags:
- AccountSettingsExport
summary: Docusign Deletes a single account settings export request.
description: |+
Deletes a single account settings export request.
Any data associated with the request is also deleted.
- Required scopes: `account_read`
operationId: OrganizationExport_OrganizationExport_DeleteByAccountSettingsExportId
parameters:
- name: organizationId
in: path
description: The organization ID Guid
required: true
schema:
type: string
format: uuid
- name: exportId
in: path
description: The export ID GUID for the request.
required: true
schema:
type: string
format: uuid
responses:
"200":
description: OK
content:
application/json:
schema:
type: object
security:
- accessCode:
- account_read
x-ds-methodname: deleteAccountSettingsExport
x-ds-method: deleteAccountSettingsExport
x-ds-service: BulkExports
x-ds-in-sdk: true
/v2/organizations/{organizationId}/imports/account_settings:
get:
tags:
- AccountSettingsImport
summary: Docusign Returns the details and metadata for Bulk Account Settings Import requests in the organization.
description: |-
Returns the details and metadata for Bulk Account Settings Import requests in the organization.
- Required scopes: `account_read`
operationId: OrganizationImport_OrganizationImportAccountSettings_Get
parameters:
- name: organizationId
in: path
description: The organization ID Guid
required: true
schema:
type: string
format: uuid
responses:
"200":
description: OK
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/OrganizationAccountSettingsImportResponse'
security:
- accessCode:
- account_read
x-ds-methodname: getBulkAccountSettingsImports
x-ds-method: getBulkAccountSettingsImports
x-ds-service: BulkImports
x-ds-in-sdk: true
post:
tags:
- AccountSettingsImport
summary: Docusign Creates a new account settings import request.
description: |-
Creates a new account settings import request.
- Required scopes: `account_write`
operationId: OrganizationImport_OrganizationImportAccountSettings_Post
parameters:
- name: organizationId
in: path
description: The organization ID GUID.
required: true
schema:
type: string
format: uuid
requestBody:
content:
multipart/form-data:
schema:
required:
- file.csv
type: object
properties:
file.csv:
type: string
description: CSV file.
format: binary
required: true
responses:
"200":
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/OrganizationAccountSettingsImportResponse'
security:
- accessCode:
- account_write
x-ds-methodname: addBulkAccountSettingsImport
x-ds-method: addBulkAccountSettingsImport
x-ds-service: BulkImports
x-ds-in-sdk: true
/v2/organizations/{organizationId}/imports/account_settings/{importId}:
get:
tags:
- AccountSettingsImport
summary: Docusign Returns the details/metadata for a Bulk Account Settings Import request.
description: |+
Returns the details/metadata for a Bulk Account Settings Import request.
Required - scopes: `account_read`
Given an import ID, this method returns the results of an account settings import request.
To get a list of all the import requests, use `getAccountSettingsImports`.
operationId: OrganizationImport_OrganizationImportAccountSettings_GetById
parameters:
- name: organizationId
in: path
description: The organization ID Guid
required: true
schema:
type: string
format: uuid
- name: importId
in: path
description: The import ID GUID for the request.
required: true
schema:
type: string
format: uuid
responses:
"200":
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/OrganizationAccountSettingsImportResponse'
security:
- accessCode:
- account_read
x-ds-methodname: getBulkAccountSettingsImport
x-ds-method: getBulkAccountSettingsImport
x-ds-service: BulkImports
x-ds-in-sdk: true
delete:
tags:
- AccountSettingsImport
summary: Docusign Deletes a Bulk Account Settings Import request.
description: |-
Deletes a single account settings import request.
Any data associated with the request is also deleted.
- Required scopes: `account_write`
operationId: OrganizationImport_OrganizationImportAccountSettings_DeleteById
parameters:
- name: organizationId
in: path
description: The organization ID Guid
required: true
schema:
type: string
format: uuid
- name: importId
in: path
description: The import ID GUID for the request.
required: true
schema:
type: string
format: uuid
responses:
"200":
description: OK
content:
application/json:
schema:
type: object
security:
- accessCode:
- account_write
x-ds-methodname: deleteBulkAccountSettingsImport
x-ds-method: deleteBulkAccountSettingsImport
x-ds-service: BulkImports
x-ds-in-sdk: true
/v2/organizations/{organizationId}/imports/bulk_users/add:
post:
tags:
- UserImport
summary: Docusign Creates a request to import new users into an account.
description: |-
Creates a request to import *new* users.
- Required scopes: `user_write`
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 you want to add to an account. Only new users can be imported. Any changes to existing users will be ignored. To make changes to existing users, use `updateBulkUserImports`.
To ensure your CSV is properly formatted, use the
[Sample Bulk Add CSV file](https://admin.docusign.com/static-resources/organization-user-import.csv)
as a template. The following table describes the columns.
| Column | Required | Description |
| :------------------ | :------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| AccountID | yes | The API account ID for the account to which you want you add the user. You can find this id in the Admin area for the account under **API and Keys**. |
| AccountName | | The name of the user's account in your organization. The account name must match the account ID provided. |
| FirstName | yes | The user's first name. |
| LastName | yes | The user's last name. |
| UserEmail | yes | The user's complete email address. |
| PermissionSet | yes | The user's permission set. The PermissionSet value must match an existing permission set for the account. This value is not case sensitive. |
| UserTitle | | The user's job title. |
| CompanyName | | The user's company name. |
| Group | | The user's assigned groups. The Group values must match existing Group names for the account. Additional Group columns can be added to the file to add users to more than one group. You do not need to add users to the Everyone group, since all new users are automatically added to that group. |
| AddressLine1 | | The user's address, first line. |
| AddressLine2 | | The user's address, second line. |
| City | | The user's city name. |
| StateRegionProvince | | The user's regional location. |
| PostalCode | | The user's postal code. |
| Phone | | The user's phone number. |
| Language | | The user's display language for their DocuSign account. Must be one of: <ul><li>Chinese Simplified: <code>zh_CN</code></li><li>Chinese Traditional: <code>zh_TW</code></li><li>Dutch: <code>nl</code></li><li>English: <code>en</code></li><li>French: <code>fr</code></li><li>German: <code>de</code></li><li>Italian: <code>it</code></li><li>Japanese: <code>ja</code></li><li>Korean: <code>ko</code></li><li>Portuguese: <code>pt</code></li><li>Portuguese Brazil: <code>pt_BR</code></li><li>Russian: <code>ru</code></li><li>Spanish: <code>es</code></li></ul> |
| LoginPolicy | | The user's login policy. Valid values include the following: <ul> <li>Column left blank = The user is created with no policy assigned.</li> <li>FedAuthRequired = The user must log in with a
# --- truncated at 32 KB (173 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/docusign/refs/heads/main/openapi/docusign-admin-openapi-original.yml