API Reference

Remove Group Members

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

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.

Request body

RemoveGroupMembersRequest

object

Hide child attributes

principalIds

list<PrincipalId>

optional

Show child attributes

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" \
	-d '{"principalIds":["f05f8da4-b84c-4fca-9c77-8af0b13d11de"]}'

Error responses

Error Name
`RemoveGroupMembersPermissionDenied`	Error Code	`PERMISSION_DENIED`
	Status Code	403
	Description	Could not remove the GroupMember.
	Parameters	`groupId`

See Errors for a general overview of errors in the platform.