docusign-orgadmin

DocuSign Node.js API client.

Usage no npm install needed!

<script type="module">
  import docusignOrgadmin from 'https://cdn.skypack.dev/docusign-orgadmin';
</script>

README

docusign-orgadmin

DocusignOrgadmin - JavaScript client for docusign-orgadmin An API for an organization administrator to manage organizations, accounts and users This SDK is automatically generated by the Swagger Codegen project:

  • API version: v2.1
  • Package version: v1.0.8-rc
  • Build package: io.swagger.codegen.languages.JavascriptClientCodegen For more information, please visit https://developers.docusign.com

Installation

For Node.js

npm

To publish the library as a npm, please follow the procedure in "Publishing npm packages".

Then install it via:

npm install docusign-orgadmin --save
Local development

To use the library locally without publishing to a remote npm registry, first install the dependencies by changing into the directory containing package.json (and this README). Let's call this JAVASCRIPT_CLIENT_DIR. Then run:

npm install

Next, link it globally in npm with the following, also from JAVASCRIPT_CLIENT_DIR:

npm link

Finally, switch to the directory you want to use your docusign-orgadmin from, and run:

npm link /path/to/<JAVASCRIPT_CLIENT_DIR>

You should now be able to require('docusign-orgadmin') in javascript files from the directory you ran the last command above from.

git

If the library is hosted at a git repository, e.g. https://github.com/GIT_USER_ID/GIT_REPO_ID then install it via:

    npm install GIT_USER_ID/GIT_REPO_ID --save

For browser

The library also works in the browser environment via npm and browserify. After following the above steps with Node.js and installing browserify with npm install -g browserify, perform the following (assuming main.js is your entry file, that's to say your javascript file where you actually use this library):

browserify main.js > bundle.js

Then include bundle.js in the HTML pages.

Webpack Configuration

Using Webpack you may encounter the following error: "Module not found: Error: Cannot resolve module", most certainly you should disable AMD loader. Add/merge the following section to your webpack config:

module: {
  rules: [
    {
      parser: {
        amd: false
      }
    }
  ]
}

Getting Started

Please follow the installation instruction and execute the following JS code:

var DocusignOrgadmin = require('docusign-orgadmin');

var api = new DocusignOrgadmin.AccountsApi()

var organizationId = "organizationId_example"; // {String} The organization ID Guid

var accountId = "accountId_example"; // {String} The account ID Guid

var opts = { 
  'start': 56, // {Number} Index of first item to include in the response  Default value: 0
  'take': 56, // {Number} Page size of the response  Default value: 20
  'end': 56 // {Number} Index of the last item to include in the response. Ignored if 'take' parameter is specfied
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getGroups(organizationId, accountId, opts, callback);

Documentation for API Endpoints

All URIs are relative to https://api.docusign.net/Management

Class Method HTTP request Description
DocusignOrgadmin.AccountsApi getGroups GET /v2/organizations/{organizationId}/accounts/{accountId}/groups Returns the list of groups in an account.
DocusignOrgadmin.AccountsApi getOrganizations GET /v2/organizations Returns the list of organizations of which the authenticated user is a member.
DocusignOrgadmin.AccountsApi getPermissions GET /v2/organizations/{organizationId}/accounts/{accountId}/permissions Returns the list of permission profiles in an account.
DocusignOrgadmin.BulkExportsApi createAccountSettingsExport POST /v2/organizations/{organizationId}/exports/account_settings Creates a new Account Setting Export request.
DocusignOrgadmin.BulkExportsApi createUserListExport POST /v2/organizations/{organizationId}/exports/user_list Creates a new User List Export request.
DocusignOrgadmin.BulkExportsApi deleteAccountSettingsExport DELETE /v2/organizations/{organizationId}/exports/account_settings/{exportId} Deletes a single Account Settings Export request
DocusignOrgadmin.BulkExportsApi deleteUserListExport DELETE /v2/organizations/{organizationId}/exports/user_list/{exportId} Deletes a single User List Export request
DocusignOrgadmin.BulkExportsApi getAccountSettingsExport GET /v2/organizations/{organizationId}/exports/account_settings/{exportId} Returns the details/metadata for a single Account Setting Export request
DocusignOrgadmin.BulkExportsApi getAccountSettingsExports GET /v2/organizations/{organizationId}/exports/account_settings Returns the details/metadata for Account Setting Export requests
DocusignOrgadmin.BulkExportsApi getUserListExport GET /v2/organizations/{organizationId}/exports/user_list/{exportId} Returns the details/metadata for a single User List Export request
DocusignOrgadmin.BulkExportsApi getUserListExports GET /v2/organizations/{organizationId}/exports/user_list Returns a list of existing User List Exports (requests and completed exports) and their details/metadata
DocusignOrgadmin.BulkImportsApi addBulkAccountSettingsImport POST /v2/organizations/{organizationId}/imports/account_settings Creates a new account settings import request.
DocusignOrgadmin.BulkImportsApi createBulkImportAddUsersRequest POST /v2/organizations/{organizationId}/imports/bulk_users/add Import request for adding users to accounts within the organization.
DocusignOrgadmin.BulkImportsApi createBulkImportCloseUsersRequest POST /v2/organizations/{organizationId}/imports/bulk_users/close Closes the Bulk User Import request
DocusignOrgadmin.BulkImportsApi createBulkImportExternalCloseUsersRequest POST /v2/organizations/{organizationId}/imports/bulk_users/close_external Closes memberships which are not in an account which is part of the organization, but which do have email addresses which are @ a verified reserved web domain which belongs to the organization
DocusignOrgadmin.BulkImportsApi createBulkImportSingleAccountAddUsersRequest POST /v2/organizations/{organizationId}/accounts/{accountId}/imports/bulk_users/add Import request for adding user to a single account within the organization. Allows upload of user information without requiring an AccountId column
DocusignOrgadmin.BulkImportsApi createBulkImportSingleAccountUpdateUsersRequest POST /v2/organizations/{organizationId}/accounts/{accountId}/imports/bulk_users/update Import request for updating users for a single account within the organization. Allows upload of user information without requiring an AccountId column
DocusignOrgadmin.BulkImportsApi createBulkImportUpdateUsersRequest POST /v2/organizations/{organizationId}/imports/bulk_users/update Import request for updating users to accounts within the organization.
DocusignOrgadmin.BulkImportsApi deleteBulkAccountSettingsImport DELETE /v2/organizations/{organizationId}/imports/account_settings/{importId} Deletes a Bulk Account Settings Import request
DocusignOrgadmin.BulkImportsApi deleteBulkUserImport DELETE /v2/organizations/{organizationId}/imports/bulk_users/{importId} Deletes a User Import request
DocusignOrgadmin.BulkImportsApi getBulkAccountSettingsImport GET /v2/organizations/{organizationId}/imports/account_settings/{importId} Returns the details/metadata for a Bulk Account Settings Import request
DocusignOrgadmin.BulkImportsApi getBulkAccountSettingsImports GET /v2/organizations/{organizationId}/imports/account_settings Returns the details/metadata for Bulk Account Settings Import requests in the organization
DocusignOrgadmin.BulkImportsApi getBulkUserImportCSV GET /v2/organizations/{organizationId}/imports/bulk_users/{importId}/results_csv Returns a text/csv file with user details for a User Import request
DocusignOrgadmin.BulkImportsApi getBulkUserImportRequest GET /v2/organizations/{organizationId}/imports/bulk_users/{importId} Returns the details/metadata for a User Import request
DocusignOrgadmin.BulkImportsApi getBulkUserImportRequests GET /v2/organizations/{organizationId}/imports/bulk_users Returns the details/metadata for Bulk User Import requests in the organization
DocusignOrgadmin.DSGroupsApi addDSGroup POST /v2.1/organizations/{organizationId}/accounts/{accountId}/dsgroups Add a new DSGroup
DocusignOrgadmin.DSGroupsApi addDSGroupUsers POST /v2.1/organizations/{organizationId}/accounts/{accountId}/dsgroups/{dsGroupId}/users Add list of users to a DSGroup
DocusignOrgadmin.DSGroupsApi deleteDSGroup DELETE /v2.1/organizations/{organizationId}/accounts/{accountId}/dsgroups/{dsGroupId} Delete a DSGroup
DocusignOrgadmin.DSGroupsApi getDSGroup GET /v2.1/organizations/{organizationId}/accounts/{accountId}/dsgroups/{dsGroupId} Get list of DSGroup
DocusignOrgadmin.DSGroupsApi getDSGroupUsers GET /v2.1/organizations/{organizationId}/accounts/{accountId}/dsgroups/{dsGroupId}/users Get list of users in a DSGroup
DocusignOrgadmin.DSGroupsApi getDSGroups GET /v2.1/organizations/{organizationId}/accounts/{accountId}/dsgroups Get list of DSGroups
DocusignOrgadmin.DSGroupsApi removeDSGroupUsers DELETE /v2.1/organizations/{organizationId}/accounts/{accountId}/dsgroups/{dsGroupId}/users Remove users from a DSGroup
DocusignOrgadmin.IdentityProvidersApi getIdentityProviders GET /v2/organizations/{organizationId}/identity_providers Returns the list of identity providers for the organization.
DocusignOrgadmin.ProductPermissionProfilesApi addUserProductPermissionProfiles POST /v2.1/organizations/{organizationId}/accounts/{accountId}/products/users/{userId}/permission_profiles Assign user to permission profiles for one or more products
DocusignOrgadmin.ProductPermissionProfilesApi getProductPermissionProfiles GET /v2.1/organizations/{organizationId}/accounts/{accountId}/products/permission_profiles Get products associated with the account and the available permission profiles
DocusignOrgadmin.ProductPermissionProfilesApi getUserProductPermissionProfiles GET /v2.1/organizations/{organizationId}/accounts/{accountId}/products/users/{userId}/permission_profiles Retrieve list of user's permission profiles for each account's product
DocusignOrgadmin.ReservedDomainsApi getReservedDomains GET /v2/organizations/{organizationId}/reserved_domains Returns the list of reserved domains for the organization.
DocusignOrgadmin.UsersApi activateMembership POST /v2/organizations/{organizationId}/users/{userId}/memberships/{membershipId} Activates user memberships
DocusignOrgadmin.UsersApi addOrUpdateUser POST /v2.1/organizations/{organizationId}/accounts/{accountId}/users Creates and updates a multi-product user
DocusignOrgadmin.UsersApi addUsers POST /v2/organizations/{organizationId}/accounts/{accountId}/users Adds users to an account.
DocusignOrgadmin.UsersApi closeMemberships DELETE /v2/organizations/{organizationId}/users/{userId}/accounts Closes a user's memberships.
DocusignOrgadmin.UsersApi createUser POST /v2/organizations/{organizationId}/users Creates a new user
DocusignOrgadmin.UsersApi deleteIdentities DELETE /v2/organizations/{organizationId}/users/{userId}/identities Deletes user identities.
DocusignOrgadmin.UsersApi getUserProfiles GET /v2/organizations/{organizationId}/users/profile Returns user information.
DocusignOrgadmin.UsersApi getUsers GET /v2/organizations/{organizationId}/users Returns information about the users in the organization
DocusignOrgadmin.UsersApi updateEmailAddress POST /v2/organizations/{organizationId}/users/email_addresses Updates a user's email address.
DocusignOrgadmin.UsersApi updateUser POST /v2/organizations/{organizationId}/users/profiles Updates a user.

Documentation for Models

Documentation for Authorization

docusignAccessCode