getIamPolicy(resource, x__xgafv=None)
Gets the access control policy for a resource.
setIamPolicy(resource, body, x__xgafv=None)
Sets the access control policy on the specified resource. Replaces any
testIamPermissions(resource, body, x__xgafv=None)
Returns permissions that a caller has on the specified resource.
getIamPolicy(resource, x__xgafv=None)
Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set. Args: resource: string, REQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field. (required) x__xgafv: string, V1 error format. Allowed values 1 - v1 error format 2 - v2 error format Returns: An object of the form: { # 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. # # **JSON Example** # # { # "bindings": [ # { # "role": "roles/owner", # "members": [ # "user:mike@example.com", # "group:admins@example.com", # "domain:google.com", # "serviceAccount:my-other-app@appspot.gserviceaccount.com" # ] # }, # { # "role": "roles/viewer", # "members": ["user:sean@example.com"] # } # ] # } # # **YAML Example** # # bindings: # - members: # - user:mike@example.com # - group:admins@example.com # - domain:google.com # - serviceAccount:my-other-app@appspot.gserviceaccount.com # role: roles/owner # - members: # - user:sean@example.com # role: roles/viewer # # # For a description of IAM and its features, see the # [IAM developer's guide](https://cloud.google.com/iam/docs). "bindings": [ # Associates a list of `members` to a `role`. # `bindings` with no members will result in an error. { # Associates `members` with a `role`. "role": "A String", # Role that is assigned to `members`. # For example, `roles/viewer`, `roles/editor`, or `roles/owner`. "members": [ # 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, `alice@gmail.com` . # # # * `serviceAccount:{emailid}`: An email address that represents a service # account. For example, `my-other-app@appspot.gserviceaccount.com`. # # * `group:{emailid}`: An email address that represents a Google group. # For example, `admins@example.com`. # # # * `domain:{domain}`: The G Suite domain (primary) that represents all the # users of that domain. For example, `google.com` or `example.com`. # "A String", ], "condition": { # Represents an expression text. Example: # The condition that is associated with this binding. # NOTE: An unsatisfied condition will not allow user access via current # binding. Different bindings, including their conditions, are examined # independently. # # title: "User account presence" # description: "Determines whether the request has a user account" # expression: "size(request.user) > 0" "location": "A String", # An optional string indicating the location of the expression for error # reporting, e.g. a file name and a position in the file. "expression": "A String", # Textual representation of an expression in # Common Expression Language syntax. # # The application context of the containing message determines which # well-known feature set of CEL is supported. "description": "A String", # An optional description of the expression. This is a longer text which # describes the expression, e.g. when hovered over it in a UI. "title": "A String", # An optional title for the expression, i.e. a short string describing # its purpose. This can be used e.g. in UIs which allow to enter the # expression. }, }, ], "etag": "A 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. "version": 42, # Deprecated. }
setIamPolicy(resource, body, x__xgafv=None)
Sets the access control policy on the specified resource. Replaces any existing policy. Args: resource: string, REQUIRED: The resource for which the policy is being specified. See the operation documentation for the appropriate value for this field. (required) body: object, The request body. (required) The object takes the form of: { # Request message for `SetIamPolicy` method. "policy": { # Defines an Identity and Access Management (IAM) policy. It is used to # 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. # 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. # # **JSON Example** # # { # "bindings": [ # { # "role": "roles/owner", # "members": [ # "user:mike@example.com", # "group:admins@example.com", # "domain:google.com", # "serviceAccount:my-other-app@appspot.gserviceaccount.com" # ] # }, # { # "role": "roles/viewer", # "members": ["user:sean@example.com"] # } # ] # } # # **YAML Example** # # bindings: # - members: # - user:mike@example.com # - group:admins@example.com # - domain:google.com # - serviceAccount:my-other-app@appspot.gserviceaccount.com # role: roles/owner # - members: # - user:sean@example.com # role: roles/viewer # # # For a description of IAM and its features, see the # [IAM developer's guide](https://cloud.google.com/iam/docs). "bindings": [ # Associates a list of `members` to a `role`. # `bindings` with no members will result in an error. { # Associates `members` with a `role`. "role": "A String", # Role that is assigned to `members`. # For example, `roles/viewer`, `roles/editor`, or `roles/owner`. "members": [ # 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, `alice@gmail.com` . # # # * `serviceAccount:{emailid}`: An email address that represents a service # account. For example, `my-other-app@appspot.gserviceaccount.com`. # # * `group:{emailid}`: An email address that represents a Google group. # For example, `admins@example.com`. # # # * `domain:{domain}`: The G Suite domain (primary) that represents all the # users of that domain. For example, `google.com` or `example.com`. # "A String", ], "condition": { # Represents an expression text. Example: # The condition that is associated with this binding. # NOTE: An unsatisfied condition will not allow user access via current # binding. Different bindings, including their conditions, are examined # independently. # # title: "User account presence" # description: "Determines whether the request has a user account" # expression: "size(request.user) > 0" "location": "A String", # An optional string indicating the location of the expression for error # reporting, e.g. a file name and a position in the file. "expression": "A String", # Textual representation of an expression in # Common Expression Language syntax. # # The application context of the containing message determines which # well-known feature set of CEL is supported. "description": "A String", # An optional description of the expression. This is a longer text which # describes the expression, e.g. when hovered over it in a UI. "title": "A String", # An optional title for the expression, i.e. a short string describing # its purpose. This can be used e.g. in UIs which allow to enter the # expression. }, }, ], "etag": "A 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. "version": 42, # Deprecated. }, } x__xgafv: string, V1 error format. Allowed values 1 - v1 error format 2 - v2 error format Returns: An object of the form: { # 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. # # **JSON Example** # # { # "bindings": [ # { # "role": "roles/owner", # "members": [ # "user:mike@example.com", # "group:admins@example.com", # "domain:google.com", # "serviceAccount:my-other-app@appspot.gserviceaccount.com" # ] # }, # { # "role": "roles/viewer", # "members": ["user:sean@example.com"] # } # ] # } # # **YAML Example** # # bindings: # - members: # - user:mike@example.com # - group:admins@example.com # - domain:google.com # - serviceAccount:my-other-app@appspot.gserviceaccount.com # role: roles/owner # - members: # - user:sean@example.com # role: roles/viewer # # # For a description of IAM and its features, see the # [IAM developer's guide](https://cloud.google.com/iam/docs). "bindings": [ # Associates a list of `members` to a `role`. # `bindings` with no members will result in an error. { # Associates `members` with a `role`. "role": "A String", # Role that is assigned to `members`. # For example, `roles/viewer`, `roles/editor`, or `roles/owner`. "members": [ # 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, `alice@gmail.com` . # # # * `serviceAccount:{emailid}`: An email address that represents a service # account. For example, `my-other-app@appspot.gserviceaccount.com`. # # * `group:{emailid}`: An email address that represents a Google group. # For example, `admins@example.com`. # # # * `domain:{domain}`: The G Suite domain (primary) that represents all the # users of that domain. For example, `google.com` or `example.com`. # "A String", ], "condition": { # Represents an expression text. Example: # The condition that is associated with this binding. # NOTE: An unsatisfied condition will not allow user access via current # binding. Different bindings, including their conditions, are examined # independently. # # title: "User account presence" # description: "Determines whether the request has a user account" # expression: "size(request.user) > 0" "location": "A String", # An optional string indicating the location of the expression for error # reporting, e.g. a file name and a position in the file. "expression": "A String", # Textual representation of an expression in # Common Expression Language syntax. # # The application context of the containing message determines which # well-known feature set of CEL is supported. "description": "A String", # An optional description of the expression. This is a longer text which # describes the expression, e.g. when hovered over it in a UI. "title": "A String", # An optional title for the expression, i.e. a short string describing # its purpose. This can be used e.g. in UIs which allow to enter the # expression. }, }, ], "etag": "A 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. "version": 42, # Deprecated. }
testIamPermissions(resource, body, x__xgafv=None)
Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a NOT_FOUND error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning. Args: resource: string, REQUIRED: The resource for which the policy detail is being requested. See the operation documentation for the appropriate value for this field. (required) body: object, The request body. (required) The object takes the form of: { # Request message for `TestIamPermissions` method. "permissions": [ # 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](https://cloud.google.com/iam/docs/overview#permissions). "A String", ], } x__xgafv: string, V1 error format. Allowed values 1 - v1 error format 2 - v2 error format Returns: An object of the form: { # Response message for `TestIamPermissions` method. "permissions": [ # A subset of `TestPermissionsRequest.permissions` that the caller is # allowed. "A String", ], }