1. class
  2. Google
  3. \
  4. Cloud
  5. \
  6. Iam
  7. \
  8. V1
  9. \
  10. IAMPolicyGrpcClient

IAMPolicyGrpcClient

class IAMPolicyGrpcClient extends BaseStub

API Overview

Manages Identity and Access Management (IAM) policies.

Any implementation of an API that offers access control features implements the google.iam.v1.IAMPolicy interface.

Data model

Access control is applied when a principal (user or service account), takes some action on a resource exposed by a service. Resources, identified by URI-like names, are the unit of access control specification. Service implementations can choose the granularity of access control and the supported permissions for their resources. For example one database service may allow access control to be specified only at the Table level, whereas another might allow access control to also be specified at the Column level.

Policy Structure

See google.iam.v1.Policy

This is intentionally not a CRUD style API because access control policies are created and deleted implicitly with the resources to which they are attached.

Methods

__construct(string $hostname, array $opts, Channel $channel = null)

No description

SetIamPolicy(SetIamPolicyRequest $argument, array $metadata = [], array $options = [])

Sets the access control policy on the specified resource. Replaces any existing policy.

GetIamPolicy(GetIamPolicyRequest $argument, array $metadata = [], array $options = [])

Gets the access control policy for a resource.

TestIamPermissions(TestIamPermissionsRequest $argument, array $metadata = [], array $options = [])

Returns permissions that a caller has on the specified resource.

Details

at line 55
__construct(string $hostname, array $opts, Channel $channel = null)

Parameters

string $hostname hostname
array $opts channel options
Channel $channel (optional) re-use channel object

at line 66
SetIamPolicy(SetIamPolicyRequest $argument, array $metadata = [], array $options = [])

Sets the access control policy on the specified resource. Replaces any existing policy.

Parameters

SetIamPolicyRequest $argument input argument
array $metadata metadata
array $options call options

at line 82
GetIamPolicy(GetIamPolicyRequest $argument, array $metadata = [], array $options = [])

Gets the access control policy for a resource.

Returns an empty policy if the resource exists and does not have a policy set.

Parameters

GetIamPolicyRequest $argument input argument
array $metadata metadata
array $options call options

at line 98
TestIamPermissions(TestIamPermissionsRequest $argument, array $metadata = [], array $options = [])

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.

Parameters

TestIamPermissionsRequest $argument input argument
array $metadata metadata
array $options call options