Show / Hide Table of Contents

Class AccessApprovalSettings

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

Inheritance
object
AccessApprovalSettings
Implements
IDirectResponseSchema
Inherited Members
object.Equals(object)
object.Equals(object, object)
object.GetHashCode()
object.GetType()
object.MemberwiseClone()
object.ReferenceEquals(object, object)
object.ToString()
Namespace: Google.Apis.AccessApproval.v1.Data
Assembly: Google.Apis.AccessApproval.v1.dll
Syntax
public class AccessApprovalSettings : IDirectResponseSchema

Properties

ActiveKeyVersion

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.

Declaration
[JsonProperty("activeKeyVersion")]
public virtual string ActiveKeyVersion { get; set; }
Property Value
Type Description
string

AncestorHasActiveKeyVersion

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).

Declaration
[JsonProperty("ancestorHasActiveKeyVersion")]
public virtual bool? AncestorHasActiveKeyVersion { get; set; }
Property Value
Type Description
bool?

ApprovalPolicy

Optional. Policy configuration for Access Approval that sets the operating mode. The available policies are Transparency, Streamlined Support, and Approval Required.

Declaration
[JsonProperty("approvalPolicy")]
public virtual CustomerApprovalApprovalPolicy ApprovalPolicy { get; set; }
Property Value
Type Description
CustomerApprovalApprovalPolicy

ETag

The ETag of the item.

Declaration
public virtual string ETag { get; set; }
Property Value
Type Description
string

EffectiveApprovalPolicy

Output only. Effective policy applied for Access Approval, inclusive of inheritance.

Declaration
[JsonProperty("effectiveApprovalPolicy")]
public virtual CustomerApprovalApprovalPolicy EffectiveApprovalPolicy { get; set; }
Property Value
Type Description
CustomerApprovalApprovalPolicy

EnrolledAncestor

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).

Declaration
[JsonProperty("enrolledAncestor")]
public virtual bool? EnrolledAncestor { get; set; }
Property Value
Type Description
bool?

EnrolledServices

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.

Declaration
[JsonProperty("enrolledServices")]
public virtual IList<EnrolledService> EnrolledServices { get; set; }
Property Value
Type Description
IList<EnrolledService>

InvalidKeyVersion

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.

Declaration
[JsonProperty("invalidKeyVersion")]
public virtual bool? InvalidKeyVersion { get; set; }
Property Value
Type Description
bool?

Name

The resource name of the settings. Format is one of: * "projects/{project}/accessApprovalSettings" * "folders/{folder}/accessApprovalSettings" * "organizations/{organization}/accessApprovalSettings"

Declaration
[JsonProperty("name")]
public virtual string Name { get; set; }
Property Value
Type Description
string

NotificationEmails

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.

Declaration
[JsonProperty("notificationEmails")]
public virtual IList<string> NotificationEmails { get; set; }
Property Value
Type Description
IList<string>

NotificationPubsubTopic

Optional. A pubsub topic that notifications relating to access approval are published to. Notifications include pre-approved accesses.

Declaration
[JsonProperty("notificationPubsubTopic")]
public virtual string NotificationPubsubTopic { get; set; }
Property Value
Type Description
string

PreferNoBroadApprovalRequests

This field is used to set a preference for granularity of an access approval request. If true, Google personnel will be asked to send resource-level requests when possible. If false, Google personnel will be asked to send requests at the project level.

Declaration
[JsonProperty("preferNoBroadApprovalRequests")]
public virtual bool? PreferNoBroadApprovalRequests { get; set; }
Property Value
Type Description
bool?

PreferredRequestExpirationDays

Set the default access approval request expiration time. This value is able to be set directly by the customer at the time of approval, overriding this suggested value. We recommend setting this value to 30 days.

Declaration
[JsonProperty("preferredRequestExpirationDays")]
public virtual int? PreferredRequestExpirationDays { get; set; }
Property Value
Type Description
int?

RequestScopeMaxWidthPreference

Optional. A setting that indicates the maximum scope of an Access Approval request: either organization, folder, or project. Google administrators will be asked to send requests no broader than the configured scope.

Declaration
[JsonProperty("requestScopeMaxWidthPreference")]
public virtual string RequestScopeMaxWidthPreference { get; set; }
Property Value
Type Description
string

RequireCustomerVisibleJustification

Optional. When enabled, Google will only be able to send approval requests for access reasons with a customer accessible case ID in the reason detail. Also known as "Require customer initiated support case justification"

Declaration
[JsonProperty("requireCustomerVisibleJustification")]
public virtual bool? RequireCustomerVisibleJustification { get; set; }
Property Value
Type Description
bool?

Implements

IDirectResponseSchema
In this article
Back to top Generated by DocFX