@google-cloud/spanner 3.1.0 » Namespace: v1

google.iam.v1

namespace   static

Abstract types

Binding

static

Associates members with a role.

Properties

Parameter
role	string Role that is assigned to members. For example, roles/viewer, roles/editor, or roles/owner. Required
members	Array of string Specifies the identities requesting access for a Cloud Platform resource. members can have the following values: allUsers: A special identifier that represents anyone who is on the internet; with or without a Google account. allAuthenticatedUsers: A special identifier that represents anyone who is authenticated with a Google account or a service account. user:{emailid}: An email address that represents a specific Google account. For example, [e-mail]</a><code>or</code><a href="mailto:[e-mail]">[e-mail]</a>. serviceAccount:{emailid}: An email address that represents a service account. For example, [e-mail]</a>. group:{emailid}: An email address that represents a Google group. For example, [e-mail]</a>. domain:{domain}: A Google Apps domain name that represents all the users of that domain. For example, google.com or example.com.

See also

google.iam.v1.Binding definition in proto format

GetIamPolicyRequest

static

Request message for GetIamPolicy method.

Property

Parameter
resource	string REQUIRED: The resource for which the policy is being requested. resource is usually specified as a path. For example, a Project resource is specified as projects/{project}.

See also

google.iam.v1.GetIamPolicyRequest definition in proto format

Policy

static

Defines an Identity and Access Management (IAM) policy. It is used to specify access control policies for Cloud Platform resources.

A Policy consists of a list of bindings. A Binding binds a list of members to a role, where the members can be user accounts, Google groups, Google domains, and service accounts. A role is a named list of permissions defined by IAM.

Example

{
  "bindings": [
    {
      "role": "roles/owner",
      "members": [
        "user:[e-mail]",
        "group:[e-mail]",
        "domain:google.com",
        "serviceAccount:[e-mail]",
      ]
    },
    {
      "role": "roles/viewer",
      "members": ["user:[e-mail]"]
    }
  ]
}

For a description of IAM and its features, see the IAM developer's guide.

Properties

Parameter
version	number Version of the Policy. The default version is 0.
bindings	Array of Object Associates a list of members to a role. Multiple bindings must not be specified for the same role. bindings with no members will result in an error. This object should have the same structure as Binding
etag	string etag is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the etag in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An etag is returned in the response to getIamPolicy, and systems are expected to put that etag in the request to setIamPolicy to ensure that their change will be applied to the same version of the policy. If no etag is provided in the call to setIamPolicy, then the existing policy is overwritten blindly.

See also

google.iam.v1.Policy definition in proto format

SetIamPolicyRequest

static

Request message for SetIamPolicy method.

Properties

Parameter
resource	string REQUIRED: The resource for which the policy is being specified. resource is usually specified as a path. For example, a Project resource is specified as projects/{project}.
policy	Object REQUIRED: The complete policy to be applied to the resource. The size of the policy is limited to a few 10s of KB. An empty policy is a valid policy but certain Cloud Platform services (such as Projects) might reject them. This object should have the same structure as Policy

See also

google.iam.v1.SetIamPolicyRequest definition in proto format

TestIamPermissionsRequest

static

Request message for TestIamPermissions method.

Properties

Parameter
resource	string REQUIRED: The resource for which the policy detail is being requested. resource is usually specified as a path. For example, a Project resource is specified as projects/{project}.
permissions	Array of string The set of permissions to check for the resource. Permissions with wildcards (such as '' or 'storage.') are not allowed. For more information see IAM Overview.

See also

google.iam.v1.TestIamPermissionsRequest definition in proto format

TestIamPermissionsResponse

static

Response message for TestIamPermissions method.

Property

Parameter
permissions	Array of string A subset of TestPermissionsRequest.permissions that the caller is allowed.

See also

google.iam.v1.TestIamPermissionsResponse definition in proto format