Customer workspace collaborators
This API enables you to manage collaborators in a customer workspace. To work with collaborators in an admin workspace, refer to the Developer API documentation for workspace collaborators.
Invite collaborator to managed customer workspace
Invites a collaborator to a managed customer’s team. If the email does not belong to an existing user, an email invite will be sent. The collaborators will be able to join the team after they have created a Workato account. Invites a collaborator to a managed customer workspace. An email invite is sent if the provided email is not associated with an existing collaborator. Invited collaborators can join the workspace after they create a Workato account.
Role-based access control
EARLY ACCESS FEATURE
The endpoints in this section are in limited preview. The access control model is under active development and may change. Contact your Customer Success Manager to be added to the early adopters list to participate in early access testing.
The Workato access control model replaces legacy system and custom roles. This model separates permissions into environment roles and project roles to support flexible and environment-specific access control. Refer to the Manage workspace collaborators with role-based access control documentation for more information on the access control model.
Refer to the following sections to manage collaborators and roles:
Collaborators
Use the following endpoints to manage collaborators in an Embedded customer workspace.
API CLIENT ACCESS
API clients require access to the DEV environment to manage collaborators. Refer to Create a client role to configure an API client’s access.
Quick reference
Collaborator groups
Use the following endpoints to manage collaborator groups in an Embedded customer workspace.
Quick reference
Environment roles
Use the following endpoints to manage your environment roles in an Embedded customer workspace.
Environment roles have the following values:
- system: Default roles provided by Workato.
- custom: Roles created manually within a workspace.
- inheritable: Custom roles from an AHQ admin or Embedded partner workspace that are inheritable by child workspaces.
- inherited: Roles inherited by a child workspace from its AHQ or Embedded parent.
LEGACY ROLE COMPATIBILITY
The following endpoints are only compatible with new roles where the role_type is environment.
Use the /api/roles endpoints instead to manage legacy roles where the role_type is privilege_group.
Quick reference
Project roles
Use the following endpoints to manage project roles in an Embedded customer workspace.
Project roles have the following values:
- system: Default roles provided by Workato.
- custom: Roles created manually within a workspace.
- inheritable: Custom roles from an AHQ admin or Embedded partner workspace that are inheritable by child workspaces.
- inherited: Roles inherited by a child workspace from its AHQ or Embedded parent.
Quick reference
Project grants
Use the following endpoints to manage a collaborator or group’s project grants in an Embedded customer workspace.
TITLE
Project grant endpoints can only assign project roles to environments and projects that the API client can access. For example, an API client assigned to the TEST environment can only manage TEST projects. Additionally, if an API client is assigned to specific projects, it can only manage those projects. Refer to Create a client role to configure an API client’s access.
What are project grants?
A project grant assigns a project role to a collaborator or group.
Quick reference
Migration tool
Use the following endpoints to convert legacy roles into environment and project roles in an Embedded customer workspace, or use the in-app migration wizard.