Access Approval v1 API - Class AccessApprovalSettings (2.4.0) 

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

Reference documentation and code samples for the Access Approval v1 API class AccessApprovalSettings.

Settings on a Project/Folder/Organization related to Access Approval.

Inheritance

object > AccessApprovalSettings

Namespace

Google.Cloud.AccessApproval.V1

Assembly

Google.Cloud.AccessApproval.V1.dll

Constructors

AccessApprovalSettings()

public AccessApprovalSettings()

AccessApprovalSettings(AccessApprovalSettings)

public AccessApprovalSettings(AccessApprovalSettings other)
Parameter
Name Description
other AccessApprovalSettings

Properties

AccessApprovalSettingsName

public AccessApprovalSettingsName AccessApprovalSettingsName { get; set; }

AccessApprovalSettingsName-typed view over the Name resource name property.

Property Value
Type Description
AccessApprovalSettingsName

ActiveKeyVersion

public string ActiveKeyVersion { get; set; }

The asymmetric crypto key version to use for signing approval requests. Empty active_key_version indicates that a Google-managed key should be used for signing. This property will be ignored if set by an ancestor of this resource, and new non-empty values may not be set.

Property Value
Type Description
string

AncestorHasActiveKeyVersion

public bool AncestorHasActiveKeyVersion { get; set; }

Output only. This field is read only (not settable via UpdateAccessApprovalSettings method). If the field is true, that indicates that an ancestor of this Project or Folder has set active_key_version (this field will always be unset for the organization since organizations do not have ancestors).

Property Value
Type Description
bool

EnrolledAncestor

public bool EnrolledAncestor { get; set; }

Output only. This field is read only (not settable via UpdateAccessApprovalSettings method). If the field is true, that indicates that at least one service is enrolled for Access Approval in one or more ancestors of the Project or Folder (this field will always be unset for the organization since organizations do not have ancestors).

Property Value
Type Description
bool

EnrolledServices

public RepeatedField<EnrolledService> EnrolledServices { get; }

A list of Google Cloud Services for which the given resource has Access Approval enrolled. Access requests for the resource given by name against any of these services contained here will be required to have explicit approval. If name refers to an organization, enrollment can be done for individual services. If name refers to a folder or project, enrollment can only be done on an all or nothing basis.

If a cloud_product is repeated in this list, the first entry will be honored and all following entries will be discarded. A maximum of 10 enrolled services will be enforced, to be expanded as the set of supported services is expanded.

Property Value
Type Description
RepeatedFieldEnrolledService

InvalidKeyVersion

public bool InvalidKeyVersion { get; set; }

Output only. This field is read only (not settable via UpdateAccessApprovalSettings method). If the field is true, that indicates that there is some configuration issue with the active_key_version configured at this level in the resource hierarchy (e.g. it doesn't exist or the Access Approval service account doesn't have the correct permissions on it, etc.) This key version is not necessarily the effective key version at this level, as key versions are inherited top-down.

Property Value
Type Description
bool

Name

public string Name { get; set; }

The resource name of the settings. Format is one of:

  • "projects/{project}/accessApprovalSettings"
  • "folders/{folder}/accessApprovalSettings"
  • "organizations/{organization}/accessApprovalSettings"
Property Value
Type Description
string

NotificationEmails

public RepeatedField<string> NotificationEmails { get; }

A list of email addresses to which notifications relating to approval requests should be sent. Notifications relating to a resource will be sent to all emails in the settings of ancestor resources of that resource. A maximum of 50 email addresses are allowed.

Property Value
Type Description
RepeatedFieldstring