Oracle Cloud Infrastructure Preauthenticated Requests API

openapi: 3.0.3
info:
  title: Oracle Cloud Compute Alarms Preauthenticated Requests API
  description: Manage compute instances, images, shapes, and related resources in Oracle Cloud Infrastructure.
  version: '20160918'
  x-generated-from: documentation
  x-last-validated: '2026-04-18'
  contact:
    name: Oracle Cloud Infrastructure
    url: https://docs.oracle.com/en-us/iaas/Content/Compute/home.htm
servers:
- url: https://iaas.{region}.oraclecloud.com/20160918
  description: OCI Compute API server
  variables:
    region:
      default: us-ashburn-1
      description: OCI region identifier
security:
- ociSignature: []
tags:
- name: Preauthenticated Requests
paths:
  /n/{namespaceName}/b/{bucketName}/p:
    get:
      operationId: listPreauthenticatedRequests
      summary: Oracle Cloud List Preauthenticated Requests
      description: Lists pre-authenticated requests for the bucket.
      tags:
      - Preauthenticated Requests
      parameters:
      - name: namespaceName
        in: path
        required: true
        description: The Object Storage namespace.
        schema:
          type: string
        example: oci_computeagent
      - name: bucketName
        in: path
        required: true
        description: The name of the bucket.
        schema:
          type: string
        example: example-value
      - name: limit
        in: query
        required: false
        description: Maximum number of items to return.
        schema:
          type: integer
        example: 1
      responses:
        '200':
          description: Successfully retrieved preauthenticated requests.
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/PreauthenticatedRequestSummary'
              examples:
                ListPreauthenticatedRequests200Example:
                  summary: Default listPreauthenticatedRequests 200 response
                  x-microcks-default: true
                  value:
                  - id: ocid1.resource.oc1.iad.abcdefg123456
                    name: example-value
                    objectName: example-value
                    accessType: ObjectRead
                    timeExpires: '2026-04-18T10:30:00Z'
                    timeCreated: '2026-04-18T10:30:00Z'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
    post:
      operationId: createPreauthenticatedRequest
      summary: Oracle Cloud Create Preauthenticated Request
      description: Creates a pre-authenticated request for the bucket.
      tags:
      - Preauthenticated Requests
      parameters:
      - name: namespaceName
        in: path
        required: true
        description: The Object Storage namespace.
        schema:
          type: string
        example: oci_computeagent
      - name: bucketName
        in: path
        required: true
        description: The name of the bucket.
        schema:
          type: string
        example: example-value
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreatePreauthenticatedRequestDetails'
            examples:
              CreatePreauthenticatedRequestRequestExample:
                summary: Default createPreauthenticatedRequest request
                x-microcks-default: true
                value:
                  name: my-par
                  objectName: example-value
                  accessType: ObjectRead
                  timeExpires: '2026-12-31T23:59:59Z'
      responses:
        '200':
          description: Successfully created preauthenticated request.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PreauthenticatedRequest'
              examples:
                CreatePreauthenticatedRequest200Example:
                  summary: Default createPreauthenticatedRequest 200 response
                  x-microcks-default: true
                  value:
                    id: ocid1.resource.oc1.iad.abcdefg123456
                    name: example-value
                    accessUri: example-value
                    objectName: example-value
                    accessType: ObjectRead
                    timeExpires: '2026-04-18T10:30:00Z'
                    timeCreated: '2026-04-18T10:30:00Z'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
components:
  schemas:
    CreatePreauthenticatedRequestDetails:
      type: object
      description: Details for creating a preauthenticated request.
      required:
      - name
      - accessType
      - timeExpires
      properties:
        name:
          type: string
          description: A user-specified name for the pre-authenticated request.
          example: my-par
        objectName:
          type: string
          description: Name of object to grant access to. Omit for bucket-level access.
          example: example-value
        accessType:
          type: string
          description: The operation that can be performed.
          enum:
          - ObjectRead
          - ObjectWrite
          - ObjectReadWrite
          - AnyObjectRead
          - AnyObjectWrite
          - AnyObjectReadWrite
          example: ObjectRead
        timeExpires:
          type: string
          format: date-time
          description: The expiration date for the pre-authenticated request.
          example: '2026-12-31T23:59:59Z'
    PreauthenticatedRequest:
      type: object
      description: A preauthenticated request with access URI.
      properties:
        id:
          type: string
          description: The unique identifier.
          example: ocid1.resource.oc1.iad.abcdefg123456
        name:
          type: string
          description: The user-provided name.
          example: example-value
        accessUri:
          type: string
          description: The URI to embed in a URL.
          example: example-value
        objectName:
          type: string
          description: The name of the object.
          example: example-value
        accessType:
          type: string
          enum:
          - ObjectRead
          - ObjectWrite
          - ObjectReadWrite
          - AnyObjectRead
          - AnyObjectWrite
          - AnyObjectReadWrite
          example: ObjectRead
        timeExpires:
          type: string
          format: date-time
          example: '2026-04-18T10:30:00Z'
        timeCreated:
          type: string
          format: date-time
          example: '2026-04-18T10:30:00Z'
    PreauthenticatedRequestSummary:
      type: object
      description: Summary of a preauthenticated request.
      properties:
        id:
          type: string
          description: The unique identifier.
          example: ocid1.resource.oc1.iad.abcdefg123456
        name:
          type: string
          description: The user-provided name.
          example: example-value
        objectName:
          type: string
          description: The name of the object.
          example: example-value
        accessType:
          type: string
          description: The operation that can be performed.
          enum:
          - ObjectRead
          - ObjectWrite
          - ObjectReadWrite
          - AnyObjectRead
          - AnyObjectWrite
          - AnyObjectReadWrite
          example: ObjectRead
        timeExpires:
          type: string
          format: date-time
          description: The expiration date.
          example: '2026-04-18T10:30:00Z'
        timeCreated:
          type: string
          format: date-time
          example: '2026-04-18T10:30:00Z'
  securitySchemes:
    ociSignature:
      type: http
      scheme: bearer
      description: OCI request signature authentication using API signing keys.