Update user group

URL

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

Sample URLs

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

Parameters

Field	Data Type	Description
name	String	User group name.
description	String	(Optional) Short summary describing the user group.
email	String	(Optional) User group email address.
roles	String	(Optional) Assign roles to user group. Users part of a group automatically inherit the permissions associated with that group. To retrieve roles within a tenant, use Search Roles API.

Status code

200 OK

Sample request

{
	"name": "Windows Admins",
	"description": "Windows Administrators in North-West location",
	"email": "windows.admins@myorganization.com",
	"roles": [{
			"uniqueId": "ROLE-76a8247c-39f4-8921-f5a4-babad80aa8fc"
		},
		{
			"uniqueId": "ROLE-836704cd-9faf-355e-6995-f124e1c5de48"
		}
	]
}

Sample response

{
	"uniqueId": "USRGRP-9a68ce5d-c5cd-40a2-9fa6-e496dfe6e01b",
	"name": "Windows Admin Group",
	"description": "Windows Admins in North-West location",
	"createdTime": "2017-10-16T08:17:17+0000",
	"updatedTime": "2017-10-16T08:29:32+0000",
	"email": "windows.admins@myorganization.com",
	"roles": [{
			"uniqueId": "ROLE-76a8247c-39f4-8921-f5a4-babad80aa8fc",
			"name": "Admin Permissions",
			"description": "Permissions for Windows team",
			"defaultRole": false
		},
		{
			"uniqueId": "ROLE-836704cd-9faf-355e-6995-f124e1c5de48",
			"name": "Minimal Dev Permissions",
			"description": "Permissions on minimal Windows devices",
			"defaultRole": false
		}
	]
}