API Reference

Remove Group Members

POST/api/v2/admin/groups/{groupId}/groupMembers/remove

Warning

This endpoint is in preview and may be modified or removed at any time. To use this endpoint, add preview=true to the request query parameters.

Third-party applications using this endpoint via OAuth2 must request the following operation scope: api:admin-write.

Path parameters

groupId

string

The ID of a Foundry Group or User.

Query parameters

preview

boolean

optional

Enables the use of preview functionality.

Request body

RemoveGroupMembersRequest

object

Hide children

principalIds

list<PrincipalId>

optional

Show children

PrincipalId

string

The ID of a Foundry Group or User.

Examples

Request

Copied!

curl -X POST \
	-H "Content-type: application/json" \
	-H "Authorization: Bearer $TOKEN" \
	"https://$HOSTNAME/api/v2/admin/groups/f05f8da4-b84c-4fca-9c77-8af0b13d11de/groupMembers/remove?preview=true" \
	-d '{"principalIds":["f05f8da4-b84c-4fca-9c77-8af0b13d11de"]}'