openapi: 3.2.0
info:
  description: '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.

    '
  license:
    name: Oracle Corporation
  title: Audit API
  version: '20190901'
  x-provenance:
    method: harvested
    first_party: true
    publisher: Oracle
    source: https://docs.oracle.com/en-us/iaas/api/specs/a92c1b8661432d4112968ecbe805522122f66f9e5afabe9e1e072ef9ddf3a674.yaml
    harvested: '2026-08-04'
    note: Published by Oracle as the contract for the Audit API OCI service and stored verbatim; API Evangelist added only this provenance block.
  x-evidence:
  - url: https://docs.oracle.com/en-us/iaas/api/specs/index.json
    what: Oracle's own index of every OCI service specification
  - url: https://docs.oracle.com/en-us/iaas/api/specs/a92c1b8661432d4112968ecbe805522122f66f9e5afabe9e1e072ef9ddf3a674.yaml
    what: the harvested document for Audit API
servers:
- url: https://localhost:1980/20190901
tags:
- name: Audit
paths:
  /auditEvents:
    get:
      description: 'Returns all the audit events processed for the specified compartment within the specified

        time range.

        '
      operationId: ListEvents
      parameters:
      - $ref: '#/components/parameters/CompartmentIdQueryParam'
      - $ref: '#/components/parameters/StartWithQueryParam'
      - $ref: '#/components/parameters/EndBeforeQueryParam'
      - $ref: '#/components/parameters/PaginationTokenQueryParam'
      - $ref: '#/components/parameters/RequestIdHeader'
      responses:
        200:
          description: The list of audit events matching the specified time range.
          headers:
            opc-next-page:
              description: 'For pagination of a list of audit events. When this header appears in the response,

                it means you received a partial list and there are more results. Include this value as the `page`

                parameter for the subsequent ListEvents request to get the next batch of events. For important

                details about how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).

                '
              schema:
                type: string
            opc-request-id:
              description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about

                a particular request, please provide the request ID.

                '
              schema:
                type: string
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/AuditEvent'
                type: array
        400:
          $ref: '#/components/responses/400'
        401:
          $ref: '#/components/responses/401'
        404:
          $ref: '#/components/responses/404'
        429:
          $ref: '#/components/responses/429'
        500:
          $ref: '#/components/responses/500'
        default:
          $ref: '#/components/responses/DefaultError'
      summary: ListEvents
      tags:
      - Audit
      x-example: 'Syntax:


        GET /20190901/auditEvents?compartmentId=<var>&lt;compartment_OCID&gt;</var>&endTime=<var>&lt;end_timestamp&gt;</var>&startTime=<var>&lt;start_timestamp&gt;</var>


        Sample:


        GET /20190901/auditEvents?compartmentId=ocid1.compartment.region1..aaaaaaaaexample5gsmzi3hnumfjzstsgkzha74uc6jzpcxlxhx33hewsq&endTime=2017-01-06T00:22:00Z&startTime=2017-01-07T00:00:00Z HTTP/1.1


        Host: audit.us-phoenix-1.oraclecloud.com

        User-Agent: Apache-HttpClient/4.5.1 (Java/1.8.0_111)

        Accept: text/html,application/xhtml+xml,application/xml;q=0.9,*/*;q=0.8

        Accept-Language: en-US,en;q=0.5

        Accept-Encoding: gzip, deflate

        Opc-Client-Info: Oracle-HgConsole/0.0.1

        X-Date: Wed, 01 Feb 2017 18:09:22 GMT

        Opc-Request-Id: 4a0d1960-7929-4e00-b84e-5440a007ae09

        Authorization: <var>&lt;authorization string&gt;</var>

        Connection: keep-alive

        '
      x-related-resource: '#/definitions/AuditEvent'
  /configuration:
    get:
      description: Get the configuration
      operationId: GetConfiguration
      parameters:
      - $ref: '#/components/parameters/ConfigurationCompartmentIdQueryParam'
      responses:
        200:
          description: The configuration properties
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Configuration'
        400:
          $ref: '#/components/responses/400'
        401:
          $ref: '#/components/responses/401'
        404:
          $ref: '#/components/responses/404'
        500:
          $ref: '#/components/responses/500'
        default:
          $ref: '#/components/responses/DefaultError'
      summary: GetConfiguration
      tags:
      - Audit
      x-example: 'Syntax:


        GET /20190901/configuration?compartmentId=<var>&lt;compartment_OCID&gt;</var>


        Sample:


        GET /20190901/configuration?compartmentId=ocidv1.tenancy.oc1.phx.1457636318783.examplea3lagrhwsljxg6mk55eo2tfvxwy


        Host: audit.us-phoenix-1.oraclecloud.com

        Accept: */*

        Accept-Encoding: gzip, deflate, br

        Accept-Language: en-US,en;q=0.9

        Authorization: <var>&lt;authorization string&gt;</var>

        Connection: keep-alive

        opc-request-id: d42a4df0-9c36-45f9-b980-example94486

        User-Agent: Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/67.0.3396.99 Safari/537.36

        x-date: Mon, 09 Jul 2018 22:59:27 GMT

        '
    put:
      description: Update the configuration
      operationId: UpdateConfiguration
      parameters:
      - $ref: '#/components/parameters/ConfigurationCompartmentIdQueryParam'
      responses:
        202:
          description: The request was accepted for processing.
          headers:
            opc-request-id:
              description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a

                particular request, please provide the request ID.

                '
              schema:
                type: string
            opc-work-request-id:
              description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the work request.

                '
              schema:
                type: string
        400:
          $ref: '#/components/responses/400'
        401:
          $ref: '#/components/responses/401'
        404:
          $ref: '#/components/responses/404'
        500:
          $ref: '#/components/responses/500'
        default:
          $ref: '#/components/responses/DefaultError'
      summary: UpdateConfiguration
      tags:
      - Audit
      x-example: 'Syntax:


        PUT /20190901/configuration?compartmentId=<var>&lt;compartment_OCID&gt;</var>


        {

        "retentionPeriodDays": 90

        }


        Sample:


        PUT /20190901/configuration?compartmentId=ocidv1.tenancy.oc1.phx.1457636318783.examplea3lagrhwsljxg6mk55eo2tfvxwy


        Host: audit.us-phoenix-1.oraclecloud.com

        User-Agent: Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/67.0.3396.99 Safari/537.36

        Accept: */*

        Accept-Encoding: gzip, deflate, br

        Accept-Language: en-US,en;q=0.9

        Authorization: <var>&lt;authorization string&gt;</var>

        Connection: keep-alive

        Content-Length: 27

        Content-Type: application/json

        opc-request-id: 8b801765-e63d-4fb4-a3a9-example684c3a4

        x-date: Mon, 09 Jul 2018 22:55:13 GMT


        {

        "retentionPeriodDays": 90

        }

        '
      x-related-resource: '#/definitions/Configuration'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateConfigurationDetails'
        description: The configuration properties
        required: true
components:
  parameters:
    CompartmentIdQueryParam:
      description: The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment.
      in: query
      name: compartmentId
      required: true
      schema:
        type: string
        maxLength: 255
        minLength: 1
    ConfigurationCompartmentIdQueryParam:
      description: ID of the root compartment (tenancy)
      in: query
      name: compartmentId
      required: true
      schema:
        type: string
    PaginationTokenQueryParam:
      description: '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](/iaas/Content/API/Concepts/usingapi.htm#nine).

        '
      in: query
      name: page
      schema:
        type: string
        maxLength: 1024
        minLength: 1
    EndBeforeQueryParam:
      description: '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`.

        '
      in: query
      name: endTime
      required: true
      schema:
        type: string
        format: date-time
    RequestIdHeader:
      description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a

        particular request, please provide the request ID.

        '
      in: header
      name: opc-request-id
      schema:
        type: string
        pattern: '[A-Za-z0-9\\-_\\.]+'
    StartWithQueryParam:
      description: '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`.

        '
      in: query
      name: startTime
      required: true
      schema:
        type: string
        format: date-time
  schemas:
    stateChange:
      description: 'A container object for state change attributes.

        '
      properties:
        current:
          additionalProperties:
            type: object
          description: 'Provides the current state of fields that may have changed during an operation. To determine

            how the current operation changed a resource, compare the information in this attribute to

            `previous`.

            '
          type: object
        previous:
          additionalProperties:
            type: object
          description: 'Provides the previous state of fields that may have changed during an operation. To determine

            how the current operation changed a resource, compare the information in this attribute to

            `current`.

            '
          type: object
      type: object
      x-example: "{\n  \"previous\": null,\n  \"current\": null\n}\n"
    Configuration:
      description: 'The retention period setting, specified in days. For more information, see [Setting Audit

        Log Retention Period](/iaas/Content/Audit/Tasks/settingretentionperiod.htm).

        '
      properties:
        retentionPeriodDays:
          description: 'The retention period setting, specified in days. The minimum is 90, the maximum 365.


            Example: `90`

            '
          type: integer
      type: object
      x-example: "{\n  \"retentionPeriodDays\": 90\n}\n"
    UpdateConfigurationDetails:
      description: 'The configuration details for the retention period setting, specified in days. For more

        information, see [Setting Audit Log Retention Period](/iaas/Content/Audit/Tasks/settingretentionperiod.htm).

        '
      properties:
        retentionPeriodDays:
          description: 'The retention period setting, specified in days. The minimum is 90, the maximum 365.


            Example: `90`

            '
          maximum: 365
          minimum: 90
          type: integer
      required:
      - retentionPeriodDays
      type: object
      x-example: "{\n  \"retentionPeriodDays\": 90\n}\n"
    data:
      description: 'The payload of the event. Information within `data` comes from the resource emitting the event.

        '
      properties:
        additionalDetails:
          additionalProperties:
            type: object
          description: "A container object for attribues unique to the resource emitting the event.\n\nExample:\n\n  -----\n    {\n      \"imageId\": \"ocid1.image.oc1.phx.<unique_ID>\",\n      \"shape\": \"VM.Standard1.1\",\n      \"type\": \"CustomerVmi\"\n    }\n  -----\n"
          type: object
        availabilityDomain:
          description: 'The availability domain where the resource resides.

            '
          maxLength: 255
          minLength: 1
          type: string
        compartmentId:
          description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment of the resource

            emitting the event.

            '
          maxLength: 255
          minLength: 1
          type: string
        compartmentName:
          description: 'The name of the compartment. This value is the friendly name associated with compartmentId.

            This value can change, but the service logs the value that appeared at the time of the audit

            event.


            Example: `CompartmentA`

            '
          maxLength: 100
          minLength: 1
          type: string
        definedTags:
          additionalProperties:
            additionalProperties:
              description: 'The value of the tag. Only the String type is supported.

                '
              type: object
            description: 'Key-value pair representing a defined tag key and value, scoped to a namespace.


              Example: `{"CostCenter": "42"}''

              '
            type: object
          description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more

            information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm).


            Example: `{"Operations": {"CostCenter": "42"}}`

            '
          type: object
        eventGroupingId:
          description: 'This value links multiple audit events that are part of the same API operation. For example,

            a long running API operations that emit an event at the start and the end of an operation

            would use the same value in this field for both events.

            '
          maxLength: 255
          minLength: 1
          type: string
        eventName:
          description: 'Name of the API operation that generated this event.


            Example: `GetInstance`

            '
          maxLength: 255
          minLength: 1
          type: string
        freeformTags:
          additionalProperties:
            type: string
          description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name,

            type, or namespace. Exists for cross-compatibility only. For more information,

            see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm).


            Example: `{"Department": "Finance"}`

            '
          type: object
        identity:
          $ref: '#/components/schemas/identity'
        request:
          $ref: '#/components/schemas/request'
        resourceId:
          description: 'An [OCID](/Content/General/Concepts/identifiers.htm) or some other ID for the resource

            emitting the event.

            '
          maxLength: 255
          minLength: 1
          type: string
        resourceName:
          description: 'The name of the resource emitting the event.

            '
          maxLength: 255
          minLength: 1
          type: string
        response:
          $ref: '#/components/schemas/response'
        stateChange:
          $ref: '#/components/schemas/stateChange'
      type: object
      x-example: "{\n  \"eventGroupingId\": null,\n  \"eventName\": \"GetInstance\",\n  \"compartmentId\": \"ocid1.tenancy.oc1..<var>&lt;unique_ID&gt;</var>\",\n  \"compartmentName\": \"compartmentA\",\n  \"resourceName\": \"my_instance\",\n  \"resourceId\": \"ocid1.instance.oc1.phx.<var>&lt;unique_ID&gt;</var>\",\n  \"availabilityDomain\": \"<availability_domain>\",\n  \"freeformTags\": null,\n  \"definedTags\": null,\n  \"identity\": {\n    \"principalName\": \"ExampleName\",\n    \"principalId\": \"ocid1.user.oc1..<var>&lt;unique_ID&gt;</var>\",\n    \"authType\": \"natv\",\n    \"callerName\": null,\n    \"callerId\": null,\n    \"tenantId\": \"ocid1.tenancy.oc1..<var>&lt;unique_ID&gt;</var>\",\n    \"ipAddress\": \"172.24.80.88\",\n    \"credentials\": null,\n    \"userAgent\": \"Jersey/2.23 (HttpUrlConnection 1.8.0_212)\",\n    \"consoleSessionId\": null\n  },\n  \"request\": {\n    \"id\": \"<var>&lt;unique_ID&gt;</var>\",\n    \"path\": \"/20160918/instances/ocid1.instance.oc1.phx.<var>&lt;unique_ID&gt;</var>\",\n    \"action\": \"GET\",\n    \"parameters\": {},\n    \"headers\": {\n      \"opc-principal\": [\n        \"{\\\"tenantId\\\":\\\"ocid1.tenancy.oc1..<var>&lt;unique_ID&gt;</var>\\\",\\\"subjectId\\\":\\\"ocid1.user.oc1..<var>&lt;unique_ID&gt;</var>\\\",\\\"claims\\\":[{\\\"key\\\":\\\"pstype\\\",\\\"value\\\":\\\"natv\\\",\\\"issuer\\\":\\\"authService.oracle.com\\\"},{\\\"key\\\":\\\"h_host\\\",\\\"value\\\":\\\"iaas.r2.oracleiaas.com\\\",\\\"issuer\\\":\\\"h\\\"},{\\\"key\\\":\\\"h_opc-request-id\\\",\\\"value\\\":\\\"<var>&lt;unique_ID&gt;</var>\\\",\\\"issuer\\\":\\\"h\\\"},{\\\"key\\\":\\\"ptype\\\",\\\"value\\\":\\\"user\\\",\\\"issuer\\\":\\\"authService.oracle.com\\\"},{\\\"key\\\":\\\"h_date\\\",\\\"value\\\":\\\"Wed, 18 Sep 2019 00:10:58 UTC\\\",\\\"issuer\\\":\\\"h\\\"},{\\\"key\\\":\\\"h_accept\\\",\\\"value\\\":\\\"application/json\\\",\\\"issuer\\\":\\\"h\\\"},{\\\"key\\\":\\\"authorization\\\",\\\"value\\\":\\\"Signature headers=\\\\\\\"date (request-target) host accept opc-request-id\\\\\\\",keyId=\\\\\\\"ocid1.tenancy.oc1..<var>&lt;unique_ID&gt;</var>/ocid1.user.oc1..<var>&lt;unique_ID&gt;</var>/8c:b4:5f:18:e7:ec:db:08:b8:fa:d2:2a:7d:11:76:ac\\\\\\\",algorithm=\\\\\\\"rsa-pss-sha256\\\\\\\",signature=\\\\\\\"<var>&lt;unique_ID&gt;</var>\\\\\\\",version=\\\\\\\"1\\\\\\\"\\\",\\\"issuer\\\":\\\"h\\\"},{\\\"key\\\":\\\"h_(request-target)\\\",\\\"value\\\":\\\"get /20160918/instances/ocid1.instance.oc1.phx.<var>&lt;unique_ID&gt;</var>\\\",\\\"issuer\\\":\\\"h\\\"}]}\"\n      ],\n      \"Accept\": [\n        \"application/json\"\n      ],\n      \"X-Oracle-Auth-Client-CN\": [\n        \"splat-proxy-se-02302.node.ad2.r2\"\n      ],\n      \"X-Forwarded-Host\": [\n        \"compute-api.svc.ad1.r2\"\n      ],\n      \"Connection\": [\n        \"close\"\n      ],\n      \"User-Agent\": [\n        \"Jersey/2.23 (HttpUrlConnection 1.8.0_212)\"\n      ],\n      \"X-Forwarded-For\": [\n        \"172.24.80.88\"\n      ],\n      \"X-Real-IP\": [\n        \"172.24.80.88\"\n      ],\n      \"oci-original-url\": [\n        \"https://iaas.r2.oracleiaas.com/20160918/instances/ocid1.instance.oc1.phx.<var>&lt;unique_ID&gt;</var>\"\n      ],\n      \"opc-request-id\": [\n        \"<var>&lt;unique_ID&gt;</var>\"\n      ],\n      \"Date\": [\n        \"Wed, 18 Sep 2019 00:10:58 UTC\"\n      ]\n    }\n  },\n  \"response\": {\n    \"status\": \"200\",\n    \"responseTime\": \"2019-09-18T00:10:59.278Z\",\n    \"headers\": {\n      \"ETag\": [\n        \"<var>&lt;unique_ID&gt;</var>\"\n      ],\n      \"Connection\": [\n        \"close\"\n      ],\n      \"Content-Length\": [\n        \"1828\"\n      ],\n      \"opc-request-id\": [\n        \"<var>&lt;unique_ID&gt;</var>\"\n      ],\n      \"Date\": [\n        \"Wed, 18 Sep 2019 00:10:59 GMT\"\n      ],\n      \"Content-Type\": [\n        \"application/json\"\n      ]\n    },\n    \"payload\": {\n      \"resourceName\": \"my_instance\",\n      \"id\": \"ocid1.instance.oc1.phx.<var>&lt;unique_ID&gt;</var>\"\n    },\n    \"message\": null\n  },\n  \"stateChange\": {\n    \"previous\": null,\n    \"current\": null\n  },\n  \"additionalDetails\": {\n    \"imageId\": \"ocid1.image.oc1.phx.<var>&lt;unique_ID&gt;</var>\",\n    \"shape\": \"VM.Standard1.1\",\n    \"type\": \"CustomerVmi\"\n  }\n}\n"
    Error:
      properties:
        code:
          description: 'A short error code that defines the error, meant for programmatic parsing. See

            [API Errors](/Content/API/References/apierrors.htm).


            Example: `400`

            '
          format: string
          type: string
        message:
          description: 'A human-readable error string.


            Example: `InvalidParameter`

            '
          format: string
          type: string
      required:
      - code
      - message
      type: object
      x-example: "{\n  \"code\" : \"400\",\n  \"message\" : \"InvalidParameter\"\n}\n"
    response:
      description: 'A container object for response attributes.

        '
      properties:
        headers:
          additionalProperties:
            items:
              type: string
            type: array
          description: "The headers of the response.\n\nExample:\n\n  -----\n    {\n      \"ETag\": [\n        \"<unique_ID>\"\n      ],\n      \"Connection\": [\n        \"close\"\n      ],\n      \"Content-Length\": [\n        \"1828\"\n      ],\n      \"opc-request-id\": [\n        \"<unique_ID>\"\n      ],\n      \"Date\": [\n        \"Wed, 18 Sep 2019 00:10:59 GMT\"\n      ],\n      \"Content-Type\": [\n        \"application/json\"\n      ]\n    }\n  -----\n"
          type: object
        message:
          description: 'A friendly description of what happened during the operation. Use this for troubleshooting.

            '
          maxLength: 1024
          minLength: 1
          type: string
        payload:
          additionalProperties:
            type: object
          description: "This value is included for backward compatibility with the Audit version 1 schema, where\nit contained metadata of interest from the response payload.\n\nExample:\n\n  -----\n    {\n      \"resourceName\": \"my_instance\",\n      \"id\": \"ocid1.instance.oc1.phx.<unique_ID>\"\n    }\n  -----\n"
          type: object
        responseTime:
          description: 'The time of the response to the audited request, expressed in

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


            Example: `2019-09-18T00:10:59.278Z`

            '
          format: date-time
          type: string
        status:
          description: 'The status code of the response.


            Example: `200`

            '
          maxLength: 255
          minLength: 1
          type: string
      type: object
      x-example: "{\n  \"status\": \"200\",\n  \"responseTime\": \"2019-09-18T00:10:59.278Z\",\n  \"headers\": {\n    \"ETag\": [\n      \"<unique_ID>\"\n    ],\n    \"Connection\": [\n      \"close\"\n    ],\n    \"Content-Length\": [\n      \"1828\"\n    ],\n    \"opc-request-id\": [\n      \"<unique_ID>\"\n    ],\n    \"Date\": [\n      \"Wed, 18 Sep 2019 00:10:59 GMT\"\n    ],\n    \"Content-Type\": [\n      \"application/json\"\n    ]\n  },\n  \"payload\": {\n    \"resourceName\": \"my_instance\",\n    \"id\": \"ocid1.instance.oc1.phx.<unique_ID>\"\n  },\n  \"message\": null\n}\n"
    request:
      description: 'A container object for request attributes.

        '
      properties:
        action:
          description: 'The HTTP method of the request.


            Example: `GET`

            '
          maxLength: 255
          minLength: 1
          type: string
        headers:
          additionalProperties:
            items:
              type: string
            type: array
          description: "The HTTP header fields and values in the request.\n\nExample:\n\n  -----\n    {\n      \"opc-principal\": [\n        \"{\\\"tenantId\\\":\\\"ocid1.tenancy.oc1..<unique_ID>\\\",\\\"subjectId\\\":\\\"ocid1.user.oc1..<unique_ID>\\\",\\\"claims\\\":[{\\\"key\\\":\\\"pstype\\\",\\\"value\\\":\\\"natv\\\",\\\"issuer\\\":\\\"authService.oracle.com\\\"},{\\\"key\\\":\\\"h_host\\\",\\\"value\\\":\\\"iaas.r2.oracleiaas.com\\\",\\\"issuer\\\":\\\"h\\\"},{\\\"key\\\":\\\"h_opc-request-id\\\",\\\"value\\\":\\\"<unique_ID>\\\",\\\"issuer\\\":\\\"h\\\"},{\\\"key\\\":\\\"ptype\\\",\\\"value\\\":\\\"user\\\",\\\"issuer\\\":\\\"authService.oracle.com\\\"},{\\\"key\\\":\\\"h_date\\\",\\\"value\\\":\\\"Wed, 18 Sep 2019 00:10:58 UTC\\\",\\\"issuer\\\":\\\"h\\\"},{\\\"key\\\":\\\"h_accept\\\",\\\"value\\\":\\\"application/json\\\",\\\"issuer\\\":\\\"h\\\"},{\\\"key\\\":\\\"authorization\\\",\\\"value\\\":\\\"Signature headers=\\\\\\\"date (request-target) host accept opc-request-id\\\\\\\",keyId=\\\\\\\"ocid1.tenancy.oc1..<unique_ID>/ocid1.user.oc1..<unique_ID>/8c:b4:5f:18:e7:ec:db:08:b8:fa:d2:2a:7d:11:76:ac\\\\\\\",algorithm=\\\\\\\"rsa-pss-sha256\\\\\\\",signature=\\\\\\\"<unique_ID>\\\\\\\",version=\\\\\\\"1\\\\\\\"\\\",\\\"issuer\\\":\\\"h\\\"},{\\\"key\\\":\\\"h_(request-target)\\\",\\\"value\\\":\\\"get /20160918/instances/ocid1.instance.oc1.phx.<unique_ID>\\\",\\\"issuer\\\":\\\"h\\\"}]}\"\n      ],\n      \"Accept\": [\n        \"application/json\"\n      ],\n      \"X-Oracle-Auth-Client-CN\": [\n        \"splat-proxy-se-02302.node.ad2.r2\"\n      ],\n      \"X-Forwarded-Host\": [\n        \"compute-api.svc.ad1.r2\"\n      ],\n      \"Connection\": [\n        \"close\"\n      ],\n      \"User-Agent\": [\n        \"Jersey/2.23 (HttpUrlConnection 1.8.0_212)\"\n      ],\n      \"X-Forwarded-For\": [\n        \"172.24.80.88\"\n      ],\n      \"X-Real-IP\": [\n        \"172.24.80.88\"\n      ],\n      \"oci-original-url\": [\n        \"https://iaas.r2.oracleiaas.com/20160918/instances/ocid1.instance.oc1.phx.<unique_ID>\"\n      ],\n      \"opc-request-id\": [\n        \"<unique_ID>\"\n      ],\n      \"Date\": [\n        \"Wed, 18 Sep 2019 00:10:58 UTC\"\n      ]\n    }\n  -----\n"
          type: object
        id:
          description: 'The opc-request-id of the request.

            '
          maxLength: 255
          minLength: 1
          type: string
        parameters:
          additionalProperties:
            items:
              type: string
            type: array
          description: 'The parameters supplied by the caller during this operation.

            '
          type: object
        path:
          description: 'The full path of the API request.


            Example: `/20160918/instances/ocid1.instance.oc1.phx.<unique_ID>`

            '
          type: string
      type: object
      x-example: "{\n  \"id\": \"<var>&lt;unique_ID&gt;</var>\",\n  \"path\": \"/20160918/instances/ocid1.instance.oc1.phx.<var>&lt;unique_ID&gt;</var>\",\n  \"action\": \"GET\",\n  \"parameters\": {},\n  \"headers\": {\n    \"opc-principal\": [\n      \"{\\\"tenantId\\\":\\\"ocid1.tenancy.oc1..<var>&lt;unique_ID&gt;</var>\\\",\\\"subjectId\\\":\\\"ocid1.user.oc1..<var>&lt;unique_ID&gt;</var>\\\",\\\"claims\\\":[{\\\"key\\\":\\\"pstype\\\",\\\"value\\\":\\\"natv\\\",\\\"issuer\\\":\\\"authService.oracle.com\\\"},{\\\"key\\\":\\\"h_host\\\",\\\"value\\\":\\\"iaas.r2.oracleiaas.com\\\",\\\"issuer\\\":\\\"h\\\"},{\\\"key\\\":\\\"h_opc-request-id\\\",\\\"value\\\":\\\"<var>&lt;unique_ID&gt;</var>\\\",\\\"issuer\\\":\\\"h\\\"},{\\\"key\\\":\\\"ptype\\\",\\\"value\\\":\\\"user\\\",\\\"issuer\\\":\\\"authService.oracle.com\\\"},{\\\"key\\\":\\\"h_date\\\",\\\"value\\\":\\\"Wed, 18 Sep 2019 00:10:58 UTC\\\",\\\"issuer\\\":\\\"h\\\"},{\\\"key\\\":\\\"h_accept\\\",\\\"value\\\":\\\"application/json\\\",\\\"issuer\\\":\\\"h\\\"},{\\\"key\\\":\\\"authorization\\\",\\\"value\\\":\\\"Signature headers=\\\\\\\"date (request-target) host accept opc-request-id\\\\\\\",keyId=\\\\\\\"ocid1.tenancy.oc1..<var>&lt;unique_ID&gt;</var>/ocid1.user.oc1..<var>&lt;unique_ID&gt;</var>/8c:b4:5f:18:e7:ec:db:08:b8:fa:d2:2a:7d:11:76:ac\\\\\\\",algorithm=\\\\\\\"rsa-pss-sha256\\\\\\\",signature=\\\\\\\"<var>&lt;unique_ID&gt;</var>\\\\\\\",version=\\\\\\\"1\\\\\\\"\\\",\\\"issuer\\\":\\\"h\\\"},{\\\"key\\\":\\\"h_(request-target)\\\",\\\"value\\\":\\\"get /20160918/instances/ocid1.instance.oc1.phx.<var>&lt;unique_ID&gt;</var>\\\",\\\"issuer\\\":\\\"h\\\"}]}\"\n    ],\n    \"Accept\": [\n      \"application/json\"\n    ],\n    \"X-Oracle-Auth-Client-CN\": [\n      \"splat-proxy-se-02302.node.ad2.r2\"\n    ],\n    \"X-Forwarded-Host\": [\n      \"compute-api.svc.ad1.r2\"\n    ],\n    \"Connection\": [\n      \"close\"\n    ],\n    \"User-Agent\": [\n      \"Jersey/2.23 (HttpUrlConnection 1.8.0_212)\"\n    ],\n    \"X-Forwarded-For\": [\n      \"172.24.80.88\"\n    ],\n    \"X-Real-IP\": [\n      \"172.24.80.88\"\n    ],\n    \"oci-original-url\": [\n      \"https://iaas.r2.oracleiaas.com/20160918/instances/ocid1.instance.oc1.phx.<var>&lt;unique_ID&gt;</var>\"\n    ],\n    \"opc-request-id\": [\n      \"<var>&lt;unique_ID&gt;</var>\"\n    ],\n    \"Date\": [\n      \"Wed, 18 Sep 2019 00:10:58 UTC\"\n    ]\n  }\n}\n"
    AuditEvent:
      description: 'All the attributes of an audit event. For more information, see [Viewing Audit Log Events](/iaas/Content/Audit/Tasks/viewinglogevents.htm).

        '
      properties:
        cloudEventsVersion:
          description: 'The version of the CloudEvents specification. The structure of the envelope follows the

            [CloudEvents](https://github.com/cloudevents/spec) industry standard format hosted by the

            [Cloud Native Computing Foundation ( CNCF)](https://www.cncf.io/).


            Audit uses version 0.1 specification of the CloudEvents event envelope.


            Example: `0.1`

            '
          maxLength: 255
          minLength: 1
          type: string
        contentType:
          description: 'The content type of the data contained in `data`.


            Example: `application/json`

            '
          maxLength: 255
          minLength: 1
          type: string
        data:
          $ref: '#/components/schemas/data'
        eventId:
          description: 'The GUID of the event.

            '
          maxLength: 255
          minLength: 1
          type: string
        eventTime:
          description: 'The time the event occurred, expressed in [RFC 3339](https://tools.ietf.org/html/rfc3339) timestamp format.


            Example: `2019-09-18T00:10:59.252Z`

            '
          format: date-time
          type: string
        eventType:
          description: 'The type of event that happened.


            The service that produces the event can also add, remove, or change the meaning of a field.

            A service implementing these type changes would publish a new version of an `eventType` and

            revise the `eventTypeVersion` field.


            Example: `com.oraclecloud.ComputeApi.GetInstance`

            '
          maxLength: 1024
          minLength: 1
          type: string
        eventTypeVersion:
          description: 'The version of the event type. This version applies to the payload of the event, not the envelope.

            Use `cloudEventsVersion` to determine the version of the envelope.


            Example: `2.0`

            '
          maxLength: 255
          minLength: 1
          type: string
        source:
          description: 'The source of the event.


            Example: `ComputeApi`

            '
          maxLength: 1024
          minLength: 1
          type: string
      required:
      - eventType
      - cloudEventsVersion
      - eventTypeVersion
      - source
      - eventId
      - eventTime
      - contentType
      - data
      type: object
      x-example: "{\n  \"eventType\": \"com.oraclecloud.ComputeApi.GetInstance\",\n  \"cloudEventsVersion\": \"0.1\",\n  \"eventTypeVersion\": \"2.0\",\n  \"source\": \"ComputeApi\",\n  \"eventId\": \"<var>&lt;unique_ID&gt;</var>\",\n  \"eventTime\": \"2019-09-18T00:10:59.252Z\",\n  \"contentType\": \"application/json\",\n  \"data\": {\n    \"eventGroupingId\": null,\n    \"eventName\": \"GetInstance\",\n    \"compartmentId\": \"ocid1.tenancy.oc1..<var>&lt;unique_ID&gt;</var>\",\n    \"compartmentName\": \"compartmentA\",\n    \"resourceName\": \"my_instance\",\n    \"resourceId\": \"ocid1.instance.oc1.phx.<var>&lt;unique_ID&gt;</var>\",\n    \"availabilityDomain\": \"<availability_domain>\",\n    \"freeformTags\": null,\n    \"definedTags\": null,\n    \"identity\": {\n      \"principalName\": \"ExampleName\",\n      \"principalId\": \"ocid1.user.oc1..<var>&lt;unique_ID&gt;</var>\",\n      \"authType\": \"natv\",\n      \"callerName\": null,\n      \"callerId\": null,\n      \"tenantId\": \"ocid1.tenancy.oc1..<var>&lt;unique_ID&gt;</var>\",\n      \"ipAddress\": \"172.24.80.88\",\n      \"credentials\": null,\n      \"userAgent\": \"Jersey/2.23 (HttpUrlConnection 1.8.0_212)\",\n      \"consoleSessionId\": null\n    },\n    \"request\": {\n      \"id\": \"<var>&lt;unique_ID&gt;</var>\",\n      \"path\": \"/20160918/instances/ocid1.instance.oc1.phx.<var>&lt;unique_ID&gt;</var>\",\n      \"action\": \"GET\",\n      \"parameters\": {},\n      \"headers\": {\n        \"opc-principal\": [\n          \"{\\\"tenantId\\\":\\\"ocid1.tenancy.oc1..<var>&lt;unique_ID&gt;</var>\\\",\\\"subjectId\\\":\\\"ocid1.user.oc1..<var>&lt;unique_ID&gt;</var>\\\",\\\"claims\\\":[{\\\"key\\\":\\\"pstype\\\",\\\"value\\\":\\\"natv\\\",\\\"issuer\\\":\\\"authService.oracle.com\\\"},{\\\"key\\\":\\\"h_host\\\",\\\"value\\\":\\\"iaas.r2.oracleiaas.com\\\",\\\"issuer\\\":\\\"h\\\"},{\\\"key\\\":\\\"h_opc-request-id\\\",\\\"value\\\":\\\"<var>&lt;unique_ID&gt;</var>\\\",\\\"issuer\\\":\\\"h\\\"},{\\\"key\\\":\\\"ptype\\\",\\\"value\\\":\\\"user\\\",\\\"issuer\\\":\\\"authService.oracle.com\\\"},{\\\"key\\\":\\\"h_date\\\",\\\"value\\\":\\\"Wed, 18 Sep 2019 00:10:58 UTC\\\",\\\"issuer\\\":\\\"h\\\"},{\\\"key\\\":\\\"h_accept\\\",\\\"value\\\":\\\"application/json\\\",\\\"issuer\\\":\\\"h\\\"},{\\\"key\\\":\\\"authorization\\\",\\\"value\\\":\\\"Signature headers=\\\\\\\"date (request-target) host accept opc-request-id\\\\\\\",keyId=\\\\\\\"ocid1.tenancy.oc1..<var>&lt;unique_ID&gt;</var>/ocid1.user.oc1..<var>&lt;unique_ID&gt;</var>/8c:b4:5f:18:e7:ec:db:08:b8:fa:d2:2a:7d:11:76:ac\\\\\\\",algorithm=\\\\\\\"rsa-pss-sha256\\\\\\\",signature=\\\\\\\"<var>&lt;unique_ID&gt;</var>\\\\\\\",version=\\\\\\\"1\\\\\\\"\\\",\\\"issuer\\\":\\\"h\\\"},{\\\"key\\\":\\\"h_(request-target)\\\",\\\"value\\\":\\\"get /20160918/instances/ocid1.instance.oc1.phx.<var>&lt;unique_ID&gt;</var>\\\",\\\"issuer\\\":\\\"h\\\"}]}\"\n        ],\n        \"Accept\": [\n          \"application/json\"\n        ],\n        \"X-Oracle-Auth-Client-CN\": [\n          \"splat-proxy-se-02302.node.ad2.r2\"\n        ],\n        \"X-Forwarded-Host\": [\n          \"compute-api.svc.ad1.r2\"\n        ],\n        \"Connection\": [\n          \"close\"\n        ],\n        \"User-Agent\": [\n          \"Jersey/2.23 (HttpUrlConnection 1.8.0_212)\"\n        ],\n        \"X-Forwarded-For\": [\n          \"172.24.80.88\"\n        ],\n        \"X-Real-IP\": [\n          \"172.24.80.88\"\n        ],\n        \"oci-original-url\": [\n          \"https://iaas.r2.oracleiaas.com/20160918/instances/ocid1.instance.oc1.phx.<var>&lt;unique_ID&gt;</var>\"\n        ],\n        \"opc-request-id\": [\n          \"<var>&lt;unique_ID&gt;</var>\"\n        ],\n        \"Date\": [\n          \"Wed, 18 Sep 2019 00:10:58 UTC\"\n        ]\n      }\n    },\n    \"response\": {\n      \"status\": \"200\",\n      \"responseTime\": \"2019-09-18T00:10:59.278Z\",\n      \"headers\": {\n        \"ETag\": [\n          \"<var>&lt;unique_ID&gt;</var>\"\n        ],\n        \"Connection\": [\n          \"close\"\n        ],\n        \"Content-Length\": [\n          \"1828\"\n        ],\n        \"opc-request-id\": [\n          \"<var>&lt;unique_ID&gt;</var>\"\n        ],\n        \"Date\": [\n          \"Wed, 18 Sep 2019 00:10:59 GMT\"\n        ],\n        \"Content-Type\": [\n          \"application/json\"\n        ]\n      },\n      \"payload\": {\n        \"resourceName\": \"my_instance\",\n        \"id\": \"ocid1.instance.oc1.phx.<var>&lt;unique_ID&gt;</var>\"\n      },\n      \"message\": null\n    },\n    \"stateChange\": {\n      \"previous\": null,\n      \"current\": null\n    },\n    \"additionalDetails\": {\n      \"imageId\": \"ocid1.image.oc1.phx.<var>&lt;unique_ID&gt;</var>\",\n      \"shape\": \"VM.Standard1.1\",\n      \"type\": \"CustomerVmi\"\n    }\n  }\n}\n"
    identity:
      description: 'A container object for identity attributes.

        '
      properties:
        authType:
          description: 'The type of authentication used.


            Example: `natv`

            '
          maxLength: 255
          minLength: 1
          type: string
        callerId:
          description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the caller. The caller that made a

            request on behalf of the prinicpal.

            '
          maxLength: 255
          minLength: 1
          type: string
        callerName:
          description: 'The name of the user or service. This value is the friendly name associated with `callerId`.

            '
          maxLength: 100
          minLength: 1
          type: string
        consoleSessionId:
          description: 'This value identifies any Console session associated with this request.

            '
          maxLength: 255
          minLength: 1
          type: string
        credentials:
          description: 'The credential ID of the user. This value is extracted from the HTTP ''Authorization'' request

            header. It consists of the tenantId, userId, and user fingerprint, all delimited by a slash (/).

            '
          maxLength: 255
          minLength: 1
          type: string
        ipAddress:
          description: 'The IP address of the source of the request.


            Example: `172.24.80.88`

            '
          maxLength: 255
          minLength: 1
          type: string
        principalId:
          description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the principal.

            '
          maxLength: 255
          minLength: 1
          type: string
        principalName:
          description: 'The name of the user or service. This value is the friendly name associated with `principalId`.


            Example: `ExampleName`

            '
          maxLength: 100
          minLength: 1
          type: string
        tenantId:
          description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the tenant.

            '
          maxLength: 255
          minLength: 1
          type: string
        userAgent:
          description: 'The user agent of the client that made the request.


            Example: `Jersey/2.23 (HttpUrlConnection 1.8.0_212)`

            '
          maxLength: 1024
          minLength: 1
          type: string
      type: object
      x-example: "{\n  \"principalName\": \"ExampleName\",\n  \"principalId\": \"ocid1.user.oc1..<var>&lt;unique_ID&gt;</var>\",\n  \"authType\": \"natv\",\n  \"callerName\": null,\n  \"callerId\": null,\n  \"tenantId\": \"ocid1.tenancy.oc1..<var>&lt;unique_ID&gt;</var>\",\n  \"ipAddress\": \"172.24.80.88\",\n  \"credentials\": null,\n  \"userAgent\": \"Jersey/2.23 (HttpUrlConnection 1.8.0_212)\",\n  \"consoleSessionId\": null\n}\n"
  responses:
    DefaultError:
      description: An error has occurred
      headers:
        opc-request-id:
          description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about

            a particular request, please provide the request ID.

            '
          schema:
            type: string
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'