API ReferenceTasksTask Forwarders

IAM - Update Task Forwarder Member

Update the roles that a member holds on the task_forwarder.

Authentication

AuthorizationBearer

API key or access token, sent as Authorization: Bearer <token>. The simplest option: create an API key in your dashboard under Settings, then paste it here.

OR
AuthorizationBearer

API key or access token, sent as Authorization: Bearer <token>. The simplest option: create an API key in your dashboard under Settings, then paste it here.

Path parameters

task_forwarder_idstringRequiredformat: "uuid"
memberstringRequired
org_idstringRequiredformat: "uuid"
The org id
project_idstringRequiredformat: "uuid"
The project id

Request

This endpoint expects an object.
addlist of enumsOptional

A list of task_forwarder roles to grant to the member.

Roles in this list are applied to the member AFTER any removals specified in remove.

This may be combined with remove_all to replace the member’s entire role list.

removelist of enumsOptional

A list of task_forwarder roles to revoke from the member.

remove_allboolean or nullOptionalDefaults to false

Removes all existing roles from the member. This may be combined with add to replace all existing roles that the member holds.

Response

Successful Response
memberstring

The member identifier string, the format of which is ‘<subject_type>:<subject_id>’

roleslist of stringsDefaults to []
A list of roles that the member holds on an entity. Some entities, such as Organizations, may contain members that exist without any roles.
namestring or null
The name of the member.
avatar_urlstring or null
If avatar of the member, if it is supported by their subject type.
total_subjectsintegerDefaults to 1

The total number of subjects that the member represents, which may be a value other than 1 if the member is not a User.

Errors

400
Bad Request Error
403
Forbidden Error
404
Not Found Error
422
Unprocessable Entity Error