Workspace collaborators | Workato

Use the following endpoints to manage collaborators in your workspace.

ENDPOINT ACCESS

Your API client must be assigned specific privileges specific privileges for the following endpoints:

Invite a collaborator
Get list of collaborators
Get collaborator details
Update collaborator roles
Get collaborator privileges

These privileges are determined by your API client.

Additionally, if your workspace uses environments, these privileges are only available to API clients with DEV access.

To enable endpoint access:

You can enable access to these endpoints by editing an existing API client role or by creating a new API client role:

Navigate to Workspace admin > API clients > Client roles.

Select the role you plan to edit.

Alternatively, click + Add client role to create a new API client role.

Select Admin and navigate to Workspace collaborators > Collaborators.

Select the checkboxes next to the endpoints you plan to enable for this role.

Invite POST /api/member_invitations
Get collaborators GET /api/members
Get collaborator GET /api/members/:id
Update collaborator’s roles PUT /api/members/:id
Get collaborator privileges GET /api/members/:id/privileges

Quick reference

Type	Resource	Description
GET	/api/members	Get list of workspace collaborators
GET	/api/members/:id	Get collaborator details
PUT	/api/members/:id	Update collaborator roles
GET	/api/members/:id/privileges	Get collaborator privileges
POST	/api/member_invitations	Invite a collaborator

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 using the Workato API:

Collaborators

Use the following endpoints to manage collaborators.

Quick reference

Type	Resource	Description
POST	/api/member_invitations	Invite a collaborator to a workspace.
GET	/api/members/	Get list of collaborators.
GET	/api/members/:id	Get collaborator details.
PUT	/api/members/:id	Update collaborator roles.
DELETE	/api/members/:id	Delete a collaborator.
GET	/api/members/:id/privileges	Get collaborator privileges.
GET	/api/members/:id/projects_privileges	Get collaborator projects privileges.

Collaborator groups

Use the following endpoints to manage your collaborator groups.

Quick reference

Type	Resource	Description
GET	/api/user_groups	List collaborator groups.
GET	/api/user_groups/:id	Get collaborator group details.
POST	/api/user_groups	Create a collaborator group.
PUT	/api/user_groups/:id	Update a collaborator group.
DELETE	/api/user_groups/:id	Delete a collaborator group.
GET	/api/user_groups/:id/members	List collaborator group members.
POST	/api/user_groups/:id/members	Add members to a collaborator group.
DELETE	/api/user_groups/:id/members	Remove members from a collaborator group.
GET	/api/user_groups/:id/project_grants	List a collaborator group’s project grants.

Environment roles

Use the following endpoints to manage your environment roles.

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

Type	Resource	Description
GET	/api/environment_roles	List environment roles.
GET	/api/environment_roles/:id	Get environment role details.
POST	/api/environment_roles	Create an environment role.
PUT	/api/environment_roles/:id	Update an environment role.
DELETE	/api/environment_roles/:id	Delete an environment role.

Project roles

Use the following endpoints to manage your project roles.

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

Type	Resource	Description
GET	/api/project_roles	List project roles.
GET	/api/project_roles/:id	Get project role details.
POST	/api/project_roles	Create a project role.
PUT	/api/project_roles/:id	Update a project role.
DELETE	/api/project_roles/:id	Delete a project role.

Project grants

Use the following endpoints to manage a collaborator or group’s project grants.

What are project grants?

A project grant assigns a project role to a collaborator or group.

Quick reference

Type	Resource	Description
GET	/api/project_grants/:id	Get a project grant.
PUT	/api/project_grants/:id	Update a project grant.
DELETE	/api/project_grants/:id	Delete a project grant.
GET	/api/projects/:id/project_grants	List project grants.
PUT	/api/projects/:id/project_grants	Add grants to a project.

Migration tool

Use the following endpoints to convert legacy roles into environment and project roles, or use the in-app migration wizard.

Quick reference

Type	Resource	Description
POST	/api/roles_migration/system_roles	Migrate system roles.
POST	/api/roles_migration/custom_role	Migrate a custom role.