Welcome What's new in Chrome extensions Getting started API Reference Samples

chrome.enterprise.deviceAttributes

  • Description

    Use the chrome.enterprise.deviceAttributes API to read device attributes. Note: This API is only available to extensions force-installed by enterprise policy.

  • Permissions
    enterprise.deviceAttributes
  • Availability
    Chrome 46+

Note: This API is only for extensions pre-installed by policy.

Summary

Methods

getDeviceAnnotatedLocation

chrome.enterprise.deviceAttributes.getDeviceAnnotatedLocation(
  callback?: function,
)
Promise Chrome 66+

Fetches the administrator-annotated Location. If the current user is not affiliated or no Annotated Location has been set by the administrator, returns an empty string.

Parameters

  • callback

    function optional

    The callback parameter looks like: (annotatedLocation: string) => void

    • annotatedLocation

      string

Returns

  • Promise<string>

    Pending

    This only returns a Promise when the callback parameter is not specified, and with MV3+. The type inside the Promise is the same as the 1st argument to callback.

getDeviceAssetId

chrome.enterprise.deviceAttributes.getDeviceAssetId(
  callback?: function,
)
Promise Chrome 66+

Fetches the administrator-annotated Asset Id. If the current user is not affiliated or no Asset Id has been set by the administrator, returns an empty string.

Parameters

  • callback

    function optional

    The callback parameter looks like: (assetId: string) => void

    • assetId

      string

Returns

  • Promise<string>

    Pending

    This only returns a Promise when the callback parameter is not specified, and with MV3+. The type inside the Promise is the same as the 1st argument to callback.

getDeviceHostname

chrome.enterprise.deviceAttributes.getDeviceHostname(
  callback?: function,
)
Promise Chrome 82+

Fetches the device's hostname as set by DeviceHostnameTemplate policy. If the current user is not affiliated or no hostname has been set by the enterprise policy, returns an empty string.

Parameters

  • callback

    function optional

    The callback parameter looks like: (hostname: string) => void

    • hostname

      string

Returns

  • Promise<string>

    Pending

    This only returns a Promise when the callback parameter is not specified, and with MV3+. The type inside the Promise is the same as the 1st argument to callback.

getDeviceSerialNumber

chrome.enterprise.deviceAttributes.getDeviceSerialNumber(
  callback?: function,
)
Promise Chrome 66+

Fetches the device's serial number. Please note the purpose of this API is to administrate the device (e.g. generating Certificate Sign Requests for device-wide certificates). This API may not be used for tracking devices without the consent of the device's administrator. If the current user is not affiliated, returns an empty string.

Parameters

  • callback

    function optional

    The callback parameter looks like: (serialNumber: string) => void

    • serialNumber

      string

Returns

  • Promise<string>

    Pending

    This only returns a Promise when the callback parameter is not specified, and with MV3+. The type inside the Promise is the same as the 1st argument to callback.

getDirectoryDeviceId

chrome.enterprise.deviceAttributes.getDirectoryDeviceId(
  callback?: function,
)
Promise

Fetches the value of the device identifier of the directory API, that is generated by the server and identifies the cloud record of the device for querying in the cloud directory API. If the current user is not affiliated, returns an empty string.

Parameters

  • callback

    function optional

    The callback parameter looks like: (deviceId: string) => void

    • deviceId

      string

Returns

  • Promise<string>

    Pending

    This only returns a Promise when the callback parameter is not specified, and with MV3+. The type inside the Promise is the same as the 1st argument to callback.