IAM API - Class Google::Iam::V1::AuditConfig (v0.1.0)
Stay organized with collections
Save and categorize content based on your preferences.
Reference documentation and code samples for the IAM API class Google::Iam::V1::AuditConfig.
Specifies the audit configuration for a service.
The configuration determines which permission types are logged, and what
identities, if any, are exempted from logging.
An AuditConfig must have one or more AuditLogConfigs.
If there are AuditConfigs for both allServices and a specific service,
the union of the two AuditConfigs is used for that service: the log_types
specified in each AuditConfig are enabled, and the exempted_members in each
AuditLogConfig are exempted.
For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ
logging. It also exempts jose@example.com from DATA_READ logging, and
aliya@example.com from DATA_WRITE logging.
(::String) — Specifies a service that will be enabled for audit logging.
For example, storage.googleapis.com, cloudsql.googleapis.com.
allServices is a special value that covers all services.
#service=
defservice=(value)->::String
Parameter
value (::String) — Specifies a service that will be enabled for audit logging.
For example, storage.googleapis.com, cloudsql.googleapis.com.
allServices is a special value that covers all services.
Returns
(::String) — Specifies a service that will be enabled for audit logging.
For example, storage.googleapis.com, cloudsql.googleapis.com.
allServices is a special value that covers all services.
[[["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-08-28 UTC."],[],[],null,["# IAM API - Class Google::Iam::V1::AuditConfig (v0.1.0)\n\nReference documentation and code samples for the IAM API class Google::Iam::V1::AuditConfig.\n\nSpecifies the audit configuration for a service.\nThe configuration determines which permission types are logged, and what\nidentities, if any, are exempted from logging.\nAn AuditConfig must have one or more AuditLogConfigs.\n\n\nIf there are AuditConfigs for both `allServices` and a specific service,\nthe union of the two AuditConfigs is used for that service: the log_types\nspecified in each AuditConfig are enabled, and the exempted_members in each\nAuditLogConfig are exempted.\n\nExample Policy with multiple AuditConfigs: \n\n {\n \"audit_configs\": [\n {\n \"service\": \"allServices\",\n \"audit_log_configs\": [\n {\n \"log_type\": \"DATA_READ\",\n \"exempted_members\": [\n \"user:jose@example.com\"\n ]\n },\n {\n \"log_type\": \"DATA_WRITE\"\n },\n {\n \"log_type\": \"ADMIN_READ\"\n }\n ]\n },\n {\n \"service\": \"sampleservice.googleapis.com\",\n \"audit_log_configs\": [\n {\n \"log_type\": \"DATA_READ\"\n },\n {\n \"log_type\": \"DATA_WRITE\",\n \"exempted_members\": [\n \"user:aliya@example.com\"\n ]\n }\n ]\n }\n ]\n }\n\n\u003cbr /\u003e\n\nFor sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ\nlogging. It also exempts jose@example.com from DATA_READ logging, and\naliya@example.com from DATA_WRITE logging. \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### #audit_log_configs\n\n def audit_log_configs() -\u003e ::Array\u003c::Google::Iam::V1::AuditLogConfig\u003e\n\n**Returns**\n\n- (::Array\\\u003c[::Google::Iam::V1::AuditLogConfig](./Google-Iam-V1-AuditLogConfig)\\\u003e) --- The configuration for logging of each type of permission.\n\n### #audit_log_configs=\n\n def audit_log_configs=(value) -\u003e ::Array\u003c::Google::Iam::V1::AuditLogConfig\u003e\n\n**Parameter**\n\n- **value** (::Array\\\u003c[::Google::Iam::V1::AuditLogConfig](./Google-Iam-V1-AuditLogConfig)\\\u003e) --- The configuration for logging of each type of permission. \n**Returns**\n\n- (::Array\\\u003c[::Google::Iam::V1::AuditLogConfig](./Google-Iam-V1-AuditLogConfig)\\\u003e) --- The configuration for logging of each type of permission.\n\n### #service\n\n def service() -\u003e ::String\n\n**Returns**\n\n- (::String) --- Specifies a service that will be enabled for audit logging. For example, `storage.googleapis.com`, `cloudsql.googleapis.com`. `allServices` is a special value that covers all services.\n\n### #service=\n\n def service=(value) -\u003e ::String\n\n**Parameter**\n\n- **value** (::String) --- Specifies a service that will be enabled for audit logging. For example, `storage.googleapis.com`, `cloudsql.googleapis.com`. `allServices` is a special value that covers all services. \n**Returns**\n\n- (::String) --- Specifies a service that will be enabled for audit logging. For example, `storage.googleapis.com`, `cloudsql.googleapis.com`. `allServices` is a special value that covers all services."]]