getUsersByProperty
- Home
- Users & Groups
- SvcUserProperty
- getUsersByProperty
getUsersByProperty
Fetches all users with the given property as identified by the given type, name and, optionally, value.
Parameters
| Name | Description |
| type required | The property type. Acts as a namespace. |
| name required | The property name. Along with the type, this identifies the property. |
| value optional | The property value. |
| nodeID optional | The network’s unique identifier. |
| output optional | The response output format. Accepts JSON and XML. |
Request Syntax
| https://services.onesite.com/rest/svcUserProperty?action=getUsersByProperty&nodeID=188234&type=external&name=external_id&value=12345&devkey=[devkey] |
JSON Response
|
1 2 3 4 5 6 7 8 9 10 11 |
{ "service":"svcUserProperty", "action":"getUsersByProperty", "code":1, "message":"Success!", "page":1, "total":1, "item":[ "229928503" ] } |
Service Information
| Service | svcUserProperty |
| Method | getUsersByProperty |
| Type | REST |
| Response Types | JSON, XML |