POST/v1/user-groupsCreate a user group

Create a user group description

parameter	organizationId	The organization where the groups will be created: Number
header	Authorization	Authentication token (bearer token or API key).
{ "name" : String, "description" : String, "remarks" : String, "externalId" : String, "source" : String, "users" : [{ "userId" : Number, "groupAdmin" : Boolean }] }

Response

status	200	All ok, returned the id of created user group
status	401	Invalid authentication token
status	403	Insufficient rights
status	404	User group not found
Number

Example: Create a user group for POST request

POST/v1/user-groups

parameter	organizationId	1
header	Authorization	Bearer a064fac8-878e-4aa8-a2d9-e5a8b3fe1de3
{ "name": "Test group", "description": "group for test" }

Response

status	200
header	Access-Control-Expose-Headers	authorization, content-type
header	Access-Control-Allow-Headers	authorization, content-type
header	Access-Control-Allow-Methods	GET, POST, DELETE, OPTIONS, PUT
header	Access-Control-Allow-Origin	*
header	Strict-Transport-Security	max-age=31536000; includeSubDomains
header	X-Frame-Options	SAMEORIGIN
header	X-Content-Type-Options	nosniff
header	X-XSS-Protection	1; mode=block
header	Content-Security-Policy	default-src 'none'; frame-ancestors 'none'; base-uri 'none'; form-action 'none'
header	Referrer-Policy	no-referrer
header	Feature-Policy	self
header	Permissions-policy	interest-cohort=()
4

Example: Create a user group with users

POST/v1/user-groups

parameter	organizationId	1
header	Authorization	Bearer a9e4f3b6-424c-46bc-8b8f-e5cbd6d65e3f
{ "name": "Group with users", "description": "group created with initial users", "users": [{ "userId": 1, "groupAdmin": false }] }

Response

status	200
header	Access-Control-Expose-Headers	authorization, content-type
header	Access-Control-Allow-Headers	authorization, content-type
header	Access-Control-Allow-Methods	GET, POST, DELETE, OPTIONS, PUT
header	Access-Control-Allow-Origin	*
header	Strict-Transport-Security	max-age=31536000; includeSubDomains
header	X-Frame-Options	SAMEORIGIN
header	X-Content-Type-Options	nosniff
header	X-XSS-Protection	1; mode=block
header	Content-Security-Policy	default-src 'none'; frame-ancestors 'none'; base-uri 'none'; form-action 'none'
header	Referrer-Policy	no-referrer
header	Feature-Policy	self
header	Permissions-policy	interest-cohort=()
4

Example: Create a source-only group (a source without an external id)