Reference documentation and code samples for the Google Cloud Iam V2 Client class PoliciesClient.
Service Description: An interface for managing Identity and Access Management (IAM) policies.
This class provides the ability to make remote calls to the backing service through method calls that map to API methods. Sample code to get started:
$policiesClient = new PoliciesClient();
try {
$parent = 'parent';
$policy = new Policy();
$operationResponse = $policiesClient->createPolicy($parent, $policy);
$operationResponse->pollUntilComplete();
if ($operationResponse->operationSucceeded()) {
$result = $operationResponse->getResult();
// doSomethingWith($result)
} else {
$error = $operationResponse->getError();
// handleError($error)
}
// Alternatively:
// start the operation, keep the operation name, and resume later
$operationResponse = $policiesClient->createPolicy($parent, $policy);
$operationName = $operationResponse->getName();
// ... do other work
$newOperationResponse = $policiesClient->resumeOperation($operationName, 'createPolicy');
while (!$newOperationResponse->isDone()) {
// ... do other work
$newOperationResponse->reload();
}
if ($newOperationResponse->operationSucceeded()) {
$result = $newOperationResponse->getResult();
// doSomethingWith($result)
} else {
$error = $newOperationResponse->getError();
// handleError($error)
}
} finally {
$policiesClient->close();
}
This service has a new (beta) implementation. See Google\Cloud\Iam\V2\Client\PoliciesClient to use the new surface.
Namespace
Google \ Cloud \ Iam \ V2Methods
__construct
Constructor.
options
array
Optional. Options for configuring the service API wrapper.
↳ apiEndpoint
string
The address of the API remote host. May optionally include the port, formatted as "
↳ credentials
string|array|FetchAuthTokenInterface|CredentialsWrapper
The credentials to be used by the client to authorize API calls. This option accepts either a path to a credentials file, or a decoded credentials file as a PHP array. Advanced usage : In addition, this option can also accept a pre-constructed Google\Auth\FetchAuthTokenInterface object or Google\ApiCore\CredentialsWrapper object. Note that when one of these objects are provided, any settings in $credentialsConfig will be ignored.
↳ credentialsConfig
array
Options used to configure credentials, including auth token caching, for the client. For a full list of supporting configuration options, see Google\ApiCore\CredentialsWrapper::build() .
↳ disableRetries
bool
Determines whether or not retries defined by the client configuration should be disabled. Defaults to false
.
↳ clientConfig
string|array
Client method configuration, including retry settings. This option can be either a path to a JSON file, or a PHP array containing the decoded JSON data. By default this settings points to the default client config file, which is provided in the resources folder.
↳ transport
string|TransportInterface
The transport used for executing network requests. May be either the string rest
or grpc
. Defaults to grpc
if gRPC support is detected on the system. Advanced usage
: Additionally, it is possible to pass in an already instantiated Google\ApiCore\Transport\TransportInterface
object. Note that when this object is provided, any settings in $transportConfig, and any $apiEndpoint setting, will be ignored.
↳ transportConfig
array
Configuration options that will be used to construct the transport. Options for each supported transport type should be passed in a key for that transport. For example: $transportConfig = [ 'grpc' => [...], 'rest' => [...], ]; See the Google\ApiCore\Transport\GrpcTransport::build() and Google\ApiCore\Transport\RestTransport::build() methods for the supported options.
↳ clientCertSource
callable
A callable which returns the client cert as a string. This can be used to provide a certificate and private key to the transport layer for mTLS.
createPolicy
Creates a policy.
parent
string
Required. The resource that the policy is attached to, along with the kind of policy
to create. Format: policies/{attachment_point}/denypolicies
The attachment point is identified by its URL-encoded full resource name,
which means that the forward-slash character, /
, must be written as %2F
. For example, policies/cloudresourcemanager.googleapis.com%2Fprojects%2Fmy-project/denypolicies
.
For organizations and folders, use the numeric ID in the full resource name. For projects, you can use the alphanumeric or the numeric ID.
policy
optionalArgs
array
Optional.
↳ policyId
string
The ID to use for this policy, which will become the final component of the policy's resource name. The ID must contain 3 to 63 characters. It can contain lowercase letters and numbers, as well as dashes ( -
) and periods ( .
). The first character must be a lowercase letter.
↳ retrySettings
RetrySettings|array
Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.
use Google\ApiCore\ApiException;
use Google\ApiCore\OperationResponse;
use Google\Cloud\Iam\V2\Client\PoliciesClient;
use Google\Cloud\Iam\V2\CreatePolicyRequest;
use Google\Cloud\Iam\V2\Policy;
use Google\Rpc\Status;
/**
* @param string $parent The resource that the policy is attached to, along with the kind of policy
* to create. Format: `policies/{attachment_point}/denypolicies`
*
*
* The attachment point is identified by its URL-encoded full resource name,
* which means that the forward-slash character, `/`, must be written as
* `%2F`. For example,
* `policies/cloudresourcemanager.googleapis.com%2Fprojects%2Fmy-project/denypolicies`.
*
* For organizations and folders, use the numeric ID in the full resource
* name. For projects, you can use the alphanumeric or the numeric ID.
*/
function create_policy_sample(string $parent): void
{
// Create a client.
$policiesClient = new PoliciesClient();
// Prepare the request message.
$policy = new Policy();
$request = (new CreatePolicyRequest())
->setParent($parent)
->setPolicy($policy);
// Call the API and handle any network failures.
try {
/** @var OperationResponse $response */
$response = $policiesClient->createPolicy($request);
$response->pollUntilComplete();
if ($response->operationSucceeded()) {
/** @var Policy $result */
$result = $response->getResult();
printf('Operation successful with response data: %s' . PHP_EOL, $result->serializeToJsonString());
} else {
/** @var Status $error */
$error = $response->getError();
printf('Operation failed with error data: %s' . PHP_EOL, $error->serializeToJsonString());
}
} catch (ApiException $ex) {
printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
}
}
/**
* Helper to execute the sample.
*
* This sample has been automatically generated and should be regarded as a code
* template only. It will require modifications to work:
* - It may require correct/in-range values for request initialization.
* - It may require specifying regional endpoints when creating the service client,
* please see the apiEndpoint client configuration option for more details.
*/
function callSample(): void
{
$parent = '[PARENT]';
create_policy_sample($parent);
}
deletePolicy
Deletes a policy. This action is permanent.
name
string
Required. The resource name of the policy to delete. Format: policies/{attachment_point}/denypolicies/{policy_id}
Use the URL-encoded full resource name, which means that the forward-slash
character, /
, must be written as %2F
. For example, policies/cloudresourcemanager.googleapis.com%2Fprojects%2Fmy-project/denypolicies/my-policy
.
For organizations and folders, use the numeric ID in the full resource name. For projects, you can use the alphanumeric or the numeric ID.
optionalArgs
array
Optional.
↳ etag
string
Optional. The expected etag
of the policy to delete. If the value does not match the value that is stored in IAM, the request fails with a 409
error code and ABORTED
status. If you omit this field, the policy is deleted regardless of its current etag
.
↳ retrySettings
RetrySettings|array
Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.
use Google\ApiCore\ApiException;
use Google\ApiCore\OperationResponse;
use Google\Cloud\Iam\V2\Client\PoliciesClient;
use Google\Cloud\Iam\V2\DeletePolicyRequest;
use Google\Cloud\Iam\V2\Policy;
use Google\Rpc\Status;
/**
* @param string $name The resource name of the policy to delete. Format:
* `policies/{attachment_point}/denypolicies/{policy_id}`
*
*
* Use the URL-encoded full resource name, which means that the forward-slash
* character, `/`, must be written as `%2F`. For example,
* `policies/cloudresourcemanager.googleapis.com%2Fprojects%2Fmy-project/denypolicies/my-policy`.
*
* For organizations and folders, use the numeric ID in the full resource
* name. For projects, you can use the alphanumeric or the numeric ID.
*/
function delete_policy_sample(string $name): void
{
// Create a client.
$policiesClient = new PoliciesClient();
// Prepare the request message.
$request = (new DeletePolicyRequest())
->setName($name);
// Call the API and handle any network failures.
try {
/** @var OperationResponse $response */
$response = $policiesClient->deletePolicy($request);
$response->pollUntilComplete();
if ($response->operationSucceeded()) {
/** @var Policy $result */
$result = $response->getResult();
printf('Operation successful with response data: %s' . PHP_EOL, $result->serializeToJsonString());
} else {
/** @var Status $error */
$error = $response->getError();
printf('Operation failed with error data: %s' . PHP_EOL, $error->serializeToJsonString());
}
} catch (ApiException $ex) {
printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
}
}
/**
* Helper to execute the sample.
*
* This sample has been automatically generated and should be regarded as a code
* template only. It will require modifications to work:
* - It may require correct/in-range values for request initialization.
* - It may require specifying regional endpoints when creating the service client,
* please see the apiEndpoint client configuration option for more details.
*/
function callSample(): void
{
$name = '[NAME]';
delete_policy_sample($name);
}
getPolicy
Gets a policy.
name
string
Required. The resource name of the policy to retrieve. Format: policies/{attachment_point}/denypolicies/{policy_id}
Use the URL-encoded full resource name, which means that the forward-slash
character, /
, must be written as %2F
. For example, policies/cloudresourcemanager.googleapis.com%2Fprojects%2Fmy-project/denypolicies/my-policy
.
For organizations and folders, use the numeric ID in the full resource name. For projects, you can use the alphanumeric or the numeric ID.
optionalArgs
array
Optional.
↳ retrySettings
RetrySettings|array
Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.
use Google\ApiCore\ApiException;
use Google\Cloud\Iam\V2\Client\PoliciesClient;
use Google\Cloud\Iam\V2\GetPolicyRequest;
use Google\Cloud\Iam\V2\Policy;
/**
* @param string $name The resource name of the policy to retrieve. Format:
* `policies/{attachment_point}/denypolicies/{policy_id}`
*
*
* Use the URL-encoded full resource name, which means that the forward-slash
* character, `/`, must be written as `%2F`. For example,
* `policies/cloudresourcemanager.googleapis.com%2Fprojects%2Fmy-project/denypolicies/my-policy`.
*
* For organizations and folders, use the numeric ID in the full resource
* name. For projects, you can use the alphanumeric or the numeric ID.
*/
function get_policy_sample(string $name): void
{
// Create a client.
$policiesClient = new PoliciesClient();
// Prepare the request message.
$request = (new GetPolicyRequest())
->setName($name);
// Call the API and handle any network failures.
try {
/** @var Policy $response */
$response = $policiesClient->getPolicy($request);
printf('Response data: %s' . PHP_EOL, $response->serializeToJsonString());
} catch (ApiException $ex) {
printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
}
}
/**
* Helper to execute the sample.
*
* This sample has been automatically generated and should be regarded as a code
* template only. It will require modifications to work:
* - It may require correct/in-range values for request initialization.
* - It may require specifying regional endpoints when creating the service client,
* please see the apiEndpoint client configuration option for more details.
*/
function callSample(): void
{
$name = '[NAME]';
get_policy_sample($name);
}
listPolicies
Retrieves the policies of the specified kind that are attached to a resource.
The response lists only policy metadata. In particular, policy rules are omitted.
parent
string
Required. The resource that the policy is attached to, along with the kind of policy
to list. Format: policies/{attachment_point}/denypolicies
The attachment point is identified by its URL-encoded full resource name,
which means that the forward-slash character, /
, must be written as %2F
. For example, policies/cloudresourcemanager.googleapis.com%2Fprojects%2Fmy-project/denypolicies
.
For organizations and folders, use the numeric ID in the full resource name. For projects, you can use the alphanumeric or the numeric ID.
optionalArgs
array
Optional.
↳ pageSize
int
The maximum number of resources contained in the underlying API response. The API may return fewer values in a page, even if there are additional values to be retrieved.
↳ pageToken
string
A page token is used to specify a page of values to be returned. If no page token is specified (the default), the first page of values will be returned. Any page token used here must have been generated by a previous call to the API.
↳ retrySettings
RetrySettings|array
Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.
use Google\ApiCore\ApiException;
use Google\ApiCore\PagedListResponse;
use Google\Cloud\Iam\V2\Client\PoliciesClient;
use Google\Cloud\Iam\V2\ListPoliciesRequest;
use Google\Cloud\Iam\V2\Policy;
/**
* @param string $parent The resource that the policy is attached to, along with the kind of policy
* to list. Format:
* `policies/{attachment_point}/denypolicies`
*
*
* The attachment point is identified by its URL-encoded full resource name,
* which means that the forward-slash character, `/`, must be written as
* `%2F`. For example,
* `policies/cloudresourcemanager.googleapis.com%2Fprojects%2Fmy-project/denypolicies`.
*
* For organizations and folders, use the numeric ID in the full resource
* name. For projects, you can use the alphanumeric or the numeric ID.
*/
function list_policies_sample(string $parent): void
{
// Create a client.
$policiesClient = new PoliciesClient();
// Prepare the request message.
$request = (new ListPoliciesRequest())
->setParent($parent);
// Call the API and handle any network failures.
try {
/** @var PagedListResponse $response */
$response = $policiesClient->listPolicies($request);
/** @var Policy $element */
foreach ($response as $element) {
printf('Element data: %s' . PHP_EOL, $element->serializeToJsonString());
}
} catch (ApiException $ex) {
printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
}
}
/**
* Helper to execute the sample.
*
* This sample has been automatically generated and should be regarded as a code
* template only. It will require modifications to work:
* - It may require correct/in-range values for request initialization.
* - It may require specifying regional endpoints when creating the service client,
* please see the apiEndpoint client configuration option for more details.
*/
function callSample(): void
{
$parent = '[PARENT]';
list_policies_sample($parent);
}
updatePolicy
Updates the specified policy.
You can update only the rules and the display name for the policy.
To update a policy, you should use a read-modify-write loop:
- Use GetPolicy to read the current version of the policy.
- Modify the policy as needed.
- Use
UpdatePolicyto write the updated policy.
This pattern helps prevent conflicts between concurrent updates.
policy
Google\Cloud\Iam\V2\Policy
Required. The policy to update.
To prevent conflicting updates, the etag
value must match the value that
is stored in IAM. If the etag
values do not match, the request fails with
a 409
error code and ABORTED
status.
optionalArgs
array
Optional.
↳ retrySettings
RetrySettings|array
Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.
use Google\ApiCore\ApiException;
use Google\ApiCore\OperationResponse;
use Google\Cloud\Iam\V2\Client\PoliciesClient;
use Google\Cloud\Iam\V2\Policy;
use Google\Cloud\Iam\V2\UpdatePolicyRequest;
use Google\Rpc\Status;
/**
* This sample has been automatically generated and should be regarded as a code
* template only. It will require modifications to work:
* - It may require correct/in-range values for request initialization.
* - It may require specifying regional endpoints when creating the service client,
* please see the apiEndpoint client configuration option for more details.
*/
function update_policy_sample(): void
{
// Create a client.
$policiesClient = new PoliciesClient();
// Prepare the request message.
$policy = new Policy();
$request = (new UpdatePolicyRequest())
->setPolicy($policy);
// Call the API and handle any network failures.
try {
/** @var OperationResponse $response */
$response = $policiesClient->updatePolicy($request);
$response->pollUntilComplete();
if ($response->operationSucceeded()) {
/** @var Policy $result */
$result = $response->getResult();
printf('Operation successful with response data: %s' . PHP_EOL, $result->serializeToJsonString());
} else {
/** @var Status $error */
$error = $response->getError();
printf('Operation failed with error data: %s' . PHP_EOL, $error->serializeToJsonString());
}
} catch (ApiException $ex) {
printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
}
}
getOperationsClient
Return an OperationsClient object with the same endpoint as $this.
resumeOperation
Resume an existing long running operation that was previously started by a long running API method. If $methodName is not provided, or does not match a long running API method, then the operation can still be resumed, but the OperationResponse object will not deserialize the final response.
operationName
string
The name of the long running operation
methodName
string
The name of the method used to start the operation
Constants
SERVICE_NAME
Value: 'google.iam.v2.Policies'
The name of the service.
SERVICE_ADDRESS
Value: 'iam.googleapis.com'
The default address of the service.
DEFAULT_SERVICE_PORT
Value: 443
The default port of the service.
CODEGEN_NAME
Value: 'gapic'
The name of the code generator, to be included in the agent header.

