Privileged Access Manager v1 API - Class Entitlement (1.0.0-beta01)

public sealed class Entitlement : IMessage<Entitlement>, IEquatable<Entitlement>, IDeepCloneable<Entitlement>, IBufferMessage, IMessage

Reference documentation and code samples for the Privileged Access Manager v1 API 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.

Inheritance

object > Entitlement

Namespace

Google.Cloud.PrivilegedAccessManager.V1

Assembly

Google.Cloud.PrivilegedAccessManager.V1.dll

Constructors

Entitlement()

public Entitlement()

Entitlement(Entitlement)

public Entitlement(Entitlement other)
Parameter
Name Description
other Entitlement

Properties

AdditionalNotificationTargets

public Entitlement.Types.AdditionalNotificationTargets AdditionalNotificationTargets { get; set; }

Optional. Additional email addresses to be notified based on actions taken.

Property Value
Type Description
EntitlementTypesAdditionalNotificationTargets

ApprovalWorkflow

public ApprovalWorkflow ApprovalWorkflow { get; set; }

Optional. The approvals needed before access are granted to a requester. No approvals are needed if this field is null.

Property Value
Type Description
ApprovalWorkflow

CreateTime

public Timestamp CreateTime { get; set; }

Output only. Create time stamp.

Property Value
Type Description
Timestamp

EligibleUsers

public RepeatedField<AccessControlEntry> EligibleUsers { get; }

Optional. Who can create grants using this entitlement. This list should contain at most one entry.

Property Value
Type Description
RepeatedFieldAccessControlEntry

EntitlementName

public EntitlementName EntitlementName { get; set; }

EntitlementName-typed view over the Name resource name property.

Property Value
Type Description
EntitlementName

Etag

public string Etag { get; set; }

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.

Property Value
Type Description
string

MaxRequestDuration

public Duration MaxRequestDuration { get; set; }

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.

Property Value
Type Description
Duration

Name

public string Name { get; set; }

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}
Property Value
Type Description
string

PrivilegedAccess

public PrivilegedAccess PrivilegedAccess { get; set; }

The access granted to a requester on successful approval.

Property Value
Type Description
PrivilegedAccess

RequesterJustificationConfig

public Entitlement.Types.RequesterJustificationConfig RequesterJustificationConfig { get; set; }

Required. The manner in which the requester should provide a justification for requesting access.

Property Value
Type Description
EntitlementTypesRequesterJustificationConfig

State

public Entitlement.Types.State State { get; set; }

Output only. Current state of this entitlement.

Property Value
Type Description
EntitlementTypesState

UpdateTime

public Timestamp UpdateTime { get; set; }

Output only. Update time stamp.

Property Value
Type Description
Timestamp