My Account - Developer

1. Click the OAuth applications tab on the Developer page to see a list of all your apps:

   

2. Click the Create new OAuth application button.

3. Fill out the form:

   • Name - Name of the application displayed to users.

   • Primary format - String that uniquely identifies your application and is a marker for the data it might store on Onshape servers (e.g.,com.example.example). Cannot be changed after the application is registered. Not displayed to users.

   • Summary - Description of the application, shown to the user when they’re asked to grant the application permission to access their data.

   • Redirect URLs - URL to which you are redirected after authentication; the landing page of your application.

     • Your application must specify at least one URL used in the OAuth protocol exchanges.

     • This URL must also use SSL (a URL that begins with https), with two exceptions applicable for installed desktop applications: http://localhost:<port> and urn:ietf:wg:oauth:2.0:oob.

   • Type - Application type: Integrated Cloud App, Connected Cloud App, or Connected Desktop App.

   • OAuth URL - URL used to start the OAuth2 process to authenticate the user. See Developer Docs: OAuth2 for details.

     • Should contain the URL of your deployed application.

     • This is the first URL called from the Onshape Applications page.

     • The page hosted at this URL should handle the OAuth authentication. Once your application’s server has been authenticated on behalf of the user, that user should be redirected to your applications content.

     • If you have not deployed your app yet, you can leave this field blank for local work and update it later.

       All applications submitted to the Onshape App Store for public use must authenticate properly with OAuth2. See Developer Docs: OAuth2 for details.

   • Settings

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

   • Permissions - See Permission scopes below.

4. Click Create application.

5. Copy the OAuth secret key from the window.

   You will not be able to access this secret key again. This secret is unique to you and your app. It should be protected like any sensitive password and never checked into source code.

6. The app's OAuth application entry appears with the Details tab active. Selecting the app name on the OAuth applications tab now brings you to this screen.

Use the tabs on this screen to:

• Details:

  • Create a store entry for the app

  • Transfer ownership of the app

  • Delete the application

• Settings: Manage app settings

• Keys and secret:
  • Copy the OAuth client identifier key
  • Regenerate a new OAuth client secret key

• Permissions: Modify app permission scopes

• Extensions: Manage app extensions

• Onshape OAuth: Manage Onshape authentication

• External OAuth: Manage third-party authentication

See the Onshape Developer Documentation for more information, including: properly authenticating with OAuth2 and completing Launch Checklist. See the Hello World tutorial for a working example.

1. Click the OAuth applications tab on the Developer page, then select your application.

2. Click the Extensions tab.

   

3. Click Add extension.

4. Fill out the form:

   • Name: Can be truncated in the UI if it is too long.

   • Description (optional): Does not appear in the Onshape UI, but could appear in the authentication grant process.

   • Location: Where the extension exists in the Onshape UI.

     • See Supported Locations and Contexts in the Developer Docs.

     • You can create only one element tab extension per application.

   • Context: Some locations work in the context of a selection, such as inside a Part Studio.

     • See Supported Locations and Contexts in the Developer Docs.

   • Action URL: Locations that embed a UI use the action URL to define the address of the page to display. The action URL is used to specify the REST endpoint if the location is an action (context menu, toolbar item, action in dialog etc.) and the action type is GET or POST. If the location is an action and the action is Open in new window, the action URL is the URL to open in the new window.

     • See Action URL parameters in the Developer Docs for a list of parameters that can be used in this field.

   • Action type: Applicable for locations that do not embed UIs. Supported action types are:

     • GET - This makes a GET API call using the action URL. Parameter replacement is done on the action URL.

     • POST - This makes a POST API call using the action URL and the action body as the post body. Parameter replacement is done on both the action URL and the action body.

     • Open in new window - This opens the action URL in a new browser window. Parameter replacement is done on the action URL.

   • Action body: Only applicable for POST action types. The action body is passed in a POST API call and must be in a valid JSON format.

   • Show response: This is only applicable if the action type is GET or POST. When selected, the UI waits for a response and shows the response in a dialog in the UI. The response must be in a valid JSON format.

   • Icon: The icon is displayed where the extension exist, which can include an icon in an Info panel, context menu action, toolbar button, action button in a dialog, or other supported locations.

5. Click OK.

For more information on creating and managing Onshape applications, please see the Onshape Developer Docs. Please see the Hello World tutorial for a working example.

1. In your Developer settings, click OAuth applications.
2. Click the name of the app to transfer.
3. Click the Transfer ownership button on the Details tab. The Transfer ownership dialog opens.

   

4. Select an option to transfer the app to an individual, company, or enterprise.
5. To transfer to an individual, enter the name or email of the new owner in the search field. To transfer ownership to a company or enterprise, select an option from the dropdown.
6. Click Transfer Ownership. The application is removed from your OAuth apps list.
   • If the app is transferred to an individual account, they receive an email notification and the app appears in their Onshape Developer Portal.
   • If the app is transferred to someone in a Company/Classroom/Enterprise, all Admins receive an email notification and the app appears in their Developer Settings.

Future API call consumption and billing will be attributed to the new owner. See API Limits for details.

1. Click Developer in the left pane of your company settings, click OAuth applications, then select the app to deprecate.

2. On the Details tab, click the Delete permanently button.
   

3. Click Delete again to confirm in the dialog.

To create a new store entry for an OAuth application:

1. Click OAuth applications on the Developer page, then select your application.

2. Click the Create store entry button on the app's Details tab.

   

3. Fill out the form:

   • Name - Automatically set from the app name provided during registration.

   • Summary - Automatically set from the summary provided during registration.

   • Type - Application type: Integrated Cloud App, Connected Cloud App, or Connected Desktop App. This should match the Type that was selected when registering the OAuth application.

   • Category - Select the appropriate category for your app.

   • Team Visibility - Choose to make the private app store entry visible to no internal users (default), all internal users, or specific teams.

   • Description - User-facing description of the application. Limited formatting allowed.

   • Support URL - URL or email users of your app should be directed to for assistance. This must be actively monitored.

   • Support Email - Email that should receive app subscription notifications. This must be actively monitored.

   • Vendor - Your company name.

   • Version - Current version of this application.

   • Images - Optionally upload summary, hero, and other images.

4. Click Create.

The application appears in the Onshape App Store as private. It is viewable only to you and any internal teams specified in Team Visibility settings. To make the app public, see the Launch Checklist next.

To return to this screen, click the Store entry tab for the application:

Individual account users can subscribe to the app in the Onshape App Store:

1. Go to the Onshape App Store: https://cad.onshape.com/appstore
2. Select the app. The app is still private and can only be seen by you as the creator:
   
3. Click Subscribe:
   
4. Follow the on-screen prompts to subscribe to the app.
5. Refresh your Onshape browser window to test the app extension.

1. Click OAuth applications on the Developer page, then select your application.
2. Click the Store entry tab.
3. Click Delete store entry on the Details tab.
   
4. Click Delete again to confirm.