---
title: "POST /v1/debug/{+name}:checkAccess"
method: POST
path: "/v1/debug/{+name}:checkAccess"
tags: ["debug"]
---

# POST /v1/debug/{+name}:checkAccess

`POST /v1/debug/{+name}: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.

## Path parameters

- `name` string, required

## Query parameters

- `debugOptions.enableDebugging` boolean

## Request body

- Principal — Reference to a user, group, or domain.
  - `gsuitePrincipal` GSuitePrincipal
    - `gsuiteUserEmail` string — This principal references a Google Workspace user account.
    - `gsuiteGroupEmail` string — This principal references a Google Workspace group name.
    - `gsuiteDomain` boolean — This principal represents all users of the Google Workspace domain of the customer.
  - `groupResourceName` string — This principal is a group identified using an external identity. The name field must specify the group resource name with this format: identitysources/{source_id}/groups/{ID}
  - `userResourceName` string — This principal is a user identified using an external identity. The name field must specify the user resource name with this format: identitysources/{source_id}/users/{ID}

## Response `200`

Successful response

---

[API](https://skmtc.net/google/apis/cloudsearch.md) · [All operations](https://skmtc.net/google/apis/cloudsearch/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/google/cloudsearch/versions/d64d6afc59a6/schema)