Skip to main content

Collaborator

Immutable representation of a user’s collaboration on a project. A Collaborator binds a user to a project with a specific role and permissions. Collaborators are contextual - the same user can have different roles on different projects. Collaborator attributes are immutable. To modify the role, use the update() method which returns a new Collaborator instance. To remove access, use remove(). Examples

created_at

Get the creation timestamp.

email

Get the user’s email address.

first_name

Get the user’s first name.

id

Get the collaboration record ID.

last_name

Get the user’s last name.

permissions

Get the permissions for this collaboration. Returns None if no permissions data is available (either omitted by the API or explicitly empty). A non-empty list indicates specific actions the API caller can perform on this collaborator record.

project_id

Get the project ID.

remove

Remove this collaborator from the project. Revokes the user’s access to the project. After calling this method, the collaborator object should no longer be used. Examples

role

Get the collaboration role.

to_dict

Convert collaborator to dictionary representation.

Returns

dict: Dictionary with collaborator properties.

update

Update this collaborator’s role. Creates a new Collaborator instance with the updated role. The original instance remains unchanged (immutability is preserved). Arguments
  • role: The new role to assign (CollaboratorRole enum).

user_id

Get the user ID.