openapi: 3.2.0
info:
  title: Oracle Organization API
  version: '1.0'
  description: 'Operations tagged organization 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: organization
paths:
  /childTenancies:
    post:
      description: Creates a child tenancy asynchronously.
      operationId: CreateChildTenancy
      parameters:
      - $ref: '#/components/parameters/RetryTokenHeader'
      - $ref: '#/components/parameters/RequestIdHeader'
      responses:
        202:
          description: Child tenancy creation accepted.
          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'
        409:
          $ref: '#/components/responses/409'
        429:
          $ref: '#/components/responses/429'
        500:
          $ref: '#/components/responses/500'
        default:
          $ref: '#/components/responses/default'
      summary: Creates a child tenancy asynchronously.
      tags:
      - organization
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateChildTenancyDetails'
        description: Parameters to create a child tenancy.
        required: true
  /organizationTenancies/{organizationTenancyId}:
    delete:
      description: If certain validations are successful, initiate tenancy termination.
      operationId: DeleteOrganizationTenancy
      parameters:
      - description: OCID of the tenancy to be terminated.
        in: path
        name: organizationTenancyId
        required: true
        schema:
          type: string
          maxLength: 255
      - $ref: '#/components/parameters/IfMatchHeader'
      - $ref: '#/components/parameters/RequestIdHeader'
      - $ref: '#/components/parameters/RetryTokenHeader'
      responses:
        202:
          description: Tenancy termination initiated.
          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'
        409:
          $ref: '#/components/responses/409'
        412:
          $ref: '#/components/responses/412'
        429:
          $ref: '#/components/responses/429'
        500:
          $ref: '#/components/responses/500'
        default:
          $ref: '#/components/responses/default'
      summary: Initiate tenancy termination.
      tags:
      - organization
      x-related-resource: '#/definitions/OrganizationTenancy'
  /organizationTenancies/{organizationTenancyId}/actions/approveForTransfer:
    post:
      description: Approve an organization's child tenancy for transfer.
      operationId: ApproveOrganizationTenancyForTransfer
      parameters:
      - $ref: '#/components/parameters/CompartmentIdQueryParam'
      - description: OCID of the child tenancy.
        in: path
        name: organizationTenancyId
        required: true
        schema:
          type: string
          maxLength: 255
      - $ref: '#/components/parameters/IfMatchHeader'
      - $ref: '#/components/parameters/RetryTokenHeader'
      - $ref: '#/components/parameters/RequestIdHeader'
      responses:
        200:
          description: Organization's child tenancy was successfully approved for transfer.
          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/OrganizationTenancy'
        400:
          $ref: '#/components/responses/400'
        401:
          $ref: '#/components/responses/401'
        404:
          $ref: '#/components/responses/404'
        409:
          $ref: '#/components/responses/409'
        412:
          $ref: '#/components/responses/412'
        429:
          $ref: '#/components/responses/429'
        500:
          $ref: '#/components/responses/500'
        default:
          $ref: '#/components/responses/default'
      summary: Approve an organization's child tenancy for transfer.
      tags:
      - organization
      x-related-resource: '#/definitions/OrganizationTenancy'
  /organizationTenancies/{organizationTenancyId}/actions/restore:
    post:
      description: An asynchronous API to restore a tenancy.
      operationId: RestoreOrganizationTenancy
      parameters:
      - description: OCID of the tenancy to be restored.
        in: path
        name: organizationTenancyId
        required: true
        schema:
          type: string
          maxLength: 255
      - $ref: '#/components/parameters/IfMatchHeader'
      - $ref: '#/components/parameters/RequestIdHeader'
      responses:
        202:
          description: Request to restore the tenancy is accepted.
          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: Restore tenancy.
      tags:
      - organization
      x-related-resource: '#/definitions/OrganizationTenancy'
  /organizationTenancies/{organizationTenancyId}/actions/unapproveForTransfer:
    post:
      description: Cancel an organization's child tenancy for transfer.
      operationId: UnapproveOrganizationTenancyForTransfer
      parameters:
      - $ref: '#/components/parameters/CompartmentIdQueryParam'
      - description: OCID of the child tenancy.
        in: path
        name: organizationTenancyId
        required: true
        schema:
          type: string
          maxLength: 255
      - $ref: '#/components/parameters/IfMatchHeader'
      - $ref: '#/components/parameters/RetryTokenHeader'
      - $ref: '#/components/parameters/RequestIdHeader'
      responses:
        200:
          description: Organization's child tenancy was successfully canceled for transfer.
          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/OrganizationTenancy'
        400:
          $ref: '#/components/responses/400'
        401:
          $ref: '#/components/responses/401'
        404:
          $ref: '#/components/responses/404'
        409:
          $ref: '#/components/responses/409'
        412:
          $ref: '#/components/responses/412'
        429:
          $ref: '#/components/responses/429'
        500:
          $ref: '#/components/responses/500'
        default:
          $ref: '#/components/responses/default'
      summary: Cancel an organization's child tenancy for transfer.
      tags:
      - organization
      x-related-resource: '#/definitions/OrganizationTenancy'
  /organizations:
    get:
      description: Lists organizations associated with the caller.
      operationId: ListOrganizations
      parameters:
      - $ref: '#/components/parameters/CompartmentIdQueryParam'
      - $ref: '#/components/parameters/RequestIdHeader'
      - $ref: '#/components/parameters/PaginationTokenQueryParam'
      - $ref: '#/components/parameters/PaginationLimitQueryParam'
      responses:
        200:
          description: The operation succeeded.
          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/OrganizationCollection'
        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 organizations associated with the caller.
      tags:
      - organization
      x-related-resource: '#/definitions/Organization'
  /organizations/{organizationId}:
    get:
      description: Gets information about the organization.
      operationId: GetOrganization
      parameters:
      - description: OCID of the organization to retrieve.
        in: path
        name: organizationId
        required: true
        schema:
          type: string
          maxLength: 255
      - $ref: '#/components/parameters/RequestIdHeader'
      responses:
        200:
          description: The operation succeeded.
          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/Organization'
        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 organization.
      tags:
      - organization
      x-related-resource: '#/definitions/Organization'
    put:
      description: Map the default subscription to the organization.
      operationId: UpdateOrganization
      parameters:
      - description: OCID of the organization.
        in: path
        name: organizationId
        required: true
        schema:
          type: string
          maxLength: 255
      - $ref: '#/components/parameters/RequestIdHeader'
      - $ref: '#/components/parameters/IfMatchHeader'
      - $ref: '#/components/parameters/RetryTokenHeader'
      responses:
        202:
          description: Default subscription mapping to the organization accepted.
          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'
        409:
          $ref: '#/components/responses/409'
        412:
          $ref: '#/components/responses/412'
        429:
          $ref: '#/components/responses/429'
        500:
          $ref: '#/components/responses/500'
        default:
          $ref: '#/components/responses/default'
      summary: Assign the subscription to the organization.
      tags:
      - organization
      x-related-resource: '#/definitions/Organization'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateOrganizationDetails'
        description: The information to be updated.
        required: true
  /organizations/{organizationId}/tenancies:
    get:
      description: Gets a list of tenancies in the organization.
      operationId: ListOrganizationTenancies
      parameters:
      - description: OCID of the organization.
        in: path
        name: organizationId
        required: true
        schema:
          type: string
          maxLength: 255
      - $ref: '#/components/parameters/RequestIdHeader'
      - $ref: '#/components/parameters/PaginationTokenQueryParam'
      - $ref: '#/components/parameters/PaginationLimitQueryParam'
      responses:
        200:
          description: OrganizationTenancyCollection successfully retrieved.
          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/OrganizationTenancyCollection'
        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 a list of tenancies in the organization.
      tags:
      - organization
      x-related-resource: '#/definitions/Organization'
  /organizations/{organizationId}/tenancies/{tenancyId}:
    get:
      description: Gets information about the organization's tenancy.
      operationId: GetOrganizationTenancy
      parameters:
      - description: OCID of the organization.
        in: path
        name: organizationId
        required: true
        schema:
          type: string
          maxLength: 255
      - description: OCID of the tenancy to retrieve.
        in: path
        name: tenancyId
        required: true
        schema:
          type: string
          maxLength: 255
      - $ref: '#/components/parameters/RequestIdHeader'
      responses:
        200:
          description: OrganizationTenancy successfully 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/OrganizationTenancy'
        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 organization's tenancy.
      tags:
      - organization
      x-related-resource: '#/definitions/OrganizationTenancy'
components:
  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'
  parameters:
    CompartmentIdQueryParam:
      description: The ID of the compartment in which to list resources.
      in: query
      name: compartmentId
      required: true
      schema:
        type: string
        maxLength: 255
    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
    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
    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
    RetryTokenHeader:
      description: 'A token that uniquely identifies a request, so it can be retried in case of a timeout or

        server error, without risk of executing that same action again. Retry tokens expire after 24

        hours, but can be invalidated before then due to conflicting operations. For example, if a resource

        has been deleted and purged from the system, then a retry of the original creation request

        will be rejected.

        '
      in: header
      name: opc-retry-token
      required: false
      schema:
        type: string
        maxLength: 64
        minLength: 1
  schemas:
    OrganizationSummary:
      description: An organization entity.
      properties:
        compartmentId:
          description: OCID of the compartment containing the organization. Always a tenancy OCID.
          maxLength: 255
          minLength: 1
          type: string
        defaultUcmSubscriptionId:
          description: OCID of the default Universal Credits Model subscription. Any tenancy joining the organization will automatically get assigned this subscription, if a subscription is not explictly assigned.
          maxLength: 255
          minLength: 1
          type: string
        displayName:
          description: A display name for the organization. Avoid entering confidential information.
          maxLength: 255
          minLength: 1
          type: string
        id:
          description: OCID of the organization.
          maxLength: 255
          minLength: 1
          type: string
        lifecycleState:
          description: Lifecycle state of the organization.
          example: ACTIVE
          type: string
          x-obmcs-enumref: '#/definitions/Organization/lifecycleState'
        parentName:
          description: The name of the tenancy that is the organization parent.
          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 and time when the organization was created.
          example: 2016-08-29 09:12:33.001000+00:00
          format: date-time
          type: string
        timeUpdated:
          description: Date and time when the organization was last updated.
          example: 2016-08-29 09:12:33.001000+00:00
          format: date-time
          type: string
      required:
      - id
      - compartmentId
      - defaultUcmSubscriptionId
      - timeCreated
      - lifecycleState
    OrganizationTenancy:
      description: The information about the organization tenancy.
      properties:
        governanceStatus:
          description: The governance status of the tenancy.
          enum:
          - OPTED_IN
          - OPTED_OUT
          example: OPTED_IN
          type: string
          x-obmcs-top-level-enum: '#/definitions/GovernanceStatus'
        isApprovedForTransfer:
          description: Parameter to indicate the tenancy is approved for transfer to another organization.
          example: true
          type: boolean
        lifecycleState:
          description: Lifecycle state of the organization tenancy.
          enum:
          - CREATING
          - ACTIVE
          - INACTIVE
          - DELETED
          - FAILED
          - DELETING
          example: ACTIVE
          type: string
          x-obmcs-top-level-enum: '#/definitions/OrganizationTenancyLifecycleState'
        name:
          description: Name of the tenancy.
          example: someTenancy123
          type: string
        role:
          description: Role of the organization tenancy.
          enum:
          - PARENT
          - CHILD
          - NONE
          example: PARENT
          type: string
          x-obmcs-top-level-enum: '#/definitions/OrganizationTenancyRole'
        tenancyId:
          description: OCID of the tenancy.
          maxLength: 255
          minLength: 1
          type: string
        timeJoined:
          description: Date and time when the tenancy joined the organization.
          example: 2016-08-29 09:12:33.001000+00:00
          format: date-time
          type: string
        timeLeft:
          description: Date and time when the tenancy left the organization.
          example: 2016-08-29 09:12:33.001000+00:00
          format: date-time
          type: string
      required:
      - tenancyId
      - governanceStatus
    OrganizationCollection:
      description: Result of a query request for a list of organizations. Contains OrganizationSummary items.
      properties:
        items:
          description: Array containing OrganizationSummary items.
          items:
            $ref: '#/components/schemas/OrganizationSummary'
          type: array
      required:
      - items
      type: object
    Organization:
      description: An organization entity.
      properties:
        compartmentId:
          description: OCID of the compartment containing the organization. Always a tenancy OCID.
          maxLength: 255
          minLength: 1
          type: string
        defaultUcmSubscriptionId:
          description: OCID of the default Universal Credits Model subscription. Any tenancy joining the organization will automatically get assigned this subscription, if a subscription is not explictly assigned.
          maxLength: 255
          minLength: 1
          type: string
        displayName:
          description: A display name for the organization. Avoid entering confidential information.
          maxLength: 255
          minLength: 1
          type: string
        id:
          description: OCID of the organization.
          maxLength: 255
          minLength: 1
          type: string
        lifecycleState:
          description: Lifecycle state of the organization.
          enum:
          - CREATING
          - ACTIVE
          - UPDATING
          - DELETING
          - DELETED
          - FAILED
          example: ACTIVE
          type: string
        parentName:
          description: The name of the tenancy that is the organization parent.
          maxLength: 255
          minLength: 1
          type: string
        timeCreated:
          description: Date and time when the organization was created.
          example: 2016-08-29 09:12:33.001000+00:00
          format: date-time
          type: string
        timeUpdated:
          description: Date and time when the organization was last updated.
          example: 2016-08-29 09:12:33.001000+00:00
          format: date-time
          type: string
      required:
      - id
      - compartmentId
      - defaultUcmSubscriptionId
      - timeCreated
      - lifecycleState
    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
    CreateChildTenancyDetails:
      description: The parameters for creating a child tenancy.
      properties:
        adminEmail:
          description: Email address of the child tenancy administrator.
          maxLength: 255
          minLength: 6
          type: string
        compartmentId:
          description: The tenancy ID of the parent tenancy.
          maxLength: 255
          minLength: 1
          type: string
        features:
          description: List of features that the child and parent tenancies will have links for. Link with feature CORE will always be created.
          example:
          - CORE
          items:
            maxLength: 64
            minLength: 1
            type: string
          maxItems: 10
          type: array
          uniqueItems: true
        governanceStatus:
          default: OPTED_OUT
          description: The governance status of the child tenancy.
          enum:
          - OPTED_IN
          - OPTED_OUT
          example: OPTED_IN
          type: string
          x-obmcs-top-level-enum: '#/definitions/GovernanceStatus'
        homeRegion:
          description: The home region to use for the child tenancy. This must be a region where the parent tenancy is subscribed.
          example: us-ashburn-1
          maxLength: 24
          minLength: 1
          type: string
        policyName:
          description: The name to use for the administrator policy in the child tenancy. Must contain only letters and underscores.
          example: admin_policy
          maxLength: 255
          minLength: 1
          type: string
          x-default-description: <tenancyName>_admin_policy
        subscriptionId:
          description: OCID of the subscription that needs to be assigned to the child tenancy.
          maxLength: 255
          minLength: 1
          type: string
          x-default-description: Newly create child tenancy will be mapped to the current default subscription of the organization.
        tenancyName:
          description: The tenancy name to use for the child tenancy.
          example: oracle-account
          maxLength: 255
          minLength: 1
          type: string
      required:
      - compartmentId
      - tenancyName
      - homeRegion
      - adminEmail
    OrganizationTenancyCollection:
      description: Result of a query request for a list of organization tenancies. Contains OrganizationTenancySummary items.
      properties:
        items:
          description: Array containing OrganizationTenancySummary items.
          items:
            $ref: '#/components/schemas/OrganizationTenancySummary'
          type: array
      required:
      - items
      type: object
    UpdateOrganizationDetails:
      description: The parameters for updating an organization.
      properties:
        defaultUcmSubscriptionId:
          description: OCID of the default Universal Credits Model subscription. Any tenancy joining the organization will automatically get assigned this subscription, if a subscription is not explictly assigned.
          maxLength: 255
          minLength: 1
          type: string
    OrganizationTenancySummary:
      description: An organization tenancy summary entity.
      properties:
        governanceStatus:
          description: The governance status of the tenancy.
          enum:
          - OPTED_IN
          - OPTED_OUT
          example: OPTED_IN
          type: string
          x-obmcs-top-level-enum: '#/definitions/GovernanceStatus'
        isApprovedForTransfer:
          description: Parameter to indicate the tenancy is approved for transfer to another organization.
          example: true
          type: boolean
        lifecycleState:
          description: Lifecycle state of the organization tenancy.
          enum:
          - CREATING
          - ACTIVE
          - INACTIVE
          - DELETED
          - FAILED
          - DELETING
          example: ACTIVE
          type: string
          x-obmcs-top-level-enum: '#/definitions/OrganizationTenancyLifecycleState'
        name:
          description: Name of the tenancy.
          example: someTenancy123
          type: string
        role:
          description: Role of the organization tenancy.
          enum:
          - PARENT
          - CHILD
          - NONE
          example: PARENT
          type: string
          x-obmcs-top-level-enum: '#/definitions/OrganizationTenancyRole'
        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
        tenancyId:
          description: OCID of the tenancy.
          maxLength: 255
          minLength: 1
          type: string
        timeJoined:
          description: Date and time when the tenancy joined the organization.
          example: 2016-08-29 09:12:33.001000+00:00
          format: date-time
          type: string
        timeLeft:
          description: Date and time when the tenancy left the organization.
          example: 2016-08-29 09:12:33.001000+00:00
          format: date-time
          type: string
      required:
      - tenancyId
      - governanceStatus
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