Google Cloud PHP shared dependency, providing functionality useful to all components. Client - Class Iam (1.48.1)

Reference documentation and code samples for the Google Cloud PHP shared dependency, providing functionality useful to all components. Client class Iam.

IAM Manager

This class is not meant to be used directly. It should be accessed through other objects which support IAM.

Policies can be created using the {@see} to help ensure their validity.

Example:

 // IAM policies are obtained via resources which implement IAM.
// In this example, we'll use PubSub topics to demonstrate
// how IAM policies are managed.

use Google\Cloud\PubSub\PubSubClient;

$pubsub = new PubSubClient();
$topic = $pubsub->topic('my-new-topic');

$iam = $topic->iam(); 

Get the existing IAM policy for this resource.

If a policy has already been retrieved from the API, it will be returned. To fetch a fresh copy of the policy, use {@see}.

Example:

 $policy = $iam->policy(); 

Set the IAM policy for this resource.

Bindings with invalid roles, or non-existent members will raise a server error.

Example:

 $oldPolicy = $iam->policy();
$oldPolicy['bindings'][0]['members'] = 'user:test@example.com';

$policy = $iam->setPolicy($oldPolicy); 

Test if the current user has the given permissions on this resource.

Invalid permissions will raise a BadRequestException.

Example:

 $allowedPermissions = $iam->testPermissions([
    'pubsub.topics.publish',
    'pubsub.topics.attachSubscription'
]); 

Refresh the IAM policy for this resource.

Example:

 $policy = $iam->reload();