class OCI::Audit::AuditClient

API for the Audit Service. Use this API for compliance monitoring in your tenancy. For more information, see [Overview of Audit](/iaas/Content/Audit/Concepts/auditoverview.htm).

Tip: This API is good for queries, but not bulk-export operations.

Attributes

api_client[R]

Client used to make HTTP requests. @return [OCI::ApiClient]

endpoint[R]

Fully qualified endpoint URL @return [String]

region[R]

The region, which will usually correspond to a value in {OCI::Regions::REGION_ENUM}. @return [String]

retry_config[R]

The default retry configuration to apply to all operations in this service client. This can be overridden on a per-operation basis. The default retry configuration value is `nil`, which means that an operation will not perform any retries @return [OCI::Retry::RetryConfig]

Public Class Methods

new(config: nil, region: nil, endpoint: nil, signer: nil, proxy_settings: nil, retry_config: nil) click to toggle source

Creates a new AuditClient. Notes:

If a config is not specified, then the global OCI.config will be used.

This client is not thread-safe

Either a region or an endpoint must be specified.  If an endpoint is specified, it will be used instead of the
  region. A region may be specified in the config or via or the region parameter. If specified in both, then the
  region parameter will be used.

@param [Config] config A Config object. @param [String] region A region used to determine the service endpoint. This will usually

correspond to a value in {OCI::Regions::REGION_ENUM}, but may be an arbitrary string.

@param [String] endpoint The fully qualified endpoint URL @param [OCI::BaseSigner] signer A signer implementation which can be used by this client. If this is not provided then

a signer will be constructed via the provided config. One use case of this parameter is instance principals authentication,
so that the instance principals signer can be provided to the client

@param [OCI::ApiClientProxySettings] proxy_settings If your environment requires you to use a proxy server for outgoing HTTP requests

the details for the proxy can be provided in this parameter

@param [OCI::Retry::RetryConfig] retry_config The retry configuration for this service client. This represents the default retry configuration to

apply across all operations. This can be overridden on a per-operation basis. The default retry configuration value is `nil`, which means that an operation
will not perform any retries
# File lib/oci/audit/audit_client.rb, line 56
def initialize(config: nil, region: nil, endpoint: nil, signer: nil, proxy_settings: nil, retry_config: nil)
  # If the signer is an InstancePrincipalsSecurityTokenSigner or SecurityTokenSigner and no config was supplied (they are self-sufficient signers)
  # then create a dummy config to pass to the ApiClient constructor. If customers wish to create a client which uses instance principals
  # and has config (either populated programmatically or loaded from a file), they must construct that config themselves and then
  # pass it to this constructor.
  #
  # If there is no signer (or the signer is not an instance principals signer) and no config was supplied, this is not valid
  # so try and load the config from the default file.
  config = OCI::Config.validate_and_build_config_with_signer(config, signer)

  signer = OCI::Signer.config_file_auth_builder(config) if signer.nil?

  @api_client = OCI::ApiClient.new(config, signer, proxy_settings: proxy_settings)
  @retry_config = retry_config

  if endpoint
    @endpoint = endpoint + '/20190901'
  else
    region ||= config.region
    region ||= signer.region if signer.respond_to?(:region)
    self.region = region
  end
  logger.info "AuditClient endpoint set to '#{@endpoint}'." if logger
end

Public Instance Methods

get_configuration(compartment_id, opts = {}) click to toggle source

Get the configuration @param [String] compartment_id ID of the root compartment (tenancy) @param [Hash] opts the optional parameters @option opts [OCI::Retry::RetryConfig] :retry_config The retry configuration to apply to this operation. If no key is provided then the service-level

retry configuration defined by {#retry_config} will be used. If an explicit `nil` value is provided then the operation will not retry

@return [Response] A Response object with data of type {OCI::Audit::Models::Configuration Configuration} @note Click [here](docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/audit/get_configuration.rb.html) to see an example of how to use get_configuration API.

# File lib/oci/audit/audit_client.rb, line 112
def get_configuration(compartment_id, opts = {})
  logger.debug 'Calling operation AuditClient#get_configuration.' if logger

  raise "Missing the required parameter 'compartment_id' when calling get_configuration." if compartment_id.nil?

  path = '/configuration'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:compartmentId] = compartment_id

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'AuditClient#get_configuration') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::Audit::Models::Configuration'
    )
  end
  # rubocop:enable Metrics/BlockLength
end
list_events(compartment_id, start_time, end_time, opts = {}) click to toggle source

Returns all the audit events processed for the specified compartment within the specified time range.

@param [String] compartment_id The [OCID](docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the compartment. @param [DateTime] start_time Returns events that were processed at or after this start date and time, expressed in

[RFC 3339](https://tools.ietf.org/html/rfc3339) timestamp format.

For example, a start value of `2017-01-15T11:30:00Z` will retrieve a list of all events processed
since 30 minutes after the 11th hour of January 15, 2017, in Coordinated Universal Time (UTC).
You can specify a value with granularity to the minute. Seconds (and milliseconds, if included) must
be set to `0`.

@param [DateTime] end_time Returns events that were processed before this end date and time, expressed in

[RFC 3339](https://tools.ietf.org/html/rfc3339) timestamp format.

For example, a start value of `2017-01-01T00:00:00Z` and an end value of `2017-01-02T00:00:00Z`
will retrieve a list of all events processed on January 1, 2017. Similarly, a start value of
`2017-01-01T00:00:00Z` and an end value of `2017-02-01T00:00:00Z` will result in a list of all
events processed between January 1, 2017 and January 31, 2017. You can specify a value with
granularity to the minute. Seconds (and milliseconds, if included) must be set to `0`.

@param [Hash] opts the optional parameters @option opts [OCI::Retry::RetryConfig] :retry_config The retry configuration to apply to this operation. If no key is provided then the service-level

retry configuration defined by {#retry_config} will be used. If an explicit `nil` value is provided then the operation will not retry

@option opts [String] :page For list pagination. The value of the `opc-next-page` response header from the previous "List" call.

For important details about how pagination works, see [List Pagination](https://docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).

@option opts [String] :opc_request_id Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a

particular request, please provide the request ID.

@return [Response] A Response object with data of type Array<{OCI::Audit::Models::AuditEvent AuditEvent}> @note Click [here](docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/audit/list_events.rb.html) to see an example of how to use list_events API.

# File lib/oci/audit/audit_client.rb, line 190
def list_events(compartment_id, start_time, end_time, opts = {})
  logger.debug 'Calling operation AuditClient#list_events.' if logger

  raise "Missing the required parameter 'compartment_id' when calling list_events." if compartment_id.nil?
  raise "Missing the required parameter 'start_time' when calling list_events." if start_time.nil?
  raise "Missing the required parameter 'end_time' when calling list_events." if end_time.nil?

  path = '/auditEvents'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:compartmentId] = compartment_id
  query_params[:startTime] = start_time
  query_params[:endTime] = end_time
  query_params[:page] = opts[:page] if opts[:page]

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'AuditClient#list_events') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'Array<OCI::Audit::Models::AuditEvent>'
    )
  end
  # rubocop:enable Metrics/BlockLength
end
logger() click to toggle source

@return [Logger] The logger for this client. May be nil.

# File lib/oci/audit/audit_client.rb, line 95
def logger
  @api_client.config.logger
end
region=(new_region) click to toggle source

Set the region that will be used to determine the service endpoint. This will usually correspond to a value in {OCI::Regions::REGION_ENUM}, but may be an arbitrary string.

# File lib/oci/audit/audit_client.rb, line 85
def region=(new_region)
  @region = new_region

  raise 'A region must be specified.' unless @region

  @endpoint = OCI::Regions.get_service_endpoint_for_template(@region, 'https://audit.{region}.{secondLevelDomain}') + '/20190901'
  logger.info "AuditClient endpoint set to '#{@endpoint} from region #{@region}'." if logger
end
update_configuration(compartment_id, update_configuration_details, opts = {}) click to toggle source

Update the configuration @param [String] compartment_id ID of the root compartment (tenancy) @param [OCI::Audit::Models::UpdateConfigurationDetails] update_configuration_details The configuration properties @param [Hash] opts the optional parameters @option opts [OCI::Retry::RetryConfig] :retry_config The retry configuration to apply to this operation. If no key is provided then the service-level

retry configuration defined by {#retry_config} will be used. If an explicit `nil` value is provided then the operation will not retry

@return [Response] A Response object with data of type nil @note Click [here](docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/audit/update_configuration.rb.html) to see an example of how to use update_configuration API.

# File lib/oci/audit/audit_client.rb, line 250
def update_configuration(compartment_id, update_configuration_details, opts = {})
  logger.debug 'Calling operation AuditClient#update_configuration.' if logger

  raise "Missing the required parameter 'compartment_id' when calling update_configuration." if compartment_id.nil?
  raise "Missing the required parameter 'update_configuration_details' when calling update_configuration." if update_configuration_details.nil?

  path = '/configuration'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:compartmentId] = compartment_id

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  # rubocop:enable Style/NegatedIf

  post_body = @api_client.object_to_http_body(update_configuration_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'AuditClient#update_configuration') do
    @api_client.call_api(
      :PUT,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body
    )
  end
  # rubocop:enable Metrics/BlockLength
end

Private Instance Methods

applicable_retry_config(opts = {}) click to toggle source

rubocop:enable Metrics/CyclomaticComplexity, Metrics/AbcSize, Metrics/PerceivedComplexity rubocop:enable Style/IfUnlessModifier, Metrics/ParameterLists rubocop:enable Metrics/MethodLength, Layout/EmptyLines rubocop:enable Lint/UnusedMethodArgument

# File lib/oci/audit/audit_client.rb, line 293
def applicable_retry_config(opts = {})
  return @retry_config unless opts.key?(:retry_config)

  opts[:retry_config]
end