Reference documentation and code samples for the Google Cloud Privileged Access Manager V1 Client class Entitlement.
An entitlement defines the eligibility of a set of users to obtain predefined access for some time possibly after going through an approval workflow.
Generated from protobuf message google.cloud.privilegedaccessmanager.v1.Entitlement
Namespace
Google \ Cloud \ PrivilegedAccessManager \ V1Methods
__construct
Constructor.
data
array
Optional. Data for populating the Message object.
↳ name
string
Identifier. Name of the entitlement. Possible formats: * * organizations/{organization-number}/locations/{region}/entitlements/{entitlement-id}
* * folders/{folder-number}/locations/{region}/entitlements/{entitlement-id}
* * projects/{project-id|project-number}/locations/{region}/entitlements/{entitlement-id}
↳ create_time
↳ update_time
↳ eligible_users
array< AccessControlEntry
>
Optional. Who can create grants using this entitlement. This list should contain at most one entry.
↳ approval_workflow
ApprovalWorkflow
Optional. The approvals needed before access are granted to a requester. No approvals are needed if this field is null.
↳ privileged_access
↳ max_request_duration
Google\Protobuf\Duration
Required. The maximum amount of time that access is granted for a request. A requester can ask for a duration less than this, but never more.
↳ state
int
Output only. Current state of this entitlement.
↳ requester_justification_config
Entitlement\RequesterJustificationConfig
Required. The manner in which the requester should provide a justification for requesting access.
↳ additional_notification_targets
Entitlement\AdditionalNotificationTargets
Optional. Additional email addresses to be notified based on actions taken.
↳ etag
string
An etag
is used for optimistic concurrency control as a way to prevent simultaneous updates to the same entitlement. An etag
is returned in the response to GetEntitlement
and the caller should put the etag
in the request to UpdateEntitlement
so that their change is applied on the same version. If this field is omitted or if there is a mismatch while updating an entitlement, then the server rejects the request.
getName
Identifier. Name of the entitlement.
Possible formats:
-
organizations/{organization-number}/locations/{region}/entitlements/{entitlement-id} -
folders/{folder-number}/locations/{region}/entitlements/{entitlement-id} -
projects/{project-id|project-number}/locations/{region}/entitlements/{entitlement-id}
string
setName
Identifier. Name of the entitlement.
Possible formats:
-
organizations/{organization-number}/locations/{region}/entitlements/{entitlement-id} -
folders/{folder-number}/locations/{region}/entitlements/{entitlement-id} -
projects/{project-id|project-number}/locations/{region}/entitlements/{entitlement-id}
var
string
$this
getCreateTime
Output only. Create time stamp.
hasCreateTime
clearCreateTime
setCreateTime
Output only. Create time stamp.
$this
getUpdateTime
Output only. Update time stamp.
hasUpdateTime
clearUpdateTime
setUpdateTime
Output only. Update time stamp.
$this
getEligibleUsers
Optional. Who can create grants using this entitlement. This list should contain at most one entry.
setEligibleUsers
Optional. Who can create grants using this entitlement. This list should contain at most one entry.
$this
getApprovalWorkflow
Optional. The approvals needed before access are granted to a requester. No approvals are needed if this field is null.
hasApprovalWorkflow
clearApprovalWorkflow
setApprovalWorkflow
Optional. The approvals needed before access are granted to a requester. No approvals are needed if this field is null.
$this
getPrivilegedAccess
The access granted to a requester on successful approval.
hasPrivilegedAccess
clearPrivilegedAccess
setPrivilegedAccess
The access granted to a requester on successful approval.
$this
getMaxRequestDuration
Required. The maximum amount of time that access is granted for a request.
A requester can ask for a duration less than this, but never more.
hasMaxRequestDuration
clearMaxRequestDuration
setMaxRequestDuration
Required. The maximum amount of time that access is granted for a request.
A requester can ask for a duration less than this, but never more.
$this
getState
Output only. Current state of this entitlement.
int
setState
Output only. Current state of this entitlement.
var
int
$this
getRequesterJustificationConfig
Required. The manner in which the requester should provide a justification for requesting access.
hasRequesterJustificationConfig
clearRequesterJustificationConfig
setRequesterJustificationConfig
Required. The manner in which the requester should provide a justification for requesting access.
$this
getAdditionalNotificationTargets
Optional. Additional email addresses to be notified based on actions taken.
hasAdditionalNotificationTargets
clearAdditionalNotificationTargets
setAdditionalNotificationTargets
Optional. Additional email addresses to be notified based on actions taken.
$this
getEtag
An etag
is used for optimistic concurrency control as a way to prevent
simultaneous updates to the same entitlement. An etag
is returned in the
response to GetEntitlement
and the caller should put the etag
in the
request to UpdateEntitlement
so that their change is applied on
the same version. If this field is omitted or if there is a mismatch while
updating an entitlement, then the server rejects the request.
string
setEtag
An etag
is used for optimistic concurrency control as a way to prevent
simultaneous updates to the same entitlement. An etag
is returned in the
response to GetEntitlement
and the caller should put the etag
in the
request to UpdateEntitlement
so that their change is applied on
the same version. If this field is omitted or if there is a mismatch while
updating an entitlement, then the server rejects the request.
var
string
$this
