Remove Users from Team

Removes users from a given team, provided the authenticated user has edit access to that team. Users may be removed from additional teams by using admin permissions (see below).

📘

The teams from which users can be removed depend on whether the request is made using user or admin permissions.

  • User: team must be one that the requesting user has edit access to
    • Must request with a user grant/scope and either omit the header Lucid-Request-As or contain the value user.
  • Admin: team must belong to the account
    • Must request with an admin grant/scope and contain the header Lucid-Request-As with value admin.

Valid Authentication Methods

API Key Grants:

TeamsEdit

TeamsAdmin

OAuth 2.0 User Token Scopes:

teams

teams:admin


Path Params
number
required
Body Params
users
array of integers
required
users*
Headers
string
required
Defaults to 1
string
Responses
204

No Content. The users were successfully removed from the team. If requesting as admin, users may be have been removed even if the authenticated user does not have direct access to the specified team.

400

Bad Request.

  • if the user making the request attempts to remove all users from the team.
  • if not all the specified users are members of the team.
403

Forbidden.

  • if the user making the request does not have permission to edit teams.
  • if the user making the request does not have access to the specified team.
  • if the team is managed via SCIM. Use the SCIM Groups API to modify SCIM-managed teams.
Language
Credentials
LoadingLoading…
Response
Click Try It! to start a request and see the response here!