Retrieve users for an asset group

get

/assetMonitoring/clientapi/v2/groups/{asset-group-id}/users

Get list of assets, identified by asset group ID

Request

Path Parameters
Query Parameters
Back to Top

Response

Supported Media Types

200 Response

Successfully processed.
Body ()
Root Schema : UserImpl_receive_list
Type: object
Show Source
Nested Schema : items
Type: array
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : emailAddresses
Type: array
Property description was not set
Show Source
Nested Schema : phoneNumbers
Type: array
Property description was not set
Show Source
Nested Schema : roles
Type: array
Property description was not set
Show Source
Nested Schema : EmailContact_receive
Type: object
Show Source
Nested Schema : PhoneContact_receive
Type: object
Show Source

401 Response

Unauthorized. The request requires user authentication.

404 Response

Not Found. The server has not found anything matching the Request-URI. No indication is given of whether the condition is temporary or permanent.

406 Response

Request Not Acceptable. The resource identified by the request is only capable of generating response entities which have content characteristics not acceptable according to the accept headers sent in the request.
Back to Top

Examples

curl -X GET 
   -u <username>:<password>
   -H 'Accept: application/json'
   https://iotserver/assetMonitoring/clientapi/v2/groups/{asset-group-id}/users

Example of Response Body

The following example shows the content of the response body in JSON format:


{
"count":2,
"hasMore":false,
"items":[
{
"email":"Property description was not set",
"emailAddresses":[
{
"primary":false,
"type":"One of [WORK, HOME, RECOVERY, OTHER].",
"value":"Property description was not set",
"verified":false
}
],
"firstName":"Property description was not set",
"id":"1f9277b4350a-4bc0",
"internalUser":false,
"lastName":"Property description was not set",
"name":"Property description was not set",
"phoneNumbers":[
{
"primary":false,
"type":"One of [WORK, HOME, RECOVERY, OTHER, MOBILE, FAX, PAGER].",
"value":"Property description was not set",
"verified":false
}
],
"roles":[
"roles_1",
"roles_2",
"roles_3"
]
},
{
"email":"Property description was not set",
"emailAddresses":[
{
"primary":false,
"type":"One of [WORK, HOME, RECOVERY, OTHER].",
"value":"Property description was not set",
"verified":false
}
],
"firstName":"Property description was not set",
"id":"2ea144805ff4-2859",
"internalUser":false,
"lastName":"Property description was not set",
"name":"Property description was not set",
"phoneNumbers":[
{
"primary":false,
"type":"One of [WORK, HOME, RECOVERY, OTHER, MOBILE, FAX, PAGER].",
"value":"Property description was not set",
"verified":false
}
],
"roles":[
"roles_1",
"roles_2",
"roles_3"
]
}
],
"limit":10,
"links":[
{
"href":"https://iotserver/assetMonitoring/clientapi/version/resource/path",
"rel":"self"
},
{
"href":"https://iotserver/assetMonitoring/clientapi/version/resource/path",
"rel":"canonical"
}
],
"offset":0
}



Complete cURL Example

The following example shows a complete cURL command that you can use to perform the described operation:

curl -X GET 
   -u <username>:<password>
   -H 'Accept: application/json'
   https://iotserver/assetMonitoring/clientapi/v2/groups/{asset-group-id}/users



Note that in the request, https://iotserver will be replaced by the name and port of your assigned IoT Cloud Service instance. The format of the Cloud Service instance is https://myinstance-myidentitydomain.iot.us.oraclecloud.com and the default port is 443.
Back to Top