Breadcrumbs

Metavault API - Assign user to group

AssignGroup - POST

Path

/api/users/{userId}/groups

Http Method

POST

Overview

NO LICENSE

Add the user to a group. Putting a user in a group adds all access rights of the group to the user.

Required permissions

  • Global administration privileges. ADMIN

Request

Path parameters

Parameter

Type

Required

Description

Example

userId

string

Yes

The Id of the user, generated on creation.

099ec495a1b548efa43b15da09262c20

Request body

JSON
{
  "groupId": "483b0d04f0d54eacbe9b7b34c35958ea"
}
Field descriptions

Field

Type

Required

Description

Constraints

groupId

string

yes

The id of the group to assign the user to.


Response

The response is equivalent to user creation: Metavault API - Create user | Response