GOgoogle
customers

GET /v1/customers/{customersId}/profiles

Changed on

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

Request

  • Base URL
    https://chromemanagement.googleapis.com
  • URL
    https://chromemanagement.googleapis.com/v1/customers/{customersId}/profiles
  • Auth
    • OAuth 2 and OAuth 2
      Implicit: https://accounts.google.com/o/oauth2/auth
      Scopes: https://www.googleapis.com/auth/chrome.management.profiles
      Authorization code: https://accounts.google.com/o/oauth2/auth
      Token URL: https://accounts.google.com/o/oauth2/token scopes: https://www.googleapis.com/auth/chrome.management.profiles
    • or OAuth 2 and OAuth 2
      Implicit: https://accounts.google.com/o/oauth2/auth
      Scopes: https://www.googleapis.com/auth/chrome.management.profiles.readonly
      Authorization code: https://accounts.google.com/o/oauth2/auth
      Token URL: https://accounts.google.com/o/oauth2/token scopes: https://www.googleapis.com/auth/chrome.management.profiles.readonly

Path parameters

customersIdstring required

Query parameters

filterstring

Optional. The filter used to filter profiles. The following fields can be used in the filter: - profile_id - display_name - user_email - last_activity_time - last_policy_sync_time - last_status_report_time - first_enrollment_time - os_platform_type - os_version - browser_version - browser_channel - policy_count - extension_count - identity_provider - affiliation_state - os_platform_version - ouId Any of the above fields can be used to specify a filter, and filtering by multiple fields is supported with AND operator. String type fields and enum type fields support '=' and '!=' operators. The integer type and the timestamp type fields support '=', '!=', '<', '>', '<=' and '>=' operators. Timestamps expect an RFC-3339 formatted string (e.g. 2012-04-21T11:30:00-04:00). Wildcard '*' can be used with a string type field filter. In addition, string literal filtering is also supported, for example, 'ABC' as a filter maps to a filter that checks if any of the filterable string type fields contains 'ABC'. Organization unit number can be used as a filtering criteria here by specifying 'ouId = ${your_org_unit_id}', please note that only single OU ID matching is supported.

orderBystring

Optional. The fields used to specify the ordering of the results. The supported fields are: - profile_id - display_name - user_email - last_activity_time - last_policy_sync_time - last_status_report_time - first_enrollment_time - os_platform_type - os_version - browser_version - browser_channel - policy_count - extension_count - identity_provider - affiliation_state - os_platform_version By default, sorting is in ascending order, to specify descending order for a field, a suffix " desc" should be added to the field name. The default ordering is the descending order of last_status_report_time.

pageSizeinteger

Optional. The maximum number of profiles to return. The default page size is 100 if page_size is unspecified, and the maximum page size allowed is 200.

pageTokenstring

Optional. The page token used to retrieve a specific page of the listing request.

Response

Successful response

nextPageTokenstring

The pagination token that can be used to list the next page.

totalSizestring int64

Total size represents an estimated number of resources returned. Not guaranteed to be accurate above 10k profiles.

Changes

  • 872a15abbbd0Revision changes
    • info

      the security scope https://www.googleapis.com/auth/chrome.management.profiles was added to the endpoint's security scheme Oauth2

    • info

      the security scope https://www.googleapis.com/auth/chrome.management.profiles was added to the endpoint's security scheme Oauth2c

    • info

      the security scope https://www.googleapis.com/auth/chrome.management.profiles.readonly was removed from the endpoint's security scheme Oauth2

    • info

      the security scope https://www.googleapis.com/auth/chrome.management.profiles.readonly was removed from the endpoint's security scheme Oauth2c