Policy Simulator API C++ Client Library
An idiomatic C++ client library for thePolicy Simulator API
Policy Simulator is a collection of endpoints for creating, running, and viewing aReplay. AReplay is a type of simulation that lets you see how your members' access to resources might change if you changed your IAM policy.
During aReplay, Policy Simulator re-evaluates, or replays, past access attempts under both the current policy and your proposed policy, and compares those results to determine how your members' access might change under the proposed policy.
While this library isGA, please note that the Google Cloud C++ client libraries donot followSemantic Versioning.
Quickstart
The following shows the code that you'll run in thegoogle/cloud/policysimulator/quickstart/ directory, which should give you a taste of the Policy Simulator API C++ client library API.
#include "google/cloud/policysimulator/v1/simulator_client.h"#include "google/cloud/location.h"#include <iostream>#include <string>int main(int argc, char* argv[]) try { if (argc != 3) { std::cerr << "Usage: " << argv[0] << " project-id resource-name\n" << "See https://cloud.google.com/iam/docs/full-resource-names for " "examples of fully qualified resource names.\n"; return 1; } auto const location = google::cloud::Location(argv[1], "global"); auto const resource_name = std::string{argv[2]}; namespace policysimulator = ::google::cloud::policysimulator_v1; auto client = policysimulator::SimulatorClient( policysimulator::MakeSimulatorConnection()); google::cloud::policysimulator::v1::Replay r; auto& overlay = *r.mutable_config()->mutable_policy_overlay(); overlay[resource_name] = [] { google::iam::v1::Policy p; auto& binding = *p.add_bindings(); binding.set_role("storage.buckets.get"); binding.add_members("user@example.com"); return p; }(); auto replay = client.CreateReplay(location.FullName(), r).get(); if (!replay) throw std::move(replay).status(); std::cout << replay->DebugString() << "\n"; return 0;} catch (google::cloud::Status const& status) { std::cerr << "google::cloud::Status thrown: " << status << "\n"; return 1;}Main classes
The main class in this library ispolicysimulator_v1::SimulatorClient. All RPCs are exposed as member functions of this class. Other classes provide helpers, configuration parameters, and infrastructure to mockpolicysimulator_v1::SimulatorClient when testing your application.
More Information
- Error Handling - describes how the library reports errors.
- How to Override the Default Endpoint - describes how to override the default endpoint.
- How to Override the Authentication Credentials - describes how to change the authentication credentials used by the library.
- Override Retry, Backoff, and Idempotency Policies - describes how to change the default retry policies.
- Environment Variables - describes environment variables that can configure the behavior of the library.
Except as otherwise noted, the content of this page is licensed under theCreative Commons Attribution 4.0 License, and code samples are licensed under theApache 2.0 License. For details, see theGoogle Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-12-03 UTC.