API List Users - Revision history

IVSWikiBlue: /* Request Parameters */

2025-06-10T16:16:56Z

‎Request Parameters

IVSWikiBlue at 16:14, 10 June 2025

2025-06-10T16:14:42Z

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

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

===Resource Information=== {|class="wiki..."

2020-04-14T19:23:55Z

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

New page

This API provides a list of all currently configured users.

===Resource URL===
<pre>http://valt.example.com/api/v3/admin/users</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="6"|data
|-
|
|colspan="5"|The return from this call contains an array of JSON objects.
|-
|
|colspan="4"|'''id'''
|User ID
|-
|
|colspan="4"|'''name'''
|User Name
|-
|
|colspan="4"|'''display_name'''
|User Display Name
|-
|
|colspan="4"|'''user_group'''
|User Display Name
|-
|
|
|colspan="3"|'''id'''
|User Group ID
|-
|
|
|colspan="3"|'''name'''
|User Group name
|-
|
|colspan="4"|'''card_number'''
|RFID Card Number or PIN Code for Keypad
|-
|-
|
|colspan="4"|'''video_access'''
|User Display Name
|-
|
|
|colspan="3"|'''user_groups'''
|
|-
|
|
|
|colspan="2"|'''id'''
|User Group ID
|-
|
|
|
|colspan="2"|'''name'''
|User Group Name
|-
|
|
|
|colspan="2"|'''users'''
|
|-
|
|
|
|
|'''id'''
|User ID
|-
|
|
|
|
|'''name'''
|User Name
|}

==Examples==
===Request===
<pre>https://ivstest1.ad.ipivs.com/api/v3/admin/users?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":[
{
"id": 1,
"name": "admin",
"display_name": null,
"user_group":{"id": 1, "name": "Administrators"},
"card_number": "326577",
"video_access":
{"user_groups":[
{
"id": 1,
"name": "Administrators",
"users":[
{
"id": 1,
"name": "admin"
},
{
"id": 7,
"name": "comma, test,"
}
]
}
},
{
"id": 2,
"name": "fstest2",
"display_name": "fstest2 fstest2",
"user_group":{"id": 1, "name": "Administrators"},
"card_number": null
},
{
"id": 3,
"name": "test",
"display_name": "FStest FSTest",
"user_group":{"id": 1, "name": "Administrators"},
"card_number": null
}
]
}
</nowiki>

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

@@ Line 20: / Line 20: @@
 ==Request Parameters==
 ===Path Parameters===
-No Path Parameters can be passed to this request.
+No path parameters can be passed to this request.
 ===Query Parameters===
@@ Line 42: / Line 42: @@
 ===Body===
 No payloads can be passed to this request.
 ==Response==

@@ Line 13: / Line 13: @@
 |-
 |'''Authentication Required'''
-|Yes
+|Yes (access token as a query parameter)
 |}
-No parameters can be passed to this call.
+==Request Parameters==
 {|class="wikitable"
 !Code
@@ Line 33: / Line 57: @@
 |}
 {|class="wikitable"
 !colspan="6"|data
 |-
@@ Line 112: / Line 136: @@
 |User Name
 |}
 ==Examples==
 ===Request===
 <pre>https://ivstest1.ad.ipivs.com/api/v3/admin/users?access_token=e82632d19c523678fea3d1016c6df9e9</pre>
 ===Successful Response===