Reference documentation and code samples for the Privileged Access Manager API module Google::Cloud::PrivilegedAccessManager.
Methods
.configure
defself.configure()->::Google::Cloud::Config
Configure the google-cloud-privileged_access_manager library.
The following configuration parameters are supported:
credentials (type:String, Hash, Google::Auth::Credentials) -
The path to the keyfile as a String, the contents of the keyfile as a
Hash, or a Google::Auth::Credentials object.
lib_name (type:String) -
The library name as recorded in instrumentation and logging.
lib_version (type:String) -
The library version as recorded in instrumentation and logging.
interceptors (type:Array<GRPC::ClientInterceptor>) -
An array of interceptors that are run before calls are executed.
timeout (type:Numeric) -
Default timeout in seconds.
metadata (type:Hash{Symbol=>String}) -
Additional headers to be sent with the call.
retry_policy (type:Hash) -
The retry policy. The value is a hash with the following keys:
:initial_delay (type:Numeric) - The initial delay in seconds.
:max_delay (type:Numeric) - The max delay in seconds.
:multiplier (type:Numeric) - The incremental backoff multiplier.
:retry_codes (type:Array<String>) -
The error codes that should trigger a retry.
Create a new client object for PrivilegedAccessManager.
By default, this returns an instance of
Google::Cloud::PrivilegedAccessManager::V1::PrivilegedAccessManager::Client
for a gRPC client for version V1 of the API.
However, you can specify a different API version by passing it in the
version parameter. If the PrivilegedAccessManager service is
supported by that API version, and the corresponding gem is available, the
appropriate versioned client will be returned.
You can also specify a different transport by passing :rest or :grpc in
the transport parameter.
Raises an exception if the currently installed versioned client gem for the
given API version does not support the given transport of the PrivilegedAccessManager service.
You can determine whether the method will succeed by calling
PrivilegedAccessManager.privileged_access_manager_available?.
About PrivilegedAccessManager
This API allows customers to manage temporary, request based privileged
access to their resources.
It defines the following resource model:
A collection of Entitlement resources. An entitlement allows configuring
(among other things):
Some kind of privileged access that users can request.
A set of users called requesters who can request this access.
A maximum duration for which the access can be requested.
An optional approval workflow which must be satisfied before access is
granted.
A collection of Grant resources. A grant is a request by a requester to
get the privileged access specified in an entitlement for some duration.
After the approval workflow as specified in the entitlement is satisfied,
the specified access is given to the requester. The access is automatically
taken back after the requested duration is over.
Parameters
version (::String, ::Symbol) (defaults to: :v1) — The API version to connect to. Optional.
Defaults to :v1.
transport (:grpc, :rest) (defaults to: :grpc) — The transport to use. Defaults to :grpc.
Returns
(::Object) — A client object for the specified version.
Determines whether the PrivilegedAccessManager service is supported by the current client.
If true, you can retrieve a client object by calling PrivilegedAccessManager.privileged_access_manager.
If false, that method will raise an exception. This could happen if the given
API version does not exist or does not support the PrivilegedAccessManager service,
or if the versioned client gem needs an update to support the PrivilegedAccessManager service.
Parameters
version (::String, ::Symbol) (defaults to: :v1) — The API version to connect to. Optional.
Defaults to :v1.
transport (:grpc, :rest) (defaults to: :grpc) — The transport to use. Defaults to :grpc.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-09-03 UTC."],[],[],null,["# Privileged Access Manager API - Module Google::Cloud::PrivilegedAccessManager (v1.0.1)\n\nVersion latestkeyboard_arrow_down\n\n- [1.0.1 (latest)](/ruby/docs/reference/google-cloud-privileged_access_manager/latest/Google-Cloud-PrivilegedAccessManager)\n- [1.0.0](/ruby/docs/reference/google-cloud-privileged_access_manager/1.0.0/Google-Cloud-PrivilegedAccessManager)\n- [0.2.0](/ruby/docs/reference/google-cloud-privileged_access_manager/0.2.0/Google-Cloud-PrivilegedAccessManager)\n- [0.1.1](/ruby/docs/reference/google-cloud-privileged_access_manager/0.1.1/Google-Cloud-PrivilegedAccessManager) \nReference documentation and code samples for the Privileged Access Manager API module Google::Cloud::PrivilegedAccessManager.\n\nMethods\n-------\n\n### .configure\n\n def self.configure() -\u003e ::Google::Cloud::Config\n\nConfigure the google-cloud-privileged_access_manager library.\n\nThe following configuration parameters are supported:\n\n- `credentials` (*type:* `String, Hash, Google::Auth::Credentials`) - The path to the keyfile as a String, the contents of the keyfile as a Hash, or a Google::Auth::Credentials object.\n- `lib_name` (*type:* `String`) - The library name as recorded in instrumentation and logging.\n- `lib_version` (*type:* `String`) - The library version as recorded in instrumentation and logging.\n- `interceptors` (*type:* `Array\u003cGRPC::ClientInterceptor\u003e`) - An array of interceptors that are run before calls are executed.\n- `timeout` (*type:* `Numeric`) - Default timeout in seconds.\n- `metadata` (*type:* `Hash{Symbol=\u003eString}`) - Additional headers to be sent with the call.\n- `retry_policy` (*type:* `Hash`) - The retry policy. The value is a hash with the following keys:\n - `:initial_delay` (*type:* `Numeric`) - The initial delay in seconds.\n - `:max_delay` (*type:* `Numeric`) - The max delay in seconds.\n - `:multiplier` (*type:* `Numeric`) - The incremental backoff multiplier.\n- `:retry_codes` (*type:* `Array\u003cString\u003e`) - The error codes that should trigger a retry. \n**Yields**\n\n- (::Google::Cloud.configure.privileged_access_manager) \n**Returns**\n\n- (::Google::Cloud::Config) --- The default configuration used by this library\n\n### .privileged_access_manager\n\n def self.privileged_access_manager(version: :v1, transport: :grpc, &block) -\u003e ::Object\n\nCreate a new client object for PrivilegedAccessManager.\n\n\nBy default, this returns an instance of\n[Google::Cloud::PrivilegedAccessManager::V1::PrivilegedAccessManager::Client](https://cloud.google.com/ruby/docs/reference/google-cloud-privileged_access_manager-v1/latest/Google-Cloud-PrivilegedAccessManager-V1-PrivilegedAccessManager-Client)\nfor a gRPC client for version V1 of the API.\nHowever, you can specify a different API version by passing it in the\n`version` parameter. If the PrivilegedAccessManager service is\nsupported by that API version, and the corresponding gem is available, the\nappropriate versioned client will be returned.\nYou can also specify a different transport by passing `:rest` or `:grpc` in\nthe `transport` parameter.\n\nRaises an exception if the currently installed versioned client gem for the\ngiven API version does not support the given transport of the PrivilegedAccessManager service.\nYou can determine whether the method will succeed by calling\n[PrivilegedAccessManager.privileged_access_manager_available?](/ruby/docs/reference/google-cloud-privileged_access_manager/latest/Google-Cloud-PrivilegedAccessManager#Google__Cloud__PrivilegedAccessManager_privileged_access_manager_available__class_ \"Google::Cloud::PrivilegedAccessManager.privileged_access_manager_available? (method)\").\n\n#### About PrivilegedAccessManager\n\nThis API allows customers to manage temporary, request based privileged\naccess to their resources.\n\nIt defines the following resource model:\n\n- A collection of `Entitlement` resources. An entitlement allows configuring\n (among other things):\n\n - Some kind of privileged access that users can request.\n - A set of users called *requesters* who can request this access.\n - A maximum duration for which the access can be requested.\n - An optional approval workflow which must be satisfied before access is granted.\n- A collection of `Grant` resources. A grant is a request by a requester to\n get the privileged access specified in an entitlement for some duration.\n\n\u003cbr /\u003e\n\nAfter the approval workflow as specified in the entitlement is satisfied,\nthe specified access is given to the requester. The access is automatically\ntaken back after the requested duration is over. \n**Parameters**\n\n- **version** (::String, ::Symbol) *(defaults to: :v1)* --- The API version to connect to. Optional. Defaults to `:v1`.\n- **transport** (:grpc, :rest) *(defaults to: :grpc)* --- The transport to use. Defaults to `:grpc`. \n**Returns**\n\n- (::Object) --- A client object for the specified version.\n\n### .privileged_access_manager_available?\n\n def self.privileged_access_manager_available?(version: :v1, transport: :grpc) -\u003e boolean\n\nDetermines whether the PrivilegedAccessManager service is supported by the current client.\nIf true, you can retrieve a client object by calling [PrivilegedAccessManager.privileged_access_manager](/ruby/docs/reference/google-cloud-privileged_access_manager/latest/Google-Cloud-PrivilegedAccessManager#Google__Cloud__PrivilegedAccessManager_privileged_access_manager_class_ \"Google::Cloud::PrivilegedAccessManager.privileged_access_manager (method)\").\nIf false, that method will raise an exception. This could happen if the given\nAPI version does not exist or does not support the PrivilegedAccessManager service,\nor if the versioned client gem needs an update to support the PrivilegedAccessManager service. \n**Parameters**\n\n- **version** (::String, ::Symbol) *(defaults to: :v1)* --- The API version to connect to. Optional. Defaults to `:v1`.\n- **transport** (:grpc, :rest) *(defaults to: :grpc)* --- The transport to use. Defaults to `:grpc`. \n**Returns**\n\n- (boolean) --- Whether the service is available.\n\nConstants\n---------\n\n### VERSION\n\n**value:**\"1.0.1\""]]