REST Resource: customers.profiles

Resource: ChromeBrowserProfile

A representation of a Chrome browser profile.

JSON representation 
{
  "name": string,
  "profileId": string,
  "profilePermanentId": string,
  "displayName": string,
  "userId": string,
  "userEmail": string,
  "lastActivityTime": string,
  "lastPolicyFetchTime": string,
  "lastPolicySyncTime": string,
  "lastStatusReportTime": string,
  "deviceInfo": {
    object (DeviceInfo)
  },
  "osPlatformType": string,
  "osVersion": string,
  "browserVersion": string,
  "browserChannel": string,
  "annotatedLocation": string,
  "annotatedUser": string,
  "attestationCredential": {
    object (AttestationCredential)
  },
  "reportingData": {
    object (ReportingData)
  },
  "etag": string,
  "identityProvider": enum (IdentityProvider),
  "firstEnrollmentTime": string,
  "affiliationState": enum (AffiliationState),
  "policyCount": string,
  "extensionCount": string,
  "osPlatformVersion": string
}
Fields
name

string

Identifier. Format: customers/{customer_id}/profiles/{profilePermanentId}
profileId

string

Output only. Chrome client side profile ID.
profilePermanentId

string

Output only. Profile permanent ID is the unique identifier of a profile within one customer.
displayName

string

Output only. Profile display name set by client.
userId

string

Output only. Unique Directory API ID of the user that can be used in Admin SDK Users API.
userEmail

string

Output only. Email address of the user to which the profile belongs.
lastActivityTime

string (Timestamp format)

Output only. Timestamp of the latest activity by the profile.

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".
lastPolicyFetchTime

string (Timestamp format)

Output only. Timestamp of the latest policy fetch by the profile.

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".
lastPolicySyncTime

string (Timestamp format)

Output only. Timestamp of the latest policy sync by the profile.

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".
lastStatusReportTime

string (Timestamp format)

Output only. Timestamp of the latest status report by the profile.

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".
deviceInfo

object (DeviceInfo)

Output only. Basic information of the device on which the profile exists. This information is only available for the affiliated profiles.
osPlatformType

string

Output only. OS platform of the device on which the profile exists.
osVersion

string

Output only. OS version of the device on which the profile exists.
browserVersion

string

Output only. Version of the browser on which the profile exists.
browserChannel

string

Output only. Channel of the browser on which the profile exists.
annotatedLocation

string

Optional. Location of the profile annotated by the admin.
annotatedUser

string

Optional. User of the profile annotated by the admin.
attestationCredential

object (AttestationCredential)

Output only. Attestation credential information of the profile.
reportingData

object (ReportingData)

Output only. Detailed reporting data of the profile. This information is only available when the profile reporting policy is enabled.
etag

string

Output only. Etag of this ChromeBrowserProfile resource. This etag can be used with UPDATE operation to ensure consistency.
identityProvider

enum (IdentityProvider)

Output only. Identify provider of the profile.
firstEnrollmentTime

string (Timestamp format)

Output only. Timestamp of the first enrollment of the profile.

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".
affiliationState

enum (AffiliationState)

Output only. The specific affiliation state of the profile.
policyCount

string (int64 format)

Output only. Number of policies applied on the profile.
extensionCount

string (int64 format)

Output only. Number of extensions installed on the profile.
osPlatformVersion

string

Output only. Major OS version of the device on which the profile exists. (i.e. Windows 10)

DeviceInfo

Information of a device that runs a Chrome browser profile.

JSON representation 
{
  "deviceType": enum (DeviceType),
  "affiliatedDeviceId": string,
  "machine": string,
  "hostname": string
}
Fields
deviceType

enum (DeviceType)

Output only. Type of the device on which the profile exists.
affiliatedDeviceId

string

Output only. Device ID that identifies the affiliated device on which the profile exists. If the device type is CHROME_BROWSER, then this represents a unique Directory API ID of the device that can be used in Admin SDK Browsers API.
machine

string

Output only. Machine name of the device on which the profile exists. On platforms which do not report the machine name (currently iOS and Android) this is instead set to the browser's deviceId - but note that this is a different deviceId than the |affiliatedDeviceId|.
hostname

string

Output only. Hostname of the device on which the profile exists.

DeviceType

Possible types of a device.

Enums
DEVICE_TYPE_UNSPECIFIED Represents an unspecified device type.
CHROME_BROWSER Represents a Chrome browser device.

AttestationCredential

Information of public key associated with a Chrome browser profile.

JSON representation 
{
  "keyType": enum (KeyType),
  "keyTrustLevel": enum (KeyTrustLevel),
  "publicKey": string,
  "keyRotationTime": string
}
Fields
keyType

enum (KeyType)

Output only. Type of the public key.
keyTrustLevel

enum (KeyTrustLevel)

Output only. Trust level of the public key.
publicKey

string (bytes format)

Output only. Value of the public key.

A base64-encoded string.
keyRotationTime

string (Timestamp format)

Output only. Latest rotation timestamp of the public key rotation.

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".

KeyType

Possible types of a public key.

Enums
KEY_TYPE_UNSPECIFIED Represents an unspecified public key type.
RSA_KEY Represents a RSA key.
EC_KEY Represents an EC key.

KeyTrustLevel

Possible trust levels of a public key.

Enums
KEY_TRUST_LEVEL_UNSPECIFIED Represents an unspecified public key trust level.
CHROME_BROWSER_HW_KEY Represents a HW key.
CHROME_BROWSER_OS_KEY Represents an OS key.

ReportingData

Reporting data of a Chrome browser profile.

JSON representation 
{
  "browserExecutablePath": string,
  "installedBrowserVersion": string,
  "profilePath": string,
  "extensionData": [
    {
      object (ExtensionData)
    }
  ],
  "policyData": [
    {
      object (PolicyData)
    }
  ],
  "extensionPolicyData": [
    {
      object (ExtensionPolicyData)
    }
  ]
}
Fields
browserExecutablePath

string

Output only. Executable path of the installed Chrome browser. A valid path is included only in affiliated profiles.
installedBrowserVersion

string

Output only. Updated version of a browser, if it is different from the active browser version.
profilePath

string

Output only. Path of the profile. A valid path is included only in affiliated profiles.
extensionData[]

object (ExtensionData)

Output only. Information of the extensions installed on the profile.
policyData[]

object (PolicyData)

Output only. Information of the policies applied on the profile.
extensionPolicyData[]

object (ExtensionPolicyData)

Output only. Information of the policies applied on the extensions.

ExtensionData

Information of an extension installed on a Chrome browser profile.

JSON representation 
{
  "extensionId": string,
  "version": string,
  "permissions": [
    string
  ],
  "name": string,
  "description": string,
  "extensionType": enum (ExtensionType),
  "homepageUri": string,
  "installationType": enum (InstallationType),
  "manifestVersion": integer,
  "isDisabled": boolean,
  "isWebstoreExtension": boolean
}
Fields
extensionId

string

Output only. ID of the extension.
version

string

Output only. Version of the extension.
permissions[]

string

Output only. Permissions requested by the extension.
name

string

Output only. Name of the extension.
description

string

Output only. Description of the extension.
extensionType

enum (ExtensionType)

Output only. Type of the extension.
homepageUri

string

Output only. The URL of the homepage of the extension.
installationType

enum (InstallationType)

Output only. Installation type of the extension.
manifestVersion

integer

Output only. Manifest version of the extension.
isDisabled

boolean

Output only. Represents whether the user disabled the extension.
isWebstoreExtension

boolean

Output only. Represents whether the extension is from the webstore.

ExtensionType

Possible types of an extension.

Enums
EXTENSION_TYPE_UNSPECIFIED Represents an unspecified extension type.
EXTENSION Represents an extension.
APP Represents an app.
THEME Represents a theme.
HOSTED_APP Represents a hosted app.

InstallationType

Possible installation types of an extension.

Enums
INSTALLATION_TYPE_UNSPECIFIED Represents an unspecified installation type.
MULTIPLE Represents instances of the extension having mixed installation types.
NORMAL Represents a normal installation type.
ADMIN Represents an installation by admin.
DEVELOPMENT Represents a development installation type.
SIDELOAD Represents a sideload installation type.
OTHER Represents an installation type that is not covered in the other options.

PolicyData

Information of a policy applied on a Chrome browser profile.

JSON representation 
{
  "source": enum (PolicySource),
  "name": string,
  "value": string,
  "conflicts": [
    {
      object (ConflictingPolicyData)
    }
  ],
  "error": string
}
Fields
source

enum (PolicySource)

Output only. Source of the policy.
name

string

Output only. Name of the policy.
value

string

Output only. Value of the policy.
conflicts[]

object (ConflictingPolicyData)

Output only. Conflicting policy information.
error

string

Output only. Error message of the policy, if any.

PolicySource

Possible sources of a policy.

Enums
POLICY_SOURCE_UNSPECIFIED Represents an unspecified policy source.
MACHINE_PLATFORM Represents a machine level platform policy.
USER_PLATFORM Represents a user level platform policy.
MACHINE_LEVEL_USER_CLOUD Represents a machine level user cloud policy.
USER_CLOUD Represents a user level cloud policy.
MACHINE_MERGED Represents a machine level merged policy.

ConflictingPolicyData

Information of conflicting policy applied on a Chrome browser profile.

JSON representation 
{
  "source": enum (PolicySource)
}
Fields
source

enum (PolicySource)

Output only. Source of the policy.

ExtensionPolicyData

Information of the policies applied on an extension.

JSON representation 
{
  "extensionId": string,
  "extensionName": string,
  "policyData": [
    {
      object (PolicyData)
    }
  ]
}
Fields
extensionId

string

Output only. ID of the extension.
extensionName

string

Output only. Name of the extension.
policyData[]

object (PolicyData)

Output only. Information of the policies applied on the extension.

IdentityProvider

Possible identity providers of a profile.

Enums
IDENTITY_PROVIDER_UNSPECIFIED Represents an unspecified identity provider.
GOOGLE_IDENTITY_PROVIDER Represents a Google identity provider.
EXTERNAL_IDENTITY_PROVIDER Represents an external identity provider.

AffiliationState

The specific affiliation state for the profile. New values may be added in the future.

Enums
AFFILIATION_STATE_UNSPECIFIED Unspecified affiliation state.
UNAFFILIATED_GENERIC Unaffiliated - but we do not have the details for the type of unaffiliated profile.
PROFILE_ONLY Unaffiliated - A managed profile that appears on a totally unamanaged browser.
UNAFFILIATED_LOCAL_MACHINE Unaffiliated - A managed profile that appears on a machine that is locally managed by a different organization (through platform management mechanisms like GPO).
UNAFFILIATED_CLOUD_MACHINE Unaffiliated - A managed profile that appears on a managed browser that is cloud managed by a different organization (using Chrome Browser Cloud Management).
AFFILIATED_CLOUD_MANAGED Affiliated - Both the profile and the managed browser are managed by the same organization.

Methods

delete

 Deletes the data collected from a Chrome browser profile.

get

 Gets a Chrome browser profile with customer ID and profile permanent ID.

list

 Lists Chrome browser profiles of a customer based on the given search and sorting criteria.