Access Approval V1 API - Class Google::Cloud::AccessApproval::V1::AccessApprovalSettings (v0.11.2)

Reference documentation and code samples for the Access Approval V1 API class Google::Cloud::AccessApproval::V1::AccessApprovalSettings.

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

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#active_key_version

def active_key_version() -> ::String
Returns
  • (::String) — 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.

#active_key_version=

def active_key_version=(value) -> ::String
Parameter
  • value (::String) — 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.
Returns
  • (::String) — 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.

#ancestor_has_active_key_version

def ancestor_has_active_key_version() -> ::Boolean
Returns
  • (::Boolean) — 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).

#enrolled_ancestor

def enrolled_ancestor() -> ::Boolean
Returns
  • (::Boolean) — 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).

#enrolled_services

def enrolled_services() -> ::Array<::Google::Cloud::AccessApproval::V1::EnrolledService>
Returns
  • (::Array<::Google::Cloud::AccessApproval::V1::EnrolledService>) — 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.

#enrolled_services=

def enrolled_services=(value) -> ::Array<::Google::Cloud::AccessApproval::V1::EnrolledService>
Parameter
  • value (::Array<::Google::Cloud::AccessApproval::V1::EnrolledService>) — 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.

Returns
  • (::Array<::Google::Cloud::AccessApproval::V1::EnrolledService>) — 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.

#invalid_key_version

def invalid_key_version() -> ::Boolean
Returns
  • (::Boolean) — 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.

#name

def name() -> ::String
Returns
  • (::String) —

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

    • "projects/{project}/accessApprovalSettings"
    • "folders/{folder}/accessApprovalSettings"
    • "organizations/{organization}/accessApprovalSettings"

#name=

def name=(value) -> ::String
Parameter
  • value (::String) —

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

    • "projects/{project}/accessApprovalSettings"
    • "folders/{folder}/accessApprovalSettings"
    • "organizations/{organization}/accessApprovalSettings"
Returns
  • (::String) —

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

    • "projects/{project}/accessApprovalSettings"
    • "folders/{folder}/accessApprovalSettings"
    • "organizations/{organization}/accessApprovalSettings"

#notification_emails

def notification_emails() -> ::Array<::String>
Returns
  • (::Array<::String>) — 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.

#notification_emails=

def notification_emails=(value) -> ::Array<::String>
Parameter
  • value (::Array<::String>) — 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.
Returns
  • (::Array<::String>) — 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.