Embedded APIResourcesCustomer workspace collaborators

Add collaborator to customer workspace

Add a member to the specified Embedded customer workspace.

SPECIFY ROLES FOR DIFFERENT ENVIRONMENTS
You must provide either role_name or env_roles in the payload. role_name only assigns a role in the dev environment.
Use env_roles to specify the environment type and role for other environments. Workato does not support a mixed approach to assigning roles. This means that when you combine the env_roles and role_name in the payload, Workato ignores the role_name and only assigns the roles specified by the env_roles object.

ADD AN EXISTING USER
You must provide the oauth_id and omit the role_name,external_id,time_zone, and name parameters to add an existing Workato user to an embedded workspace.

Path parameters

managed_user_idstringRequired

Embedded customer ID (external ID). The External ID must be URL encoded and prefixed with an E. For example, EA2300.

Headers

AuthorizationstringRequired

Bearer authentication of the form Bearer <token>, where token is your auth token.

Request

This endpoint expects an object.
namestringRequired
Full name of the member.
oauth_idstringOptional
Identifier used for OAuth.
role_namestringOptional
Membership role name.
external_idstringOptional
External identifier for the member.
time_zoneenumOptional
Time zone name of the member.
env_roleslist of stringsOptional
Environment roles.

Response

Success reply
idinteger
Member ID.
role_namestring
Membership role name.
time_zoneenum
Time zone name of the member.
grant_typestring or null
Type of role granted.
namestring or null
Name of the member.
emailstring or null
Email address of the member.

Errors