API List User Groups

This API provides a list of all currently configured user groups.

Resource URL

http://valt.example.com/api/v3/admin/user_groups

Resource Information

Method	GET
Response Type	JSON
Authentication Required	Yes

Parameters

No parameters can be passed to this call.

Response

Code	Reason
200	Request Successful
401	Unauthorized

JSON Response

data
userGroups		List of all user groups.
	id	Group ID Number
	name	Group Name
	marker	Currently selected primary marker template.
	information	Currently selected primary information template.

Examples

Request

https://ivstest1.ad.ipivs.com/api/v3/admin/user_groups?access_token=exampletoken

Successful Response

Sample response is shown with line breaks to make it more readable. Actual responses will not include line breaks.

{
"data":{
"userGroups":[
{
"id": 1,
"name": "Administrators",
"marker": 2,
"information": 1
},
{
"id": 4,
"name": "IoGroup",
"marker": 2,
"information": 1
},
{
"id": 6,
"name": "Justin testing",
"marker": 2,
"information": 1
},
{
"id": 7,
"name": "Nathaniel",
"marker": 32,
"information": 1
},
{
"id": 2,
"name": "test",
"marker": 2,
"information": 1
},
{
"id": 3,
"name": "Test sharing",
"marker": 2,
"information": 1
},
{
"id": 5,
"name": "testContainer",
"marker": 2,
"information": 30
}
]
}
}

Failure Response

{"error":{"code":401,"message":"No API key provided"}}