Company

Update the company's information for a user.

Returns updated company user info. globalPermissions field is deprecated. Please use the following:

  • addGlobalPermissionsForIdentity
  • clearGlobalPermissions
post/companies/{cid}/users/{uid}

Request

  • Base URL
    https://api.onshape.com/api/v17
  • URL
    https://api.onshape.com/api/v17/companies/{cid}/users/{uid}
  • Auth
    OAuth 2 and HTTP basic
    Authorization code: /oauth/authorize
    Token URL: /oauth/token scopes: OAuth2Write

Path parameters

cidstring required

Company ID

uidstring required

User ID

Request body

adminboolean

Indicates the user is an admin if true.

companyIdstring

Company ID of the user.

documentationNameOverridestring

String to override documentation name.

emailstring

Email ID of the company user.

globalPermissionsinteger[]

List of global permissions to grant. See Onshape Help: Global Permissions for details on each of the available permissions.

  • 0: Manage role based access control
  • 1: Manage users, teams, and aliases
  • 2: Enterprise administrator
  • 3: Permanently delete
  • 4: Analytics administrator
  • 5: Invite guest users
  • 6: Create projects
  • 7: Approve releases
  • 8: Enable link sharing
  • 9: Create releases
  • 10: Allow access to the App Store
  • 11: Create documents and folders in the Enterprise root
  • 12: Allow access to public documents
  • 17: Manage non-geometric items
  • 18: Manage workflows
  • 19: Transfer documents out of Enterprise
  • 20: Sync to configured PLM Integration in Enterprise settings
  • 21: Create tasks
  • 22: Manage standard content metadata
  • 23: Workspace protection permissions
  • 24: Import files
  • 25: Use revision tools
  • 26: Export files
  • 27: Allow access to Onshape Labs
  • 28: Make personal copies of enterprise documents (EDU Enterprise only)
  • 29: Allow managing public libraries
  • 30: Allow access to public libraries
guestboolean

Indicates the user is a guest user if true.

lightboolean

Indicates the user is a light user if true.

Response

default response

Changes

No recorded changes to this operation across all 12 revisions of this API.