Method: dataAccessScopes.list

Full name: projects.locations.instances.dataAccessScopes.list

Lists all existing data access scopes for the customer.

HTTP request

GET https://chronicle.googleapis.com/v1/{parent}/dataAccessScopes

Path parameters

Parameters
parent

string

Required. The parent resource where this data access scope will be created. Format: projects/{project}/locations/{location}/instances/{instance}

Query parameters

Parameters
pageSize

integer

The maximum number of data access scopes to return. The service may return fewer than this value. If unspecified, at most 100 data access scopes will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.
pageToken

string

A page token, received from a previous ListDataAccessScopesRequest call. Provide this to retrieve the subsequent page.
filter

string

Optional. A filter which should follow the guidelines of AIP-160. Supports filtering on all fieds of DataAccessScope and all operations as mentioned in https://google.aip.dev/160. example filter: "create_time > "2023-04-21T11:30:00-04:00" OR display_name:"-21-1"".

Request body

The request body must be empty.

Response body

Response message for ListDataAccessScopes.

If successful, the response body contains data with the following structure:

JSON representation 
{
  "data_access_scopes": [
    {
      object (DataAccessScope)
    }
  ],
  "next_page_token": string,
  "global_data_access_scope_granted": boolean
}
Fields
data_access_scopes[]

object (DataAccessScope)

List of data access scopes.
next_page_token

string

A token, which can be sent as page_token to retrieve the next page. If this field is omitted, there are no subsequent pages.
global_data_access_scope_granted

boolean

Whether or not global scope is granted to the user.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

IAM Permissions

Requires the following IAM permission on the parent resource:

  • chronicle.dataAccessScopes.list

For more information, see the IAM documentation.