Embedded APIResourcesManage customers

Update customer workspace member

Updates a member in an existing Embedded customer workspace.

UPDATE MEMBER RESTRICTION: You can update the role_name field through the API for any member, whether they were added manually or through the API. You cannot update other fields, including oauth_id, external_id, and time_zone.

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.

member_idstringRequired
The ID of the member.

Headers

AuthorizationstringRequired

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

Request

This endpoint expects an object.
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 response
idinteger or null
Unique identifier of the user
grant_typestring or null
Type of grant associated with the user
role_namestring or null
Role assigned to the user
external_idstring or null
External identifier of the user
namestring or null
Full name of the user
emailstring or null
Email address of the user
time_zonestring or null
Time zone of the user
created_atdatetime or null
Timestamp when the user was created in ISO 8601 format
last_activity_logmap from strings to any or null
Details of the user's last activity, if available

Errors