Method: devices.deviceUsers.list

Lists/Searches DeviceUsers.

HTTP request

GET https://cloudidentity.googleapis.com/v1/{parent=devices/*}/deviceUsers

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
parent

string

Required. To list all DeviceUsers, set this to "devices/-". To list all DeviceUsers owned by a device, set this to the resource name of the device. Format: devices/{device}

Query parameters

Parameters
customer

string

Required. Resource name of the customer. If you're using this API for your own organization, use customers/my_customer If you're using this API to manage another organization, use customers/{customer_id}, where customer_id is the customer to whom the device belongs.

filter

string

Optional. Additional restrictions when fetching list of devices. HC article

pageSize

integer

Optional. The maximum number of DeviceUsers to return. If unspecified, at most 5 DeviceUsers will be returned. The maximum value is 20; values above 20 will be coerced to 20.

pageToken

string

Optional. A page token, received from a previous deviceUsers.list call. Provide this to retrieve the subsequent page.

When paginating, all other parameters provided to ListBooks must match the call that provided the page token.

orderBy

string

Optional. Order specification for devices in the response.

Request body

The request body must be empty.

Response body

If successful, the response body contains data with the following structure:

Response message that is returned from the deviceUsers.list method.

JSON representation
{
  "deviceUsers": [
    {
      object (DeviceUser)
    }
  ],
  "nextPageToken": string
}
Fields
deviceUsers[]

object (DeviceUser)

Devices meeting the list restrictions.

nextPageToken

string

Token to retrieve the next page of results. Empty if there are no more results.

Authorization Scopes

Requires one of the following OAuth scopes:

  • https://www.googleapis.com/auth/cloud-identity.devices.readonly
  • https://www.googleapis.com/auth/cloud-identity.devices
  • https://www.googleapis.com/auth/cloud-identity

For more information, see the Authentication Overview.