Difference between revisions of "API List Users"
IVSWikiBlue (talk | contribs) (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...") |
IVSWikiBlue (talk | contribs) |
||
| Line 13: | Line 13: | ||
|- | |- | ||
|'''Authentication Required''' | |'''Authentication Required''' | ||
| − | |Yes | + | |Yes (access token as a query parameter) |
|} | |} | ||
| + | ''Authentication is performed with an access token obtained from the [[API Authentication]] request.'' | ||
| − | |||
| − | No | + | ==Request Parameters== |
| + | ===Path Parameters=== | ||
| + | No Path Parameters can be passed to this request. | ||
| + | |||
| + | ===Query Parameters=== | ||
| + | {|class="wikitable" | ||
| + | !Name | ||
| + | !Type | ||
| + | !Description | ||
| + | |- | ||
| + | |'''access_token''' | ||
| + | |string | ||
| + | |Token used for authentication. Must be appended to the request URL. | ||
| + | |- | ||
| + | |'''cardNumber''' | ||
| + | |string | ||
| + | |User's Card Number. This is an optional filter parameter. | ||
| + | |} | ||
| + | |||
| + | ===Headers=== | ||
| + | No headers are required for this request. | ||
| + | |||
| + | ===Body=== | ||
| + | No payloads can be passed to this request. | ||
| − | |||
| + | ==Response== | ||
| + | ===HTTP Code=== | ||
{|class="wikitable" | {|class="wikitable" | ||
!Code | !Code | ||
| Line 33: | Line 57: | ||
|} | |} | ||
| + | ===JSON Body=== | ||
{|class="wikitable" | {|class="wikitable" | ||
| − | |||
!colspan="6"|data | !colspan="6"|data | ||
|- | |- | ||
| Line 112: | Line 136: | ||
|User Name | |User Name | ||
|} | |} | ||
| + | |||
==Examples== | ==Examples== | ||
===Request=== | ===Request=== | ||
<pre>https://ivstest1.ad.ipivs.com/api/v3/admin/users?access_token=e82632d19c523678fea3d1016c6df9e9</pre> | <pre>https://ivstest1.ad.ipivs.com/api/v3/admin/users?access_token=e82632d19c523678fea3d1016c6df9e9</pre> | ||
| + | <pre>https://ivstest1.ad.ipivs.com/api/v3/admin/users?access_token=e82632d19c523678fea3d1016c6df9e9&cardNumber=12345</pre> | ||
===Successful Response=== | ===Successful Response=== | ||
Revision as of 11:14, 10 June 2025
This API provides a list of all currently configured users.
Contents
Resource URL
http://valt.example.com/api/v3/admin/users
Resource Information
| Method | GET |
| Response Type | JSON |
| Authentication Required | Yes (access token as a query parameter) |
Authentication is performed with an access token obtained from the API Authentication request.
Request Parameters
Path Parameters
No Path Parameters can be passed to this request.
Query Parameters
| Name | Type | Description |
|---|---|---|
| access_token | string | Token used for authentication. Must be appended to the request URL. |
| cardNumber | string | User's Card Number. This is an optional filter parameter. |
Headers
No headers are required for this request.
Body
No payloads can be passed to this request.
Response
HTTP Code
| Code | Reason |
|---|---|
| 200 | Request Successful |
| 401 | Unauthorized |
JSON Body
| data | |||||
|---|---|---|---|---|---|
| The return from this call contains an array of JSON objects. | |||||
| id | User ID | ||||
| name | User Name | ||||
| display_name | User Display Name | ||||
| user_group | User Display Name | ||||
| id | User Group ID | ||||
| name | User Group name | ||||
| card_number | RFID Card Number or PIN Code for Keypad | ||||
| video_access | User Display Name | ||||
| user_groups | |||||
| id | User Group ID | ||||
| name | User Group Name | ||||
| users | |||||
| id | User ID | ||||
| name | User Name | ||||
Examples
Request
https://ivstest1.ad.ipivs.com/api/v3/admin/users?access_token=e82632d19c523678fea3d1016c6df9e9
https://ivstest1.ad.ipivs.com/api/v3/admin/users?access_token=e82632d19c523678fea3d1016c6df9e9&cardNumber=12345
Successful Response
Sample response is shown with line breaks to make it more readable. Actual responses will not include line breaks.
"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
}
]
}
Failure Response
{"error":{"code":401,"message":"No API key provided"}}
