Method: projects.instances.setIamPolicy

Sets the access control policy on an instance resource. Replaces any existing policy.

Authorization requiresspanner.instances.setIamPolicy onresource.

HTTP request


POST https://spanner.googleapis.com/v1/{resource=projects/*/instances/*}:setIamPolicy

The URLs usegRPC Transcoding syntax.

Path parameters

Parameters
resource

string

REQUIRED: The Cloud Spanner resource for which the policy is being set. The format isprojects/<project ID>/instances/<instance ID> for instance resources andprojects/<project ID>/instances/<instance ID>/databases/<database ID> for databases resources.

Request body

The request body contains data with the following structure:

JSON representation
{"policy":{object (Policy)}}
Fields
policy

object (Policy)

REQUIRED: The complete policy to be applied to theresource. The size of the policy is limited to a few 10s of KB. An empty policy is a valid policy but certain Google Cloud services (such as Projects) might reject them.

Response body

If successful, the response body contains an instance ofPolicy.

Authorization scopes

Requires one of the following OAuth scopes:

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

For more information, see theAuthentication Overview.

Except as otherwise noted, the content of this page is licensed under theCreative Commons Attribution 4.0 License, and code samples are licensed under theApache 2.0 License. For details, see theGoogle Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.

Last updated 2025-12-12 UTC.