Documentation is now available for the Fall 2020 Update release!

Create user group

This endpoint is used to create a partner-level or client-level user group.

Leave Feedback

URL

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

Sample URLs

https://{api-url}/api/v2/tenants/client_1/userGroups

Parameters

FieldData TypeDescription
nameStringUser group name.
descriptionString(Optional) Short summary describing the user group.
emailString(Optional) User group email address.
rolesString(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": "Network Admins",
	"description": "Level A Network Administrators",
	"email": "network.admins@myorganization.com",
	"roles": [{
		"uniqueId": "ROLE-76a8247c-39f4-8921-f5a4-babad80aa8fc"
	}]
}

Sample response

{
	"uniqueId": "USRGRP-9a68ce5d-c5cd-40a2-9fa6-e496dfe6e01b",
	"name": "Network Admins",
	"description": "Level A Network Administrators",
	"createdTime": "2017-10-16T08:17:17+0000",
	"updatedTime": "2017-10-16T08:26:29+0000",
	"email": "network.admins@myorganization.com",
	"roles": [{
		"uniqueId": "ROLE-76a8247c-39f4-8921-f5a4-babad80aa8fc",
		"name": "Network Admin Role",
		"description": "Level A network administrators to manage all network resources of site SJ",
		"defaultRole": false
	}]
}