Oracle Link API

openapi: 3.2.0
info:
  title: Oracle Link API
  version: '1.0'
  description: 'Operations tagged link across 2 of this provider''s published API definitions: oci-organizations-1-openapi.yaml, oci-organizations-openapi.yaml. Each path carries the servers of the definition it was published in.'
servers:
- url: http://127.0.0.1/20220518
- url: https://127.0.0.1/20220518
tags:
- name: link
paths:
  /links:
    get:
      description: Return a (paginated) list of links.
      operationId: ListLinks
      parameters:
      - $ref: '#/components/parameters/ParentTenancyIdQueryParam'
      - $ref: '#/components/parameters/ChildTenancyIdQueryParam'
      - $ref: '#/components/parameters/FeatureQueryParam'
      - $ref: '#/components/parameters/LifecycleStateQueryParam'
      - $ref: '#/components/parameters/RequestIdHeader'
      - $ref: '#/components/parameters/PaginationTokenQueryParam'
      - $ref: '#/components/parameters/PaginationLimitQueryParam'
      - $ref: '#/components/parameters/SortOrderQueryParam'
      responses:
        200:
          description: List of links.
          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/LinkCollection'
        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 links
      tags:
      - link
      x-related-resource: '#/definitions/Link'
  /links/{linkId}:
    delete:
      description: Starts the link termination workflow.
      operationId: DeleteLink
      parameters:
      - description: OCID of the link to terminate.
        in: path
        name: linkId
        required: true
        schema:
          type: string
          maxLength: 255
      - $ref: '#/components/parameters/IfMatchHeader'
      - $ref: '#/components/parameters/RequestIdHeader'
      responses:
        202:
          description: Link termination workflow started.
          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: 'Unique Oracle-assigned identifier for the asynchronous request. You can use this to query the status of the asynchronous operation.

                '
              schema:
                type: string
        400:
          $ref: '#/components/responses/400'
        401:
          $ref: '#/components/responses/401'
        404:
          $ref: '#/components/responses/404'
        412:
          $ref: '#/components/responses/412'
        429:
          $ref: '#/components/responses/429'
        500:
          $ref: '#/components/responses/500'
        default:
          $ref: '#/components/responses/default'
      summary: Starts the link termination workflow.
      tags:
      - link
      x-related-resource: '#/definitions/Link'
    get:
      description: Gets information about the link.
      operationId: GetLink
      parameters:
      - description: OCID of the link to retrieve.
        in: path
        name: linkId
        required: true
        schema:
          type: string
          maxLength: 255
      - $ref: '#/components/parameters/RequestIdHeader'
      responses:
        200:
          description: Link retrieved.
          headers:
            etag:
              description: 'For optimistic concurrency control. See `if-match`.

                '
              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/Link'
        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: Gets information about the link.
      tags:
      - link
  /links/{linkId}/tenancyNames:
    get:
      description: Gets information about the link along with the parent and child tenancy names.
      operationId: GetLinkWithTenancyNames
      parameters:
      - description: OCID of the link to retrieve.
        in: path
        name: linkId
        required: true
        schema:
          type: string
          maxLength: 255
      - $ref: '#/components/parameters/RequestIdHeader'
      responses:
        200:
          description: Link with tenancy names retrieved.
          headers:
            etag:
              description: 'For optimistic concurrency control. See `if-match`.

                '
              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/LinkWithTenancyNames'
        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: Gets information about the link along with tenancy names.
      tags:
      - link
      x-obmcs-client-retries-enabled: true
      x-related-resource: '#/definitions/LinkWithTenancyNames'
components:
  schemas:
    Link:
      description: A link between a parent tenancy and a child tenancy.
      properties:
        childTenancyId:
          description: OCID of the child tenancy.
          maxLength: 255
          minLength: 1
          type: string
        feature:
          description: The feature associated with this link. Default value is CORE.
          example: CORE
          maxLength: 64
          minLength: 1
          type: string
        id:
          description: OCID of the link.
          maxLength: 255
          minLength: 1
          type: string
        lifecycleState:
          description: Lifecycle state of the link.
          enum:
          - CREATING
          - ACTIVE
          - INACTIVE
          - UPDATING
          - FAILED
          - TERMINATED
          example: ACTIVE
          type: string
          x-obmcs-top-level-enum: '#/definitions/LifecycleState'
        parentTenancyId:
          description: OCID of the parent tenancy.
          maxLength: 255
          minLength: 1
          type: string
        timeCreated:
          description: Date-time when this link was created.
          example: 2016-08-29 09:12:33.001000+00:00
          format: date-time
          type: string
        timeTerminated:
          description: Date-time when this link was terminated.
          example: 2016-08-29 09:12:33.001000+00:00
          format: date-time
          type: string
        timeUpdated:
          description: Date-time when this link was last updated.
          example: 2016-08-29 09:12:33.001000+00:00
          format: date-time
          type: string
      required:
      - id
      - parentTenancyId
      - childTenancyId
      - timeCreated
    LinkCollection:
      description: Result of a query request for a list of links. Contains Link items.
      properties:
        items:
          description: Array containing LinkSummary items.
          items:
            $ref: '#/components/schemas/LinkSummary'
          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
    LinkWithTenancyNames:
      allOf:
      - $ref: '#/components/schemas/Link'
      - properties:
          childTenancyName:
            description: Name of the child tenancy.
            maxLength: 255
            minLength: 1
            type: string
          parentTenancyName:
            description: Name of the parent tenancy.
            maxLength: 255
            minLength: 1
            type: string
        required:
        - parentTenancyName
        - childTenancyName
      description: A link between a parent tenancy and a child tenancy, including the parent and child tenancy names.
    LinkSummary:
      description: The summary of a link between a parent tenancy and a child tenancy.
      properties:
        childTenancyId:
          description: OCID of the child tenancy.
          maxLength: 255
          minLength: 1
          type: string
        feature:
          description: The feature associated with this link. Default value is CORE.
          example: CORE
          maxLength: 64
          minLength: 1
          type: string
        id:
          description: OCID of the link.
          maxLength: 255
          minLength: 1
          type: string
        lifecycleState:
          description: Lifecycle state of the link.
          enum:
          - CREATING
          - ACTIVE
          - INACTIVE
          - UPDATING
          - FAILED
          - TERMINATED
          example: ACTIVE
          type: string
          x-obmcs-top-level-enum: '#/definitions/LifecycleState'
        parentTenancyId:
          description: OCID of the parent tenancy.
          maxLength: 255
          minLength: 1
          type: string
        systemTags:
          additionalProperties:
            additionalProperties:
              description: 'The value of the tag. Only string, integer, and boolean types are supported.

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

              Example: `{"bar-key": "value"}`

              '
            type: object
          description: 'Usage of system tag keys. These predefined keys are scoped to namespaces.

            Example: `{"orcl-cloud": {"free-tier-retained": "true"}}`

            '
          type: object
        timeCreated:
          description: Date-time when this link was created
          example: 2016-08-29 09:12:33.001000+00:00
          format: date-time
          type: string
        timeTerminated:
          description: Date-time when this link was terminated.
          example: 2016-08-29 09:12:33.001000+00:00
          format: date-time
          type: string
        timeUpdated:
          description: Date-time when this link was last updated.
          example: 2016-08-29 09:12:33.001000+00:00
          format: date-time
          type: string
      required:
      - id
      - parentTenancyId
      - childTenancyId
      - timeCreated
  parameters:
    IfMatchHeader:
      description: 'For optimistic concurrency control. In the PUT or DELETE call

        for a resource, set the `if-match` parameter to the value of the

        etag from a previous GET or POST response for that resource.

        The resource will be updated or deleted only if the etag you

        provide matches the resource''s current etag value.

        '
      in: header
      name: if-match
      required: false
      schema:
        type: string
    SortOrderQueryParam:
      description: The sort order to use, whether 'asc' or 'desc'.
      in: query
      name: sortOrder
      x-default-description: The default order depends on what parameter is being sorted by.
      x-obmcs-top-level-enum: '#/definitions/SortOrder'
      schema:
        type: string
        enum:
        - ASC
        - DESC
    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
      x-default-description: 'null'
      schema:
        type: string
        minLength: 1
    FeatureQueryParam:
      description: The feature associated with this link.
      in: query
      name: feature
      required: false
      x-default-description: 'null'
      schema:
        type: string
        maxLength: 64
    ChildTenancyIdQueryParam:
      description: The ID of the child tenancy this link is associated with.
      in: query
      name: childTenancyId
      required: false
      x-default-description: 'null'
      schema:
        type: string
        maxLength: 255
    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: 100
        maximum: 1000
        minimum: 1
    ParentTenancyIdQueryParam:
      description: The ID of the parent tenancy this link is associated with.
      in: query
      name: parentTenancyId
      required: false
      x-default-description: 'null'
      schema:
        type: string
        maxLength: 255
    LifecycleStateQueryParam:
      description: The lifecycle state of the resource.
      in: query
      name: lifecycleState
      x-default-description: 'null'
      x-obmcs-top-level-enum: '#/definitions/LifecycleState'
      schema:
        type: string
        enum:
        - CREATING
        - ACTIVE
        - INACTIVE
        - UPDATING
        - FAILED
        - TERMINATED
  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-refined-from:
- oci-organizations-1-openapi.yaml
- oci-organizations-openapi.yaml
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.
      type: integer
  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.

          Example: `{"bar-key": "value"}`

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

        Example: `{"foo-namespace": {"bar-key": "value"}}`

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

        Example: `{"bar-key": "value"}`

        '
      type: object
    systemTags:
      additionalProperties:
        additionalProperties:
          description: 'The value of the tag. Only string, integer and boolean types are supported.

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

          Example: `{"bar-key": "value"}`

          '
        type: object
      description: 'Usage of system tag keys. These predefined keys are scoped to namespaces.

        Example: `{"orcl-cloud": {"free-tier-retained": "true"}}`

        '
      type: object
x-obmcs-client-retries-enabled: true
x-oracle-package: com.oracle.idm.agcs.cp