Admin Users APIs are highly configurable and require object identification prior to use.
GET users/myLocations
Get/Fetch User Location.
“If latitude and longitude are supplied as parameters, then API will attempt to calculate each location distance in meters.”
| Example |
curl --request GET \ --url https://hostname/users/myLocations?latitude=51.5072&longitude=0.1276 \ --header 'content-type: application/json' \ --header 'x-auth-token: 555-555-1212' \ --header 'x-auth-user: joe.user' \ |
| latitude (Optional Param) | Requestor geoposition latitude |
| longitude (Optional Param) | Requestor geoposition longitude |
GET users/userModules
Get/Fetch User Modules.
| Example |
curl --request GET \ --url https://hostname/users/userModules?emitDict=true \ --header 'content-type: application/json' \ --header 'x-auth-token: 555-555-1212' \ --header 'x-auth-user: joe.user' \ |
| emitDict (boolean) “true|false” | If true, returns dictionary instead of flat array |
| Response (Example) |
"data": {
"DOWNLOAD": true,
"SUPPORT": true,
"PROFILE": true,
"CREATE": true,
"ACTION_VIEW": true,
"REFLECT": true,
"REPORTS": true,
"MISSION_CONTROL": true,
"ADMIN": true,
"WEB_APPROVER": true,
"501": true,
"2000": true,
"500": true,
"1000": true,
"503": true,
"3000": true,
"502": true,
"4000": true
},
|
GET /search/find
Search Location or User.
| Example |
curl --request GET \ --url 'https://yourhostname.vfrc.io/search/find?so=assetIdentifiers&sv=111&sc=serialized_id&colNames=iat_asset_id%2Cserialized_id%2Clabel%2Cname%2Clong_name%2Cis_global%2Casset_type_id%2Ccreated_by_user_id%2Ci_date_created' \ --header 'Content-Type: application/x-www-form-urlencoded' \ --header 'User-Agent: insomnia/9.0.0' \ --header 'X-Auth-Token: 22a0a69c-1474-11ef-a720-f23c9360ff8d' \ --header 'X-Auth-User: username' \ --data so=assetIdentifiers \ --data sv=111 \ --data sc=serialized_id \ --data offset=0 \ --data limit=100 \ --data 'colNames=serialized_id,iat_asset_name' \ --data orderBy=serialized_id |
| so | Searchable Object |
| sc | A single Searchable Column name |
| sv | Searchable Value symbol >= 3 characters |
| colNames | A comma-separated list of column names to limit the output to. |
| orderBy | A column name to order the output by. |
| limit | An unsigned integer representing the number of records to provide after the offset. |
| offset | An unsigned integer representing the number of records to ignore. |