Cycloid Organization Cloud Cost Management Accounts API

openapi: 3.2.0
info:
  description: This is the Cycloid's API Reference. It provides descriptions, syntax, and usage examples for each of the actions and data types available within our console.
  title: Welcome! Organization Cloud Cost Management Accounts API
  termsOfService: https://console.cycloid.io/terms
  contact:
    name: The Great Owl
    url: https://www.cycloid.io
    email: contact@cycloid.io
  license:
    name: Cycloid @copyrights
    url: https://cycloid.io
  version: '0'
servers:
- url: https://http-api.cycloid.io
security:
- api_key: []
- api_key_query: []
tags:
- name: Organization Cloud Cost Management Accounts
paths:
  ? /organizations/{organization_canonical}/cloud_cost_management/accounts/{cloud_cost_management_account_canonical}/linked_accounts
  : parameters:
    - $ref: '#/components/parameters/organization_canonical'
    - $ref: '#/components/parameters/cloud_cost_management_account_canonical'
    get:
      description: Return a list of cloud provider accounts linked to a specific Cloud Cost Management account.
      tags:
      - Organization Cloud Cost Management Accounts
      operationId: getCloudCostManagementLinkedAccounts
      responses:
        '200':
          description: List of linked accounts of a Cloud Cost Management account.
          content:
            application/json:
              schema:
                type: object
                required:
                - data
                properties:
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/CloudCostManagementLinkedAccount'
              example:
                data:
                - account_id: xxxxxx-xxxxxx-xxxxxxx
                  cloud_provider: aws
                  id: 102
                  name: A linked account
                - account_id: yyyyyy-yyyyyy-yyyyyyy
                  cloud_provider: aws
                  id: 109
                  name: Another linked account
        '403':
          $ref: '#/components/responses/not_enough_permissions'
        '404':
          $ref: '#/components/responses/not_found_entity_in_path'
        '422':
          $ref: '#/components/responses/unprocessable_entity'
        default:
          $ref: '#/components/responses/unexpected_error'
      summary: Get cloud cost management linked accounts
      x-summary-source: derived
  ? /organizations/{organization_canonical}/cloud_cost_management/accounts/{cloud_cost_management_account_canonical}/linked_accounts/{cloud_provider_account_id}
  : parameters:
    - $ref: '#/components/parameters/organization_canonical'
    - $ref: '#/components/parameters/cloud_cost_management_account_canonical'
    - $ref: '#/components/parameters/cloud_provider_account_id'
    put:
      description: Update a Cloud Cost Management linked account
      tags:
      - Organization Cloud Cost Management Accounts
      operationId: updateCloudCostManagementLinkedAccount
      responses:
        '200':
          description: Updated Cloud Cost Management linked account
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CloudCostManagementLinkedAccount'
              example:
                account_id: '123456789'
                cloud_provider: aws
                id: 99
                name: Updated linked account name
        '403':
          $ref: '#/components/responses/not_enough_permissions'
        '404':
          $ref: '#/components/responses/not_found_entity_in_path'
        '422':
          $ref: '#/components/responses/unprocessable_entity'
        default:
          $ref: '#/components/responses/unexpected_error'
      requestBody:
        content:
          application/vnd.cycloid.io.v1+json:
            schema:
              $ref: '#/components/schemas/UpdateCloudCostManagementLinkedAccount'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/UpdateCloudCostManagementLinkedAccount'
        description: The updated attributes of the Cloud Cost Management linked account
        required: true
      summary: Update cloud cost management linked account
      x-summary-source: derived
components:
  parameters:
    cloud_provider_account_id:
      description: The id of an account in the Cloud Provider.
      name: cloud_provider_account_id
      in: path
      required: true
      schema:
        type: string
    cloud_cost_management_account_canonical:
      description: The canonical of an CloudCostManagementAccount.
      name: cloud_cost_management_account_canonical
      in: path
      required: true
      schema:
        type: string
        maxLength: 100
        minLength: 2
        pattern: ^[a-z0-9]([a-z0-9\-_]*[a-z0-9])?$
    organization_canonical:
      description: A canonical of an organization.
      name: organization_canonical
      in: path
      required: true
      schema:
        type: string
        maxLength: 100
        minLength: 2
        pattern: ^[a-z0-9]([a-z0-9\-_]*[a-z0-9])?$
  responses:
    not_found_entity_in_path:
      description: The response sent when any of the entities present in the path is not found.
      headers:
        Content-Length:
          description: The length of the response body in octets (8-bit bytes).
          schema:
            type: integer
            format: uint64
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorPayload'
          example:
            errors:
            - code: NotFoundEntity
              message: Entity not found
    not_enough_permissions:
      description: The authenticated user cannot perform the operation because, it doesn't have permissions for such operation.
      headers:
        Content-Length:
          description: The length of the response body in octets (8-bit bytes).
          schema:
            type: integer
            format: uint64
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorPayload'
          example:
            errors:
            - code: Unauthorized
              message: Not enough permissions to perform the operation
    unprocessable_entity:
      description: All the custom errors that are generated from the Cycloid API
      headers:
        Content-Length:
          description: The length of the response body in octets (8-bit bytes).
          schema:
            type: integer
            format: uint64
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorPayload'
          example:
            errors:
            - code: SomeCode
              message: some error
    unexpected_error:
      description: The response sent when an unexpected error happened, as known as an internal server error.
      headers:
        Content-Length:
          description: The length of the response body in octets (8-bit bytes).
          schema:
            type: integer
            format: uint64
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorPayload'
          example:
            errors:
            - code: Unexpected
              message: Server Internal error
  schemas:
    ErrorPayload:
      description: 'The payload used by the server to response to the client with an Error, those errors could be any of the ones listed [here](https://github.com/cycloidio/youdeploy-http-api/blob/develop/errors/code.go#L10), only the CODE of the error is the one that is guaranteed to not change between the same major version, the MESSAGE could change.

        '
      title: Error Payload
      required:
      - errors
      properties:
        errors:
          type: array
          items:
            $ref: '#/components/schemas/ErrorDetailsItem'
        request_id:
          type: string
    CloudCostManagementLinkedAccount:
      description: 'An account that is linked to a Cloud Cost Management account in the cloud

        provider. It is not managed by Cloud Cost Management, but appears in the cost records.

        '
      type: object
      title: CloudCostManagementLinkedAccount
      required:
      - id
      - name
      - account_id
      - cloud_provider
      properties:
        account_id:
          description: ID of the account in the cloud provider
          type: string
        cloud_provider:
          description: 'The cloud provider canonical that this project is using - between the

            supported ones.

            '
          type: string
        id:
          type: integer
          format: uint32
          minimum: 1
        name:
          description: A user-defined name for the account
          type: string
    UpdateCloudCostManagementLinkedAccount:
      description: 'Attributes of a CCM linked accout that can be updated by a user.

        '
      type: object
      title: Update CloudCostManagementLinkedAccount
      required:
      - name
      properties:
        name:
          type: string
    ErrorDetailsItem:
      description: Represents an item of the list of details of an error.
      title: Error details item
      required:
      - message
      - code
      properties:
        code:
          type: string
        details:
          type: array
          items:
            type: string
        message:
          type: string
  securitySchemes:
    api_key:
      description: The API authorization is done with JWT tokens
      type: apiKey
      name: Authorization
      in: header
    api_key_query:
      description: The API authorization is done with JWT tokens in the query string
      type: apiKey
      name: api_key
      in: query