Device

import type { Device } from "https://googleapis.deno.dev/v1/androidmanagement:v1.ts";

A device owned by an enterprise. Unless otherwise noted, all fields are read-only and can't be modified by enterprises.devices.patch.

interface Device {

apiLevel?: number;

applicationReports?: ApplicationReport[];

appliedPasswordPolicies?: PasswordRequirements[];

appliedPolicyName?: string;

appliedPolicyVersion?: bigint;

appliedState?:

| "DEVICE_STATE_UNSPECIFIED"

| "ACTIVE"

| "DISABLED"

| "DELETED"

| "PROVISIONING"

| "LOST"

| "PREPARING_FOR_MIGRATION";

commonCriteriaModeInfo?: CommonCriteriaModeInfo;

deviceSettings?: DeviceSettings;

disabledReason?: UserFacingMessage;

displays?: Display[];

readonly dpcMigrationInfo?: DpcMigrationInfo;

enrollmentTime?: Date;

enrollmentTokenData?: string;

enrollmentTokenName?: string;

hardwareInfo?: HardwareInfo;

hardwareStatusSamples?: HardwareStatus[];

lastPolicyComplianceReportTime?: Date;

lastPolicySyncTime?: Date;

lastStatusReportTime?: Date;

managementMode?: "MANAGEMENT_MODE_UNSPECIFIED" | "DEVICE_OWNER" | "PROFILE_OWNER";

memoryEvents?: MemoryEvent[];

memoryInfo?: MemoryInfo;

name?: string;

networkInfo?: NetworkInfo;

nonComplianceDetails?: NonComplianceDetail[];

ownership?: "OWNERSHIP_UNSPECIFIED" | "COMPANY_OWNED" | "PERSONALLY_OWNED";

policyCompliant?: boolean;

policyName?: string;

powerManagementEvents?: PowerManagementEvent[];

previousDeviceNames?: string[];

securityPosture?: SecurityPosture;

softwareInfo?: SoftwareInfo;

state?:

| "DEVICE_STATE_UNSPECIFIED"

| "ACTIVE"

| "DISABLED"

| "DELETED"

| "PROVISIONING"

| "LOST"

| "PREPARING_FOR_MIGRATION";

systemProperties?: {

[key: string]: string;

};

user?: User;

userName?: string;

}

§Properties

apiLevel?: number

[src]

The API level of the Android platform version running on the device.

applicationReports?: ApplicationReport[]

[src]

Reports for apps installed on the device. This information is only available when application_reports_enabled is true in the device's policy.

appliedPasswordPolicies?: PasswordRequirements[]

[src]

The password requirements currently applied to the device. The applied requirements may be slightly different from those specified in passwordPolicies in some cases. fieldPath is set based on passwordPolicies.

appliedPolicyName?: string

[src]

The name of the policy currently applied to the device.

appliedPolicyVersion?: bigint

[src]

The version of the policy currently applied to the device.

[src]

The state currently applied to the device.

commonCriteriaModeInfo?: CommonCriteriaModeInfo

[src]

Information about Common Criteria Mode—security standards defined in the Common Criteria for Information Technology Security Evaluation (https://www.commoncriteriaportal.org/) (CC).This information is only available if statusReportingSettings.commonCriteriaModeEnabled is true in the device's policy.

deviceSettings?: DeviceSettings

[src]

Device settings information. This information is only available if deviceSettingsEnabled is true in the device's policy.

disabledReason?: UserFacingMessage

[src]

If the device state is DISABLED, an optional message that is displayed on the device indicating the reason the device is disabled. This field can be modified by a patch request.

displays?: Display[]

[src]

Detailed information about displays on the device. This information is only available if displayInfoEnabled is true in the device's policy.

readonly dpcMigrationInfo?: DpcMigrationInfo

[src]

Output only. Information related to whether this device was migrated from being managed by another Device Policy Controller (DPC).

enrollmentTime?: Date

[src]

The time of device enrollment.

enrollmentTokenData?: string

[src]

If the device was enrolled with an enrollment token with additional data provided, this field contains that data.

enrollmentTokenName?: string

[src]

If the device was enrolled with an enrollment token, this field contains the name of the token.

hardwareInfo?: HardwareInfo

[src]

Detailed information about the device hardware.

hardwareStatusSamples?: HardwareStatus[]

[src]

Hardware status samples in chronological order. This information is only available if hardwareStatusEnabled is true in the device's policy.

lastPolicyComplianceReportTime?: Date

[src]

Deprecated.

lastPolicySyncTime?: Date

[src]

The last time the device fetched its policy.

lastStatusReportTime?: Date

[src]

The last time the device sent a status report.

managementMode?: "MANAGEMENT_MODE_UNSPECIFIED" | "DEVICE_OWNER" | "PROFILE_OWNER"

[src]

The type of management mode Android Device Policy takes on the device. This influences which policy settings are supported.

memoryEvents?: MemoryEvent[]

[src]

Events related to memory and storage measurements in chronological order. This information is only available if memoryInfoEnabled is true in the device's policy.Events are retained for a certain period of time and old events are deleted.

memoryInfo?: MemoryInfo

[src]

Memory information: contains information about device memory and storage.

name?: string

[src]

The name of the device in the form enterprises/{enterpriseId}/devices/{deviceId}.

networkInfo?: NetworkInfo

[src]

Device network information. This information is only available if networkInfoEnabled is true in the device's policy.

nonComplianceDetails?: NonComplianceDetail[]

[src]

Details about policy settings that the device is not compliant with.

ownership?: "OWNERSHIP_UNSPECIFIED" | "COMPANY_OWNED" | "PERSONALLY_OWNED"

[src]

Ownership of the managed device.

policyCompliant?: boolean

[src]

Whether the device is compliant with its policy.

policyName?: string

[src]

The name of the policy applied to the device, in the form enterprises/{enterpriseId}/policies/{policyId}. If not specified, the policy_name for the device's user is applied. This field can be modified by a patch request. You can specify only the policyId when calling enterprises.devices.patch, as long as the policyId doesn’t contain any slashes. The rest of the policy name is inferred.

powerManagementEvents?: PowerManagementEvent[]

[src]

Power management events on the device in chronological order. This information is only available if powerManagementEventsEnabled is true in the device's policy.

previousDeviceNames?: string[]

[src]

If the same physical device has been enrolled multiple times, this field contains its previous device names. The serial number is used as the unique identifier to determine if the same physical device has enrolled previously. The names are in chronological order.

securityPosture?: SecurityPosture

[src]

Device's security posture value that reflects how secure the device is.

softwareInfo?: SoftwareInfo

[src]

Detailed information about the device software. This information is only available if softwareInfoEnabled is true in the device's policy.

[src]

The state to be applied to the device. This field can be modified by a patch request. Note that when calling enterprises.devices.patch, ACTIVE and DISABLED are the only allowable values. To enter the device into a DELETED state, call enterprises.devices.delete.

systemProperties?: {

[key: string]: string;

}

[src]

Map of selected system properties name and value related to the device. This information is only available if systemPropertiesEnabled is true in the device's policy.

user?: User

[src]

The user who owns the device.

userName?: string

[src]

The resource name of the user that owns this device in the form enterprises/{enterpriseId}/users/{userId}.