Skip to navigation

How to create an IK and manage guest developers in the Developer Console

View as Markdown

The Developer Console integrations management features are now in open beta. All developers can create and manage integration keys using the console interface.

The Docusign Developer Console is the single location where you can manage integration keys (IKs) across both the demo and production environments. Now, you can promote your app to production through the click of a button and you no longer need to switch between multiple accounts or follow the legacy Go-Live process. You will manage everything from a single production account. You also have more granular control over developer permissions, and no longer need to give developers the DS Admin permission profile to let them manage integration keys.

Follow the steps below to manage developer permissions, create an integration key in the Developer Console, and migrate integrations on the demo environment from the Apps and Keys tool to the Developer Console.

1. Add developers to the account through the admin page

Note: If your developers are already added as users in your account, you can skip to Assign developer roles.

  1. Navigate to the admin tab in your production Docusign account.

  2. Select Users in the side menu.

  3. Select Add User and follow the steps to add your developer team members in your account.

    • Note: To give these users the least amount of privileges, select DS Viewer for the permission profile.
  4. Once added, your developers will receive an email to sign up for your production account.

  5. After they complete the sign-up process, they will appear in your Users list as Active.

A screenshot of the admin tab where the admin adds users to their account

2. Assign developer roles

  1. Navigate to the admin tab in your Docusign account and select Users in the side menu.

  2. Select the developer user, select the Developer Access tab, and assign one of the following roles:

    • Developer Admin → This developer will have the most permissions in the Developer Console. They might be your engineering lead or manager, who can oversee and control every integration. They can create integrations, manage all integrations in the account, take them live, and share them with Guest Developers.
    • Full Developer → This is your internal developer. They can create integrations, manage all integrations in the account, and take them live. They cannot share integrations with Guest Developers.
    • Guest Developer → This developer has the least amount of permissions in the Developer Console. They might be your system integrator, junior developer, or intern. They can create new integrations, but they can’t take them live unless they are explicitly granted permission to do so. They can only see the integrations they create and any integrations shared with them by the Developer Admin.

Once the roles are assigned, developers can access the Dev Console directly.

A screenshot of the admin tab where the admin grants a user developer access

3. Share specific IKs with developers

  1. Log into the Dev Console as the admin.
  2. Choose the IK you want to share with a guest developer, select the three dot menu, and select Share.
  3. Choose the level of permission that you’d like to assign to that developer. If you want the developer to be able to take the IK live, choose Can Manage Production.
A screenshot of the developer console where admins can give developers permissions for an IK

4. Developers access the Developer Console and start building integrations

The developer can now follow the steps below to create an integration.

  1. Log into the Dev Console.
  2. Create new integration by clicking the + Add button.
  3. At the top right, you will see a toggle for Demo and Production. Keep the toggle on Demo.
  4. Get your integration’s Demo Client ID and Secret.
  5. Use them to connect to Docusign’s Demo APIs and start your build/test journey.
  6. For testing, you can use any Docusign Developer account.
  7. When you’re ready to go live, select your integration type, Click Save, and then click Submit for Go-Live approval.
  8. Once the integration status changes to Live, switch the toggle from Demo to Production to access your production client ID and secret.
A screenshot of an IK in the dev console

5. Migrate integrations on demo to the Developer Console

Follow this procedure to migrate integrations on the demo environment from the Apps and Keys tool to the Developer Console. After migration:

  • You can manage both the demo and production versions of integrations from a single production account.
  • Integrations will no longer be accessible through the demo Apps and Keys tool. Production versions will continue to be available in the production Apps and Keys tool.

Production versions of integrations are already accessible in the Developer Console. They do not require a manual migration process.

Note: You cannot migrate integrations that have not been promoted to production and exist only in a demo account.

  1. Log into the Dev Console.
  2. In the Migrate banner, select Start.
  3. On the login window, enter the account credentials for your demo account.
  4. On the Select integrations window, select the demo integrations that you want to migrate to the Developer Console, and select Migrate.
  5. A confirmation message lists the number of integrations that were migrated.

After migration, when editing the integration in the Developer Console, you can toggle between the demo and production versions. The demo version can no longer be accessed via the Apps and Keys tool.

Select integrations to migrate

Next steps