Method: debug.datasources.items.checkAccess

Checks whether an item is accessible by specified principal. Principal must be a user; groups and domain values aren't supported.

Note: This API requires an admin account to execute.

HTTP request

POST https://cloudsearch.googleapis.com/v1/debug/{name=datasources/*/items/*}:checkAccess

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
name

string

Item name, format: datasources/{sourceId}/items/{itemId}

Query parameters

Parameters
debugOptions

object (DebugOptions)

Common debug options.

Request body

The request body contains an instance of Principal.

Response body

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

JSON representation 
{
  "hasAccess": boolean
}
Fields
hasAccess

boolean

Returns true if principal has access. Returns false otherwise.

Authorization scopes

Requires one of the following OAuth scopes:

  • https://www.googleapis.com/auth/cloud_search.debug
  • https://www.googleapis.com/auth/cloud_search

For more information, see the Authorization guide.