Oracle Operator Actions API

openapi: 3.2.0
info:
  description: "Operator Access Control enables you to control the time duration and the actions an Oracle operator can perform on your Exadata Cloud@Customer infrastructure.\nUsing logging service, you can view a near real-time audit report of all actions performed by an Oracle operator. \n"
  title: Operator Access Control Operator Actions API
  version: '20200630'
  x-provenance:
    method: harvested
    first_party: true
    publisher: Oracle
    source: https://docs.oracle.com/en-us/iaas/api/specs/9cf6d46a3ebf1062eb0a9b386e1727a9f1b39525782fc49580c4ba13b79c72fa.yaml
    harvested: '2026-08-04'
    note: Published by Oracle as the contract for the Operator Access Control 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/9cf6d46a3ebf1062eb0a9b386e1727a9f1b39525782fc49580c4ba13b79c72fa.yaml
    what: the harvested document for Operator Access Control API
servers:
- url: http://127.0.0.1/20200630
- url: https://127.0.0.1/20200630
tags:
- name: operatorActions
paths:
  /operatorActions:
    get:
      description: 'Lists all the OperatorActions available in the system.

        '
      operationId: ListOperatorActions
      parameters:
      - $ref: '#/components/parameters/OperatorActionNameQueryParam'
      - $ref: '#/components/parameters/CompartmentIdQueryParam'
      - $ref: '#/components/parameters/OperatorActionLifecycleStateQueryParam'
      - $ref: '#/components/parameters/PaginationLimitQueryParam'
      - $ref: '#/components/parameters/PaginationTokenQueryParam'
      - $ref: '#/components/parameters/SortOrderQueryParam'
      - $ref: '#/components/parameters/SortByQueryParam'
      - $ref: '#/components/parameters/RequestIdHeader'
      responses:
        200:
          description: returns OperatorActionCollection object.
          headers:
            opc-next-page:
              description: 'For pagination of a list of items. When paging through a list, if this header appears in the response,

                then a partial list might have been returned. Include this value as the `page` parameter for the

                subsequent GET request to get the next batch of items.

                '
              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:
                $ref: '#/components/schemas/OperatorActionCollection'
        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/default'
      summary: Lists all the operator actions available in the system. You need to use these when you define an operator control.
      tags:
      - operatorActions
      x-related-resource: '#/definitions/OperatorAction'
  /operatorActions/{operatorActionId}:
    get:
      description: Gets the operator action associated with the specified operator action ID.
      operationId: GetOperatorAction
      parameters:
      - $ref: '#/components/parameters/OperatorActionPathParam'
      - $ref: '#/components/parameters/RequestIdHeader'
      responses:
        200:
          description: Returns the OperatorAction for the given id
          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/OperatorAction'
        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/default'
      summary: Get OperatorAction
      tags:
      - operatorActions
      x-related-resource: '#/definitions/OperatorAction'
components:
  parameters:
    CompartmentIdQueryParam:
      description: The ID of the compartment in which to list resources.
      in: query
      name: compartmentId
      required: true
      schema:
        type: string
    OperatorActionNameQueryParam:
      description: A filter to return only resources that match the entire display name given.
      in: query
      name: name
      x-default-description: 'null'
      schema:
        type: string
        maxLength: 255
        minLength: 1
    PaginationTokenQueryParam:
      description: The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.
      in: query
      name: page
      schema:
        type: string
        maxLength: 1024
        minLength: 1
    SortByQueryParam:
      description: 'The field to sort by. Only one sort order may be provided. Default order for timeCreated is descending. Default order for displayName is ascending. If no value is specified timeCreated is default.

        '
      in: query
      name: sortBy
      schema:
        type: string
        enum:
        - timeCreated
        - displayName
        default: timeCreated
    RequestIdHeader:
      description: The client request ID for tracing.
      in: header
      name: opc-request-id
      schema:
        type: string
    PaginationLimitQueryParam:
      description: The maximum number of items to return.
      in: query
      name: limit
      schema:
        type: integer
        default: 10
        maximum: 1000
        minimum: 1
    OperatorActionLifecycleStateQueryParam:
      description: A filter to return only resources whose lifecycleState matches the given OperatorAction lifecycleState.
      in: query
      name: lifecycleState
      required: false
      x-default-description: 'null'
      x-obmcs-top-level-enum: '#/definitions/OperatorActionLifecycleStates'
      schema:
        type: string
        enum:
        - ACTIVE
        - INACTIVE
    OperatorActionPathParam:
      description: Unique Oracle supplied identifier associated with the operator action.
      in: path
      name: operatorActionId
      required: true
      schema:
        type: string
    SortOrderQueryParam:
      description: The sort order to use, either 'asc' or 'desc'.
      in: query
      name: sortOrder
      x-obmcs-top-level-enum: '#/definitions/SortOrders'
      schema:
        type: string
        enum:
        - ASC
        - DESC
        default: DESC
  schemas:
    OperatorActionProperties:
      description: Details of the properties of operator action.
      properties:
        name:
          description: Name of the property
          type: string
        value:
          description: value of the property
          type: string
      type: object
    OperatorActionCollection:
      description: Results of operator action search, which contains summary of the action.
      properties:
        items:
          description: contains OperatorActionSummary
          items:
            $ref: '#/components/schemas/OperatorActionSummary'
          type: array
      required:
      - items
      type: object
    Error:
      description: Error Information.
      properties:
        code:
          description: A short error code that defines the error, meant for programmatic parsing.
          type: string
        message:
          description: A human-readable error string.
          type: string
      required:
      - code
      - message
    OperatorActionSummary:
      description: Details of the operator action. Operator actions are pre-defined set of commands available to the operator on different layers of the infrastructure.
      properties:
        compartmentId:
          description: compartmentId for which the OperatorAction is applicable
          type: string
        component:
          description: Name of the component for which the operator action is applicable.
          type: string
        description:
          description: 'Description of the operator action in terms of associated risk profile, and characteristics of the operating system commands made

            available to the operator under this operator action.

            '
          type: string
        id:
          description: Unique identifier assigned by Oracle to an operator action.
          type: string
        lifecycleState:
          description: The current lifecycle state of the operator action.
          enum:
          - ACTIVE
          - INACTIVE
          type: string
          x-obmcs-top-level-enum: '#/definitions/OperatorActionLifecycleStates'
        name:
          description: Name of the operator action.
          type: string
      required:
      - id
      - name
      type: object
    OperatorAction:
      description: "Details of the operator action. Operator actions are a pre-defined set of commands available to the operator on different layers of the infrastructure. Although the groupings may differ depending on the infrastructure layers, \nthe groups are designed to enable the operator access to commands to resolve a specific set of issues. The infrastructure layers controlled by the Operator Control include Dom0, CellServer, and Control Plane Server (CPS).\n\nThere are five groups available to the operator. x-obmcs-top-level-enum: '#/definitions/OperatorActionCategories' enum: *OPERATORACTIONCATEGORIES\n\nThe following infrastructure layers are controlled by the operator actions x-obmcs-top-level-enum: '#/definitions/InfrastructureLayers' enum: *INFRASTRUCTURELAYERS\n"
      properties:
        component:
          description: Name of the infrastructure layer associated with the operator action.
          type: string
        customerDisplayName:
          description: Display Name of the operator action.
          type: string
        description:
          description: 'Description of the operator action in terms of associated risk profile, and characteristics of the operating system commands made

            available to the operator under this operator action.

            '
          type: string
        id:
          description: Unique Oracle assigned identifier for the operator action.
          type: string
        name:
          description: Unique name of the operator action.
          type: string
        properties:
          description: Fine grained properties associated with the operator control.
          items:
            $ref: '#/components/schemas/OperatorActionProperties'
          type: array
      required:
      - id
      - name
      type: object
  responses:
    default:
      description: Unknown Error
      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'
x-anchors:
  x-headers:
    etag:
      description: 'For optimistic concurrency control. See `if-match`.

        '
      type: string
    opc-next-page:
      description: 'For pagination of a list of items. When paging through a list, if this header appears in the response,

        then a partial list might have been returned. Include this value as the `page` parameter for the

        subsequent GET request to get the next batch of items.

        '
      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.

        '
      type: string
    opc-work-request-id:
      description: 'Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation.

        '
      type: string
    retry-after:
      description: A decimal number representing the number of seconds the client should wait before polling this endpoint again.
      format: float
      type: number
  x-properties:
    definedTags:
      additionalProperties:
        additionalProperties:
          description: 'The value of the tag. Only string, integer and boolean types are supported.

            '
          type: object
        description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace.

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

        '
      type: object
    freeformTags:
      additionalProperties:
        type: string
      description: 'Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only.

        '
      type: object
x-obmcs-client-retries-enabled: true
x-oracle-package: com.oracle.bmc.opctl