Method: permissions.queryTestablePermissions

Lists the permissions testable on a resource. A permission is testable if it can be tested for an identity on a resource.

HTTP request

POST https://iam.googleapis.com/v1/permissions:queryTestablePermissions

The URL uses Google API HTTP annotation syntax.

Request body

The request body contains data with the following structure:

JSON representation
{
  "fullResourceName": string,
  "pageSize": number,
  "pageToken": string,
}
Fields
fullResourceName

string

Required. The full resource name to query from the list of testable permissions.

The name follows the Google Cloud Platform resource format. For example, a Cloud Platform project with id my-project will be named //cloudresourcemanager.googleapis.com/projects/my-project.

pageSize

number

Optional limit on the number of permissions to include in the response.

pageToken

string

Optional pagination token returned in an earlier QueryTestablePermissionsRequest.

Response body

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

The response containing permissions which can be tested on a resource.

JSON representation
{
  "permissions": [
    {
      object(Permission)
    }
  ],
  "nextPageToken": string,
}
Fields
permissions[]

object(Permission)

The Permissions testable on the requested resource.

nextPageToken

string

To retrieve the next page of results, set QueryTestableRolesRequest.page_token to this value.

Authorization Scopes

Requires one of the following OAuth scopes:

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

For more information, see the Auth Guide.

Permission

A permission which can be included by a role.

JSON representation
{
  "name": string,
  "title": string,
  "description": string,
  "onlyInPredefinedRoles": boolean,
  "stage": enum(PermissionLaunchStage),
  "customRolesSupportLevel": enum(CustomRolesSupportLevel),
  "apiDisabled": boolean,
}
Fields
name

string

The name of this Permission.

title

string

The title of this Permission.

description

string

A brief description of what this Permission is used for.

onlyInPredefinedRoles
(deprecated)

boolean

This permission can ONLY be used in predefined roles.

stage

enum(PermissionLaunchStage)

The current launch stage of the permission.

customRolesSupportLevel

enum(CustomRolesSupportLevel)

The current custom role support level.

apiDisabled

boolean

The service API associated with the permission is not enabled.

PermissionLaunchStage

A stage representing a permission's lifecycle phase.

Enums
ALPHA The permission is currently in an alpha phase.
BETA The permission is currently in a beta phase.
GA The permission is generally available.
DEPRECATED The permission is being deprecated.

CustomRolesSupportLevel

Indicates whether the permission is not supported in custom roles or is being tested for compatibility in custom roles. If this field is not listed for a given permission, the permission is supported in custom roles.

Enums
TESTING Permission is being tested to check custom role compatibility.
NOT_SUPPORTED Permission is not supported for custom role use.

Try it!

このページは役立ちましたか?評価をお願いいたします。

フィードバックを送信...

Cloud Identity and Access Management