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
defactive_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=
defactive_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
defancestor_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
defenrolled_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).
(::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.
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
definvalid_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
defname()->::String
Returns
(::String) —
The resource name of the settings. Format is one of:
(::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=
defnotification_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.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-09-09 UTC."],[],[],null,["# Access Approval V1 API - Class Google::Cloud::AccessApproval::V1::AccessApprovalSettings (v1.3.0)\n\nVersion latestkeyboard_arrow_down\n\n- [1.3.0 (latest)](/ruby/docs/reference/google-cloud-access_approval-v1/latest/Google-Cloud-AccessApproval-V1-AccessApprovalSettings)\n- [1.2.1](/ruby/docs/reference/google-cloud-access_approval-v1/1.2.1/Google-Cloud-AccessApproval-V1-AccessApprovalSettings)\n- [1.1.0](/ruby/docs/reference/google-cloud-access_approval-v1/1.1.0/Google-Cloud-AccessApproval-V1-AccessApprovalSettings)\n- [1.0.2](/ruby/docs/reference/google-cloud-access_approval-v1/1.0.2/Google-Cloud-AccessApproval-V1-AccessApprovalSettings)\n- [0.12.0](/ruby/docs/reference/google-cloud-access_approval-v1/0.12.0/Google-Cloud-AccessApproval-V1-AccessApprovalSettings)\n- [0.11.2](/ruby/docs/reference/google-cloud-access_approval-v1/0.11.2/Google-Cloud-AccessApproval-V1-AccessApprovalSettings)\n- [0.10.0](/ruby/docs/reference/google-cloud-access_approval-v1/0.10.0/Google-Cloud-AccessApproval-V1-AccessApprovalSettings)\n- [0.9.0](/ruby/docs/reference/google-cloud-access_approval-v1/0.9.0/Google-Cloud-AccessApproval-V1-AccessApprovalSettings)\n- [0.8.0](/ruby/docs/reference/google-cloud-access_approval-v1/0.8.0/Google-Cloud-AccessApproval-V1-AccessApprovalSettings)\n- [0.7.1](/ruby/docs/reference/google-cloud-access_approval-v1/0.7.1/Google-Cloud-AccessApproval-V1-AccessApprovalSettings)\n- [0.6.0](/ruby/docs/reference/google-cloud-access_approval-v1/0.6.0/Google-Cloud-AccessApproval-V1-AccessApprovalSettings)\n- [0.5.0](/ruby/docs/reference/google-cloud-access_approval-v1/0.5.0/Google-Cloud-AccessApproval-V1-AccessApprovalSettings)\n- [0.4.5](/ruby/docs/reference/google-cloud-access_approval-v1/0.4.5/Google-Cloud-AccessApproval-V1-AccessApprovalSettings) \nReference documentation and code samples for the Access Approval V1 API class Google::Cloud::AccessApproval::V1::AccessApprovalSettings.\n\nSettings on a Project/Folder/Organization related to Access Approval. \n\nInherits\n--------\n\n- Object \n\nExtended By\n-----------\n\n- Google::Protobuf::MessageExts::ClassMethods \n\nIncludes\n--------\n\n- Google::Protobuf::MessageExts\n\nMethods\n-------\n\n### #active_key_version\n\n def active_key_version() -\u003e ::String\n\n**Returns**\n\n- (::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.\n\n### #active_key_version=\n\n def active_key_version=(value) -\u003e ::String\n\n**Parameter**\n\n- **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. \n**Returns**\n\n- (::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.\n\n### #ancestor_has_active_key_version\n\n def ancestor_has_active_key_version() -\u003e ::Boolean\n\n**Returns**\n\n- (::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).\n\n### #enrolled_ancestor\n\n def enrolled_ancestor() -\u003e ::Boolean\n\n**Returns**\n\n- (::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).\n\n### #enrolled_services\n\n def enrolled_services() -\u003e ::Array\u003c::Google::Cloud::AccessApproval::V1::EnrolledService\u003e\n\n**Returns**\n\n- (::Array\\\u003c[::Google::Cloud::AccessApproval::V1::EnrolledService](./Google-Cloud-AccessApproval-V1-EnrolledService)\\\u003e) --- 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.\n\n\n If a cloud_product is repeated in this list, the first entry will be\n honored and all following entries will be discarded. A maximum of 10\n enrolled services will be enforced, to be expanded as the set of supported\n services is expanded.\n\n### #enrolled_services=\n\n def enrolled_services=(value) -\u003e ::Array\u003c::Google::Cloud::AccessApproval::V1::EnrolledService\u003e\n\n**Parameter**\n\n- **value** (::Array\\\u003c[::Google::Cloud::AccessApproval::V1::EnrolledService](./Google-Cloud-AccessApproval-V1-EnrolledService)\\\u003e) --- 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.\n\n\n If a cloud_product is repeated in this list, the first entry will be\n honored and all following entries will be discarded. A maximum of 10\n enrolled services will be enforced, to be expanded as the set of supported\nservices is expanded. \n**Returns**\n\n- (::Array\\\u003c[::Google::Cloud::AccessApproval::V1::EnrolledService](./Google-Cloud-AccessApproval-V1-EnrolledService)\\\u003e) --- 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.\n\n\n If a cloud_product is repeated in this list, the first entry will be\n honored and all following entries will be discarded. A maximum of 10\n enrolled services will be enforced, to be expanded as the set of supported\n services is expanded.\n\n### #invalid_key_version\n\n def invalid_key_version() -\u003e ::Boolean\n\n**Returns**\n\n- (::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.\n\n### #name\n\n def name() -\u003e ::String\n\n**Returns**\n\n- (::String) --- The resource name of the settings. Format is one of:\n\n - \"projects/{project}/accessApprovalSettings\"\n - \"folders/{folder}/accessApprovalSettings\"\n - \"organizations/{organization}/accessApprovalSettings\"\n\n### #name=\n\n def name=(value) -\u003e ::String\n\n**Parameter**\n\n- **value** (::String) ---\n\n The resource name of the settings. Format is one of:\n - \"projects/{project}/accessApprovalSettings\"\n - \"folders/{folder}/accessApprovalSettings\"\n- \"organizations/{organization}/accessApprovalSettings\" \n**Returns**\n\n- (::String) --- The resource name of the settings. Format is one of:\n\n - \"projects/{project}/accessApprovalSettings\"\n - \"folders/{folder}/accessApprovalSettings\"\n - \"organizations/{organization}/accessApprovalSettings\"\n\n### #notification_emails\n\n def notification_emails() -\u003e ::Array\u003c::String\u003e\n\n**Returns**\n\n- (::Array\\\u003c::String\\\u003e) --- 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.\n\n### #notification_emails=\n\n def notification_emails=(value) -\u003e ::Array\u003c::String\u003e\n\n**Parameter**\n\n- **value** (::Array\\\u003c::String\\\u003e) --- 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. \n**Returns**\n\n- (::Array\\\u003c::String\\\u003e) --- 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."]]
