REST Resource: devices.deviceUsers

Resource: DeviceUser

Represents a user's use of a Device in the Cloud Identity Devices API.

A DeviceUser is a resource representing a user's use of a Device

JSON representation
{
  "name": string,
  "userEmail": string,
  "managementState": enum (ManagementState),
  "firstSyncTime": string,
  "lastSyncTime": string,
  "userAgent": string,
  "languageCode": string,
  "compromisedState": enum (CompromisedState),
  "passwordState": enum (PasswordState),
  "createTime": string
}
Fields
name

string

Output only. Resource name of the DeviceUser in format: devices/{deviceId}/deviceUsers/{device_user_id}, where device_user_id uniquely identifies a user's use of a device.

userEmail

string

Email address of the user registered on the device.

managementState

enum (ManagementState)

Output only. Management state of the user on the device.

firstSyncTime

string (Timestamp format)

Output only. Most recent time when user registered with this service.

A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".

lastSyncTime

string (Timestamp format)

Output only. Last time when user synced with policies.

A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".

userAgent

string

Output only. User agent on the device for this specific user

languageCode

string

Output only. Default locale used on device, in IETF BCP-47 format.

compromisedState

enum (CompromisedState)

Compromised State of the DeviceUser object

passwordState

enum (PasswordState)

Password state of the DeviceUser object

createTime

string (Timestamp format)

When the user first signed in to the device

A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".

ManagementState

Possible management states of a user on a device.

Enums
MANAGEMENT_STATE_UNSPECIFIED Default value. This value is unused.
WIPING This user's data and profile is being removed from the device.
WIPED This user's data and profile is removed from the device.
APPROVED User is approved to access data on the device.
BLOCKED User is blocked from accessing data on the device.
PENDING_APPROVAL User is awaiting approval.
UNENROLLED User is unenrolled from Advanced Windows Management, but the Windows account is still intact.

CompromisedState

Describes whether the DeviceUser object is compromised or not.

Enums
COMPROMISED_STATE_UNSPECIFIED Compromised state of Device User account is unknown or unspecified.
COMPROMISED Device User Account is compromised.
NOT_COMPROMISED Device User Account is not compromised.

PasswordState

The password state of the object

Enums
PASSWORD_STATE_UNSPECIFIED Password state not set.
PASSWORD_SET Password set in object.
PASSWORD_NOT_SET Password not set in object.

Methods

approve

Approves device to access user data.

block

Blocks device from accessing user data

cancelWipe

Cancels an unfinished user account wipe.

delete

Deletes the specified DeviceUser.

get

Retrieves the specified DeviceUser

list

Lists/Searches DeviceUsers.

lookup

Looks up resource names of the DeviceUsers associated with the caller's credentials, as well as the properties provided in the request.

wipe

Wipes the user's account on a device.