User management API - PUT user groups
Sets groups membership of a user. Any existing memberships are overwritten.
The request consumes an
To execute this request, you need the Allow write access for identity resources (users and groups) (
account-idm-write) scope assigned to your token. To learn how to obtain and use it, see Authentication.
The ID of the required account.
You can find the UUID on the Account > Account management API page, during creation of an OAuth client.
The email address of the required user.
The body of the request. Contains a list of groups (specified by UUIDs) where the user is to be a member.
The user will be removed from any group that is not specified here.
Request body objects
The object doesn't provide any parameters.
Request body JSON model
This is a model of the request body, showing the possible elements. It has to be adjusted for usage in an actual request.
[ "string" ]
Success. The group membership has been set. Response doesn't have a body.
In this example, the request assigned the user with the email@example.com email address to groups with the following UUIDs:
The response code of 200 indicates that the modification has been successful.
curl --request PUT \ --url 'https://firstname.lastname@example.org' \ --header 'Authorization: Bearer abcdefjhij1234567890' \ --header 'Content-Type: application/json' \ --data ' [ "b794097-8ad2-4b32-b923-0131da2eeddf", "56d56aba-c12f-44c1-a0ba-42eba3e3ff84" ] '
[ "b794097-8ad2-4b32-b923-0131da2eeddf", "56d56aba-c12f-44c1-a0ba-42eba3e3ff84" ]