Documentation is now available for the Fall 2020 Update release!

Remove users from a user group

This endpoint is used to remove users from an existing user group.

Leave Feedback

URL

DELETE https://{api-url}/api/v2/tenants/{tenantId}/userGroups/{userGroupId}/users

Sample URLs

https://{api-url}/api/v2/tenants/client_1/userGroups/USRGRP-9a68ce5d-c5cd-40a2-9fa6-e496dfe6e01b/users

Parameters

FieldData TypeDescription
idString(Optional) Provide user ID to add user into the group.
To fetch the users within a tenant, use the Search Users API.

Status code

200 OK

Sample request

[{
		"id": "USR0000000029"
	},
	{
		"id": "USR0000000030"
	}
]

Sample response

Null