Memberships control mappings of users to particular roles within teams.
Membership Object
Attribute | Description |
---|---|
id | integer The ID of the membership, generated automatically |
teamId | integer The ID of the team associated with the membership |
userId | integer The ID of the user associated with the membership |
accepted | boolean Indicates whether the membership has been accepted |
role | MembershipRole The role of the user in the team |
team | Team Object The team associated with the membership |
user | User Object The user associated with the membership |
disableImpersonation | boolean Indicates whether impersonation is disabled for this membership |
Example Membership Object
{ "id": 1501, "teamId": 300, "userId": 75, "accepted": true, "role": "MEMBER", "team": [Team Object], "user": [User Object], "disableImpersonation": false }
Find all memberships
GET
/memberships
Create a new membership
POST
/memberships
Find a membership
GET
/memberships/{userId}_{teamId}
Edit an existing membership
PATCH
/memberships/{userId}_{teamId}
Remove an existing membership
DELETE
/memberships/{userId}_{teamId}