Members

List Team Members Endpoint

get

Endpoint to list team members.

Args: team_id: ID of the team for which to list the members. user: The authenticated user. rbac: RBAC component. db: The DB session.

Returns: List of team members.

Authorizations
OAuth2clientCredentialsRequired
Token URL:

OAuth2authorizationCodeRequired
Authorization URL: Token URL: Refresh URL:
Path parameters
team_idstring · uuidRequired
Responses
chevron-right
200

Successful Response

application/json

Team assignment model.

userany ofOptional
or
nullOptional
invitationany ofOptional
or
nullOptional
get
/teams/{team_id}/members

Add Team Member Endpoint

post

Endpoint to add a team member.

Args: team_id: ID of the team to which to add a member. user_id: ID of the user to add to the team. invitation_id: ID of the invitation to add to the team. user: The authenticated user. rbac: RBAC component. db: The DB session. organization_manager: Organization manager.

Raises: ValueError: If both or None of user_id and invitation_id are specified. IllegalOperationError: If the user/invitation is not part of the teams organization.

Authorizations
OAuth2clientCredentialsRequired
Token URL:

OAuth2authorizationCodeRequired
Authorization URL: Token URL: Refresh URL:
Path parameters
team_idstring · uuidRequired
Query parameters
user_idany ofOptional
string · uuidOptional
or
nullOptional
invitation_idany ofOptional
string · uuidOptional
or
nullOptional
Responses
chevron-right
200

Successful Response

application/json
anyOptional
post
/teams/{team_id}/members

No content

Remove Team Member Endpoint

delete

Endpoint to remove a member from a team.

Args: team_id: ID of the team from which to remove the user. user_id: ID of the user to remove from the team. invitation_id: ID of the invitation to remove from the team. user: The authenticated user. rbac: RBAC component. db: The DB session.

Raises: ValueError: If both or None of user_id and invitation_id are specified.

Authorizations
OAuth2clientCredentialsRequired
Token URL:

OAuth2authorizationCodeRequired
Authorization URL: Token URL: Refresh URL:
Path parameters
team_idstring · uuidRequired
Query parameters
user_idany ofOptional
string · uuidOptional
or
nullOptional
invitation_idany ofOptional
string · uuidOptional
or
nullOptional
Responses
chevron-right
200

Successful Response

application/json
anyOptional
delete
/teams/{team_id}/members

No content

Last updated

Was this helpful?