Only available for

Allow Enterprise admins to create new apps to which Enterprise users can subscribe. Admins can manage and distribute these apps to specified users. Enterprise admins can also create, view, and delete API keys for the Enterprise..

For more information on working with Onshape applications and API keys, please see the Onshape API Developer Documentation.

To navigate to your Developer settings in Onshape, click on your Account user icon (Account user icon) in the top right corner of your Onshape window. This opens a dropdown menu. Click Enterprise settings.

Click Developer in the list on the left side of the page:

Enterprise settings: Developer

What the Enterprise admin can do from this screen

  • Create an internal app in the company settings without going to the App Store dev portal

  • Manage the app internally

  • View, create, and delete API keys for anyone in the Enterprise

  1. Click the OAuth applications link:

    Create new OAuth application

  2. Click the Create new OAuth application button:

    Creating an OAuth application

  3. Fill out the information as follows (note that detailed information is also provided on-screen):

    • Name - Name of the app displayed to users.

    • Primary format - Unique string to identify your app that is not displayed to the user.

    • Summary - Information about the app.

    • Redirect URLs - URL to which you are redirected after authentication.

    • Type - App type. Options are Integrated Cloud App, Connected Cloud App, or Connected Desktop App.

    • OAuth URL - URL used to start the OAuth process from the Onshape Applications page.

    • Settings

      • Supports collaboration - Check if you wish to collaborate with other users when developing the app.

    • Permissions - see Permission scopes below.

  4. Click Create application.

  5. Use the Search members field to locate and select users to join in app development and/or testing.

  6. The OAuth app screen to allow access to the App is provided to the user:

    Authorize app

  7. For information on authenticating your applications with OAuth, see API Guide: Authentication.

Viewing API keys

  1. In your Enterprise Developer settings, click API keys
  2. Review the API keys available for the Enterprise.
    API keys listed in the developer screen

Creating API keys

  1. In your Enterprise Developer settings, click API keys
  2. Click Create new API key.
    Create new API key screen
  3. Provide a name for the API key in the Name field.
  4. Assign the API key to someone in the Enterprise. You can search by name or email in the User field.
  5. Choose the permissions for the keys. See Permission scopes below.
  6. Click the Create API key button.

  7. In the pop-up window, copy the API key and secret key shown, save them somewhere, then click the Close button.

    You will not be able to find the secret key again, so save it somewhere safe!

    Secret key shown to user

  8. For information on authenticating your applications with API keys, see API Guide: Authentication.

Deleting API keys

  1. Click the "X" icon to the right of the API key you wish to delete.
  2. Confirm that you want to delete this API key for all users. This action cannot be undone. Click Delete to confirm.
    Deleting an api key

The following permission scopes are available when creating OAuth applications and API keys:

  • Application can read your profile information (OAuth2ReadPII) - Check to allow the app access to information on your profile.

  • Application can read your documents (OAuth2Read) - Check to allow the app read access to your documents.

  • Application can write to your documents (OAuth2Write) - Check to allow the app write access to your documents.

  • Application can delete your documents and workspaces (OAuth2Delete) - Check to allow the app access to delete your documents and workspaces.

  • Application can request purchases on your behalf (OAuth2Purchase) - Check to allow the app the ability to make purchase for you.

  • Application can share and unshare documents on your behalf (OAuth2Share) -  Check to allow the app the ability to share and unshare your documents.