List devices in device group
Relative path: /v1/device_groups/{groupUuid}/devices
Return list of devices within [device group].
Info: Lifecycle of membership and devices are uncorrelated: a device can be a member of many arbitrary groups without a device entity knowing that. This is also supported by the fact some systems responsible for device-group membership are autonomous and do not need to update the device state to remember membership.
As an independent service without direct visibility of device management's memory, it only operates with a convenient projection of the device state. CAP theorem applies here.
See: https://learn.microsoft.com/en-us/dotnet/architecture/microservices/architect-microservice-container-applications/distributed-data-management
Info: Example: https://learn.microsoft.com/en-us/connectors/office365groups/#listgroupmembers_response
Query parameters
Name |
Type |
Description |
|---|---|---|
recurseSubgroups |
boolean |
For true, not only devices from the requested [device group] are returned, but also from its subgroups. |
pageSize |
integer |
Limit for pagination purposes. If unspecified or 0, default value is 50. The maximum value is 1000; values above 1000 will be coerced to 1000.
|
pageToken |
string |
Page token of current page. If not given or "", the first page is returned.
|
Parameters in path
Name |
Type |
Required |
Description |
|---|---|---|---|
groupUuid |
string |
Yes |
Reference to [device group] for which members should be listed. Mandatory. |
Responses
Display Schema instead of an Example or vice-versa
Code |
Description |
Example |
Schema |
|---|---|---|---|
200 |
Successful response. |
{
"devices": [
{
"displayName": "string",
"groupUuid": "string",
"uuid": "string"
}
],
"nextPageToken": "string",
"totalSize": 0
} |
{
"$ref": "v1ListMemberDevicesResponse",
"devices": [
{
"$ref": "v1MemberDevice",
"description": "Descriptor of device group member - a device. Info: Groups is an independent microservice from Devices, which implies separate storage. Changes in Device must be replicated into MemberDevices of the same identifier. For more information, refer to: - https://learn.microsoft.com/en-us/dotnet/architecture/microservices/architect-microservice-container-applications/distributed-data-management - https://medium.com/creditorwatch/join-data-among-microservices-1cda360c6c1c",
"displayName": {
"type": "string",
"description": "Name given by user to identify device."
},
"groupUuid": {
"type": "string",
"description": "Reference to [device group] of which the device is member. A device group can contain any device at most once."
},
"uuid": {
"type": "string",
"description": "Unique identifier of the entity. Must be collision free - two identifiers created anywhere in the world must not collide within entity parent scope. Unless a member of aggregate, the entity scope is always global. Although most of the times compliant with RFC 4122: A Universally Unique IDentifier (UUID) URN Namespace, do not rely on it being a RFC UUID. Treat it as an opaque identifier. RFC UUID can be recognized by being formatted according to template xxxxxxxx-xxxx-Mxxx-Nxxx-xxxxxxxxxxxx, as explained on wikipedia. UUID is used for referencing an entity, even across domains. Example: '123e4567-e89b-12d3-a456-426614174000'"
}
}
],
"nextPageToken": {
"type": "string",
"description": "Page token of next page. Empty or '' for the last page. Info: For more information, refer to Paginating Requests in APIs or https://cloud.google.com/apis/design/design_patterns#list_pagination"
},
"totalSize": {
"type": "integer",
"description": "The total count of items in the list irrespective of pagination. Info: One of the standard fields Page_size might differ for every call (it is an input parameter) so the calculation of how many pages there is in total is caller's responsibility.",
"format": "int64"
}
} |
202 |
Response took too long; request cached. Response can be retrieved later using the response-id header. |
null |
[] |
400 |
One of the errors: 1. Bad or missing authorization. 2. Validation error. Invalid argument provided. |
null |
[] |
401 |
Token has expired or is invalid. |
null |
[] |
403 |
Access denied. Check permissions. |
null |
[] |
404 |
Requested resource not found. |
null |
[] |
429 |
Rate limit reached. Try again later. |
null |
[] |
500 |
Internal server failure. Try again later. |
null |
[] |
502 |
Internal server failure. Try again later. |
null |
[] |
503 |
Environment under maintenance. Try again later. |
null |
[] |
504 |
Action took too long; timeout reached |
null |
[] |