Skip to main content
Version: 24.05

Remove User from Group

Enterprise

This endpoint is part of Countly Enterprise. To get access, contact sales or compare versions. Existing customers can reach the support portal with questions.

Endpoint​

/i/groups/remove-user-group

Overview​

Removes one user from one group and recalculates the user effective access from remaining groups.

Authentication​

Pass api_key or auth_token as a query parameter, or send countly-token as a header. See Authentication.

Permissions​

  • Required access: global admin

Request Parameters​

ParameterTypeRequiredDescription
api_keyStringYes (or auth_token)API key authentication
auth_tokenStringYes (or api_key)Auth token authentication
argsObject (JSON string)YesStringified remove-user object

args Object Fields​

FieldTypeRequiredDescription
emailStringYesUser email
group_idStringYesGroup ID to remove from user

Examples​

Example: Remove User from One Group​

Endpoint form:

https://your-server.com/i/groups/remove-user-group?api_key=YOUR_API_KEY&args={"email":"analyst@example.com","group_id":"507f1f77bcf86cd799439011"}

Decoded args object:

{
  "email": "analyst@example.com",
  "group_id": "507f1f77bcf86cd799439011"
}

Response​

Success Response​

{
  "result": "Success"
}

Response Fields​

FieldTypeDescription
resultStringOperation status

Error Responses​

HTTP StatusResponse
200{ "result": "Not enough args" }
400{ "result": "User not found" }
400{ "result": "User is not in any group" }
400{ "result": "User is not in given group" }
400{ "result": "Group not found" }
400{ "result": "Group does not have any user" }
400{ "result": "Group does not have given user" }
400{ "result": "Missing parameter \"api_key\" or \"auth_token\"" }

Behavior​

  1. Validates user-group relation.
  2. Removes user from groups.users.
  3. Recomputes user effective permissions from remaining groups.
  4. Updates user group_id, admin_of, user_of, restrict, global_admin, and permission.
Implementation details

Database Collections

CollectionUsed forData touched by this endpoint
countly.groupsEndpoint data source** - Group membership update source/target
countly.membersEndpoint data source** - User permission and group assignment update target