IVSWikiBlue: Created page with "This API provides a list of all currently configured user groups. ===Resource URL===

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

===Resource Information=== {..."

2020-04-14T19:22:24Z

Created page with "This API provides a list of all currently configured user groups. ===Resource URL=== <pre>http://valt.example.com/api/v3/admin/user_groups</pre> ===Resource Information=== {..."

New page

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

===Resource URL===
<pre>http://valt.example.com/api/v3/admin/user_groups</pre>

===Resource Information===
{|class="wikitable"
|'''Method'''
|GET
|-
|'''Response Type'''
|JSON
|-
|'''Authentication Required'''
|Yes
|}

===Parameters===

No parameters can be passed to this call.

===Response===

{|class="wikitable"
!Code
!Reason
|-
|200
|Request Successful
|-
|401
|Unauthorized
|}

{|class="wikitable"
|+JSON Response
!colspan="3"|data
|-
|colspan="2"|'''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===
<pre>https://ivstest1.ad.ipivs.com/api/v3/admin/user_groups?access_token=e82632d19c523678fea3d1016c6df9e9</pre>

===Successful Response===
Sample response is shown with line breaks to make it more readable. Actual responses will not include line breaks.
<nowiki>
{
"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
}
]
}
}
</nowiki>

===Failure Response===
<pre>{"error":{"code":401,"message":"No API key provided"}}</pre>

API List User Groups - Revision history

IVSWikiBlue: Created page with "This API provides a list of all currently configured user groups. ===Resource URL===
http://valt.example.com/api/v3/admin/user_groups
===Resource Information=== {..."