{ "swagger": "2.0", "info": { "version": "v2.1", "title": "DocuSign Admin API", "description": "An API for an organization administrator to manage organizations, accounts and users", "contact": { "name": "DocuSign Developer Center", "url": "https://developers.docusign.com", "email": "devcenter@docusign.com" }, "termsOfService": "https://www.docusign.com/company/terms-and-conditions/developers" }, "host": "api.docusign.net", "basePath": "/Management", "schemes": [ "https" ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "paths": { "/v2/organizations": { "get": { "tags": [ "Organization" ], "summary": "Returns a list of organizations that the authenticated user belongs to.", "description": "Returns a list of organizations that the authenticated user belongs to.\n\n- Required scopes: `organization_read`.\n\nNote that the DocuSign Admin API only returns JSON, not XML.", "operationId": "Organization_Organization_GetListV2", "produces": [ "application/json" ], "parameters": [ { "name": "mode", "in": "query", "description": "Specifies how to select the organizations. Valid values:\n\n- `org_admin`: Returns organizations for which the authenticated user is an admin.\n- `account_membership`: Returns organizations that contain an account of which the authenticated user is a member\n\nDefault value: `org_admin`", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/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": "Returns the list of permission profiles in an account.", "description": "Returns the list of permission profiles in an account.\n\n- Required scopes: `permission_read`\n\n", "operationId": "Account_Accounts_GetPermissionProfilesV2", "produces": [ "application/json" ], "parameters": [ { "name": "organizationId", "in": "path", "description": "The organization ID Guid", "required": true, "type": "string", "format": "uuid" }, { "name": "accountId", "in": "path", "description": "The account ID Guid", "required": true, "type": "string", "format": "uuid" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/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": "Returns the list of groups in an account.", "description": "Returns the list of groups in an account.\n\n- Required scopes: `group_read`\n", "operationId": "Account_Accounts_GetGroupsV2", "produces": [ "application/json" ], "parameters": [ { "name": "organizationId", "in": "path", "description": "The organization ID Guid", "required": true, "type": "string", "format": "uuid" }, { "name": "accountId", "in": "path", "description": "The account ID Guid", "required": true, "type": "string", "format": "uuid" }, { "name": "start", "in": "query", "description": "Index of first item to include in the response. The default value is 0.", "required": false, "type": "integer", "format": "int32" }, { "name": "take", "in": "query", "description": "Page size of the response. The default value is 20.", "required": false, "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.", "required": false, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/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": "Returns a list of pending and completed export requests.", "description": "Returns a list of pending and completed export requests.\n\n- Required scopes: `user_read`\n", "operationId": "OrganizationExport_OrganizationExport_Get", "produces": [ "application/json" ], "parameters": [ { "name": "organizationId", "in": "path", "description": "The organization ID Guid", "required": true, "type": "string", "format": "uuid" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/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": "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", "consumes": [ "application/json" ], "produces": [ "application/json" ], "parameters": [ { "name": "organizationId", "in": "path", "description": "The organization ID Guid", "required": true, "type": "string", "format": "uuid" }, { "name": "request", "in": "body", "description": "", "required": true, "schema": { "$ref": "#/definitions/OrganizationExportRequest" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OrganizationExportResponse" } } }, "security": [ { "accessCode": [ "user_read" ] } ], "x-ds-methodname": "createUserListExport", "x-ds-method": "createUserListExport", "x-ds-service": "BulkExports", "x-ds-in-sdk": true } }, "/v2/organizations/{organizationId}/exports/account_settings": { "get": { "tags": [ "AccountSettingsExport" ], "summary": "Returns a list of pending and completed account settings export request.", "description": "Returns a list of pending and completed account settings export request.\n\n- Required scopes: `account_read`\n", "operationId": "OrganizationExport_OrganizationExport_GetAccountCompare", "produces": [ "application/json" ], "parameters": [ { "name": "organizationId", "in": "path", "description": "The organization ID Guid", "required": true, "type": "string", "format": "uuid" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/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": "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", "consumes": [ "application/json" ], "produces": [ "application/json" ], "parameters": [ { "name": "organizationId", "in": "path", "description": "The organization ID Guid", "required": true, "type": "string", "format": "uuid" }, { "name": "request", "in": "body", "description": "", "required": true, "schema": { "$ref": "#/definitions/OrganizationAccountsRequest" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OrganizationExportResponse" } } }, "security": [ { "accessCode": [ "account_read" ] } ], "x-ds-methodname": "createAccountSettingsExport", "x-ds-method": "createAccountSettingsExport", "x-ds-service": "BulkExports", "x-ds-in-sdk": true } }, "/v2/organizations/{organizationId}/exports/user_list/{exportId}": { "get": { "tags": [ "UserExport" ], "summary": "Returns the results for single user list export request.", "description": "Returns the results for single user list export request.\n\n- Required scopes: `user_read`\n\nGiven an export id, this method returns the results of a single user list export request.\nTo get a list of all the export requests, use `getUserListExports`.\n\nNote that the `metadata_url` property of the response from `createUserListExport` is a read-to-use HTTP GET request to get the status.\n\nYou can find the actual list of users at `results[n].url` in the response.", "operationId": "OrganizationExport_OrganizationExport_GetByExportId", "produces": [ "application/json" ], "parameters": [ { "name": "organizationId", "in": "path", "description": "The organization ID Guid", "required": true, "type": "string", "format": "uuid" }, { "name": "exportId", "in": "path", "description": "The export ID GUID for the request.", "required": true, "type": "string", "format": "uuid" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/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": "Deletes a single user list export request.", "description": "Deletes a single user list export request.\nUse this method to delete pending or completed user export requests.\n\n- Required scopes: `user_read`\n\n", "operationId": "OrganizationExport_OrganizationExport_DeleteByExportId", "produces": [ "application/json" ], "parameters": [ { "name": "organizationId", "in": "path", "description": "The organization ID Guid", "required": true, "type": "string", "format": "uuid" }, { "name": "exportId", "in": "path", "description": "The export ID GUID for the request.", "required": true, "type": "string", "format": "uuid" } ], "responses": { "200": { "description": "OK", "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": "Returns the results for a single account settings export request.", "description": "Returns the results for a single account settings export request.\n\n- Required scopes: `account_read`\n\nGiven an export id, this method returns the results of an account settings export request.\nTo get a list of all the export requests, use `getAccountSettingsExports`.\n\nYou can find the actual list of settings at `results[n].url` in the response. The settings export is formatted like this:\n\n``` json\n{\n \"accounts\": [\n {\n \"account_id\": \"9ca037f4-xxxx-xxxx-xxxx-212e57d4f22e\",\n \"name\": \"The Happy Company\",\n . . .\n },\n {\n \"account_id\": \"624e3e00-xxxx-xxxx-xxxx-43918c520dab\",\n \"name\": \"LoanCo\",\n . . .\n }\n ],\n \"settings\": [\n . . .\n {\n \"category\": \"Signing\",\n \"name\": \"SignerCanSignOnMobile\",\n \"account_values\": [\n {\n \"account_id\": \"9ca037f4-xxxx-xxxx-xxxx-212e57d4f22e\",\n \"value\": \"true\",\n \"rights\": \"editable\"\n },\n {\n \"account_id\": \"624e3e00-xxxx-xxxx-xxxx-43918c520dab\",\n \"value\": \"true\",\n \"rights\": \"editable\"\n }\n ]\n },\n . . .\n ]\n}\n\n```\n", "operationId": "OrganizationExport_OrganizationExport_GetAccountSettingsExportByExportId", "produces": [ "application/json" ], "parameters": [ { "name": "organizationId", "in": "path", "description": "The organization ID Guid", "required": true, "type": "string", "format": "uuid" }, { "name": "exportId", "in": "path", "description": "The export ID GUID for the request.", "required": true, "type": "string", "format": "uuid" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/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": "Deletes a single account settings export request.", "description": "Deletes a single account settings export request.\nAny data associated with the request is also deleted.\n\n- Required scopes: `account_read`\n\n", "operationId": "OrganizationExport_OrganizationExport_DeleteByAccountSettingsExportId", "produces": [ "application/json" ], "parameters": [ { "name": "organizationId", "in": "path", "description": "The organization ID Guid", "required": true, "type": "string", "format": "uuid" }, { "name": "exportId", "in": "path", "description": "The export ID GUID for the request.", "required": true, "type": "string", "format": "uuid" } ], "responses": { "200": { "description": "OK", "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": "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.\n\n- Required scopes: `account_read`", "operationId": "OrganizationImport_OrganizationImportAccountSettings_Get", "consumes": [ "application/json" ], "produces": [ "application/json" ], "parameters": [ { "name": "organizationId", "in": "path", "description": "The organization ID Guid", "required": true, "type": "string", "format": "uuid" } ], "responses": { "200": { "description": "OK", "schema": { "type": "array", "items": { "$ref": "#/definitions/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": "Creates a new account settings import request.", "description": "Creates a new account settings import request.\n\n\n- Required scopes: `account_write`", "operationId": "OrganizationImport_OrganizationImportAccountSettings_Post", "consumes": [ "multipart/form-data" ], "produces": [ "application/json" ], "parameters": [ { "name": "organizationId", "in": "path", "description": "The organization ID GUID.", "required": true, "type": "string", "format": "uuid" }, { "name": "file.csv", "in": "formData", "description": "CSV file.", "required": true, "type": "file" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/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": "Returns the details/metadata for a Bulk Account Settings Import request.", "description": "Returns the details/metadata for a Bulk Account Settings Import request.\n\nRequired - scopes: `account_read`\n\n\n\nGiven an import ID, this method returns the results of an account settings import request.\nTo get a list of all the import requests, use `getAccountSettingsImports`.\n\n", "operationId": "OrganizationImport_OrganizationImportAccountSettings_GetById", "consumes": [ "application/json" ], "produces": [ "application/json" ], "parameters": [ { "name": "organizationId", "in": "path", "description": "The organization ID Guid", "required": true, "type": "string", "format": "uuid" }, { "name": "importId", "in": "path", "description": "The import ID GUID for the request.", "required": true, "type": "string", "format": "uuid" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/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": "Deletes a Bulk Account Settings Import request.", "description": "Deletes a single account settings import request.\nAny data associated with the request is also deleted.\n\n- Required scopes: `account_write`", "operationId": "OrganizationImport_OrganizationImportAccountSettings_DeleteById", "consumes": [ "application/json" ], "produces": [ "application/json" ], "parameters": [ { "name": "organizationId", "in": "path", "description": "The organization ID Guid", "required": true, "type": "string", "format": "uuid" }, { "name": "importId", "in": "path", "description": "The import ID GUID for the request.", "required": true, "type": "string", "format": "uuid" } ], "responses": { "200": { "description": "OK", "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": "Creates a request to import new users into an account.", "description": "Creates a request to import *new* users.\n\n- Required scopes: `user_write`\n\n\n\nYour 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`.\n\nTo ensure your CSV is properly formatted, use the\n[Sample Bulk Add CSV file](https://admin.docusign.com/static-resources/organization-user-import.csv)\n as a template. The following table describes the columns.\n\n\n\n| Column | Required | Description |\n| :------------------ | :------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |\n| 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**. |\n| AccountName | | The name of the user's account in your organization. The account name must match the account ID provided. |\n| FirstName | yes | The user's first name. |\n| LastName | yes | The user's last name. |\n| UserEmail | yes | The user's complete email address. |\n| 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. |\n| UserTitle | | The user's job title. |\n| CompanyName | | The user's company name. |\n| 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. |\n| AddressLine1 | | The user's address, first line. |\n| AddressLine2 | | The user's address, second line. |\n| City | | The user's city name. |\n| StateRegionProvince | | The user's regional location. |\n| PostalCode | | The user's postal code. |\n| Phone | | The user's phone number. |\n| Language | | The user's display language for their DocuSign account. Must be one of:
zh_CN
zh_TW
nl
en
fr
de
it
ja
ko
pt
pt_BR
ru
es
zh_CN
zh_TW
nl
en
fr
de
it
ja
ko
pt
pt_BR
ru
es