unity.yml

openapi: 3.0.0
info:
  title: Unity API Service
  version: 0.1.0
  license:
    name: MIT
    url: 'https://opensource.org/licenses/MIT'
servers:
  - url: /api/v2/quartz
paths:
  /account:
    delete:
      operationId: DeleteAccount
      summary: Self-delete account
      requestBody:
        content:
          application/json; charset=utf-8:
            schema:
              type: object
      responses:
        '204':
          description: Account deleted
        '401':
          description: Unauthorized/Account doesn't exist
          $ref: '#/components/responses/ServerError'
        '403':
          description: Account is not deletable
          $ref: '#/components/responses/ServerError'
        default:
          description: Unexpected error
          $ref: '#/components/responses/ServerError'
  /accounts:
    get:
      operationId: GetAccounts
      tags:
        - Accounts
      summary: Get the list of accounts for the current user
      responses:
        '200':
          description: Accounts
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/UserAccount'
        '401':
          description: Unauthorized
          $ref: '#/components/responses/ServerError'
        default:
          description: Unexpected error
          $ref: '#/components/responses/ServerError'
  '/accounts/{accountId}':
    get:
      operationId: GetAccountsId
      tags:
        - Accounts
      summary: Get an account
      parameters:
        - $ref: '#/components/parameters/TraceSpan'
        - in: path
          name: accountId
          schema:
            type: string
          required: true
          description: The ID of the account to get.
      responses:
        '200':
          description: The Account
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Account'
        '401':
          description: Unauthorized
          $ref: '#/components/responses/ServerError'
        default:
          description: Unexpected error
          $ref: '#/components/responses/ServerError'
    patch:
      operationId: PatchAccountsId
      tags:
        - Accounts
      summary: Update an account
      requestBody:
        description: Account update to apply
        required: true
        content:
          application/json:
            schema:
              properties:
                name:
                  type: string
                  description: name of the account
              required:
                - name
      parameters:
        - $ref: '#/components/parameters/TraceSpan'
        - in: path
          name: accountId
          schema:
            type: string
          required: true
          description: The ID of the account to update.
      responses:
        '200':
          description: Account updated
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Account'
        '401':
          description: Unauthorized
          $ref: '#/components/responses/ServerError'
        '422':
          description: Missing or invalid information
          $ref: '#/components/responses/ServerError'
        default:
          description: Unexpected error
          $ref: '#/components/responses/ServerError'
  '/accounts/{accountId}/orgs':
    get:
      operationId: GetAccountOrganizations
      tags:
        - Accounts
        - Organizations
      summary: Get the list of Organizations for the given Account
      parameters:
        - $ref: '#/components/parameters/TraceSpan'
        - in: path
          name: accountId
          schema:
            type: string
          required: true
          description: The ID of the Account for which to list Organizations.
      responses:
        '200':
          description: Organizations
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OrganizationSummaries'
        '401':
          description: Unauthorized
          $ref: '#/components/responses/ServerError'
        default:
          description: Unexpected error
          $ref: '#/components/responses/ServerError'
  '/accounts/{accountId}/orgs/default':
    put:
      operationId: PutAccountDefaultOrganization
      tags:
        - Organization
      parameters:
        - in: path
          name: accountId
          schema:
            type: string
          required: true
          description: The ID of the account setting default organization
      requestBody:
        description: The organization to set as the user's default organization
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/OrganizationDefaultRequest'
      responses:
        '204':
          description: default organization set
        '404':
          description: Organization not found
          $ref: '#/components/responses/ServerError'
        '422':
          description: Missing or invalid information
          $ref: '#/components/responses/ServerError'
        default:
          description: Unexpected error
          $ref: '#/components/responses/ServerError'
  /accounts/default:
    put:
      operationId: PutDefaultAccount
      tags:
        - Accounts
      requestBody:
        description: The account to set as the user's default account
        required: true
        content:
          application/json:
            schema:
              properties:
                id:
                  type: number
                  description: account id in quartz
              required:
                - id
      responses:
        '204':
          description: default account set
        default:
          description: Unexpected error
          $ref: '#/components/responses/ServerError'
  /allowances/orgs/create:
    get:
      operationId: GetAllowancesOrgsCreate
      tags:
        - Allowances
        - Organizations
      summary: Return whether a new Organization can be created.
      parameters:
        - $ref: '#/components/parameters/TraceSpan'
      responses:
        '200':
          description: The Allowance
          content:
            application/json:
              schema:
                properties:
                  allowed:
                    type: boolean
                    description: is the operation allowed?
                  availableUpgrade:
                    $ref: '#/components/schemas/IdentityAccount/properties/availableUpgrade'
                    description: what upgrade option is available for this allowance?
                required:
                  - allowed
                  - availableUpgrade
  /clusters:
    get:
      operationId: GetClusters
      tags:
        - Clusters
      summary: Get the list of clusters
      responses:
        '200':
          description: Clusters
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Clusters'
        '401':
          description: Unauthorized
          $ref: '#/components/responses/ServerError'
        default:
          description: Unexpected error
          $ref: '#/components/responses/ServerError'
  /billing:
    get:
      operationId: GetBilling
      tags:
        - Billing
      responses:
        '200':
          description: Billing information for account
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BillingInfo'
        default:
          description: Unexpected error
          $ref: '#/components/responses/ServerError'
  /identity:
    get:
      operationId: GetIdentity
      tags:
        - Identity
        - User
        - Account
        - Organization
      responses:
        '200':
          description: 'identity represented by the active user, account, and org'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Identity'
        '401':
          description: Unauthorized
          $ref: '#/components/responses/ServerError'
        default:
          description: Unexpected error
          $ref: '#/components/responses/ServerError'
  /marketplace:
    get:
      operationId: GetMarketplace
      tags:
        - Marketplace
      responses:
        '200':
          description: Marketplace information for account
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Marketplace'
        '401':
          description: Not Authorized or Invalid Session
          $ref: '#/components/responses/ServerError'
        '404':
          description: Marketplace not found
          $ref: '#/components/responses/ServerError'
        default:
          description: Unexpected error
          $ref: '#/components/responses/ServerError'
  /billing/start_date:
    get:
      operationId: GetBillingStartDate
      tags:
        - Billing
      responses:
        '200':
          description: Start of the current billing period for the Account
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BillingDate'
        default:
          description: Unexpected error
          $ref: '#/components/responses/ServerError'
  /usage/vectors:
    get:
      operationId: GetUsageVectors
      tags:
        - Usage
      responses:
        '200':
          description: List of usage vectors for the account
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UsageVectors'
        '401':
          description: Unauthorized
          $ref: '#/components/responses/ServerError'
        '404':
          description: Pricing version not 4 or User/Org not found
          $ref: '#/components/responses/ServerError'
        default:
          description: Unexpected error
          $ref: '#/components/responses/ServerError'
  '/usage/{vector_name}':
    get:
      operationId: GetUsagetype
      tags:
        - Usage
      parameters:
        - in: path
          name: vector_name
          required: true
          schema:
            $ref: '#/components/schemas/VectorName'
          description: The name of the UsageVector to query.
          example: reads_gb
        - in: query
          name: range
          schema:
            $ref: '#/components/schemas/TimeRange'
      responses:
        '200':
          description: Usage history for account
          content:
            application/csv:
              schema:
                type: string
                example: |
                  #group,false,false,true,false,false
                  #datatype,string,long,string,dateTime:RFC3339,long
                  #default,reads_gb,,,,
                  ,result,table,_field,_time,_value
                  ,,0,reads_gb,2021-01-13T22:05:00Z,120
        '400':
          description: Invalid query param name - Bad request
          $ref: '#/components/responses/ServerError'
        '401':
          description: Unauthorized
          $ref: '#/components/responses/ServerError'
        '404':
          description: Invalid vector_name or start or User/Org not found
          $ref: '#/components/responses/ServerError'
        default:
          description: Unexpected error
          $ref: '#/components/responses/ServerError'
  /usage/billing_stats:
    get:
      operationId: GetUsageBilling
      tags:
        - Usage
      responses:
        '200':
          description: Billing stats for Account current billing period
          content:
            text/csv:
              schema:
                type: string
                example: |
                  #group,false,false,true,false,false
                  #datatype,string,long,string,dateTime:RFC3339,long
                  #default,billing_stats,,,,
                  ,result,table,_field,_time,_value
                  ,,0,billing_stats,2021-01-13T22:05:00Z,120
        '401':
          description: Unauthorized
          $ref: '#/components/responses/ServerError'
        default:
          description: Unexpected error
          $ref: '#/components/responses/ServerError'
  /usage/rate_limits:
    get:
      operationId: GetUsageLimits
      tags:
        - Usage
      parameters:
        - in: query
          name: range
          schema:
            $ref: '#/components/schemas/TimeRange'
      responses:
        '200':
          description: Limit history for Account
          content:
            application/csv:
              schema:
                type: string
                example: |
                  #group,false,false,true,false,false
                  #datatype,string,long,string,dateTime:RFC3339,long
                  #default,rate_limits,,,,
                  ,result,table,_field,_time,_value
                  ,,0,rate_limits,2021-01-13T22:05:00Z,120
        '400':
          description: Invalid query param name - Bad request
          $ref: '#/components/responses/ServerError'
        '401':
          description: Unauthorized
          $ref: '#/components/responses/ServerError'
        '404':
          description: Invalid vector_name or start or User/Org not found
          $ref: '#/components/responses/ServerError'
        default:
          description: Unexpected error
          $ref: '#/components/responses/ServerError'
  /settings/notifications:
    get:
      operationId: GetSettingsNotifications
      tags:
        - Settings
      responses:
        '200':
          description: Settings for billing notifications
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BillingNotifySettings'
        '401':
          description: Unauthorized
          $ref: '#/components/responses/ServerError'
        '404':
          description: Notification Settings nil or User/Org not found
          $ref: '#/components/responses/ServerError'
        '406':
          description: Not Acceptable
          $ref: '#/components/responses/ServerError'
        default:
          description: Unexpected error
          $ref: '#/components/responses/ServerError'
    put:
      operationId: PutSettingsNotifications
      tags:
        - Settings
      requestBody:
        description: Update to notify setting
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BillingNotifySettings'
      responses:
        '200':
          description: billing notification settings updated
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BillingNotifySettings'
        '400':
          description: Bad Request
          $ref: '#/components/responses/ServerError'
        '401':
          description: Unauthorized
          $ref: '#/components/responses/ServerError'
        default:
          description: Unexpected error
          $ref: '#/components/responses/ServerError'
  /billing/contact:
    put:
      operationId: PutBillingContact
      tags:
        - Billing
      requestBody:
        description: BillingContact to update
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BillingContact'
      responses:
        '200':
          description: billing contact updated
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BillingContact'
        default:
          description: Unexpected error
          $ref: '#/components/responses/ServerError'
  '/payment_form/{form}':
    get:
      operationId: GetPaymentForm
      tags:
        - PaymentGateway
      parameters:
        - in: path
          name: form
          required: true
          schema:
            $ref: '#/components/schemas/PaymentFormType'
          example: checkout
      responses:
        '200':
          description: A CreditCard Form parameter object
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreditCardParams'
        '400':
          description: Bad Request
          $ref: '#/components/responses/ServerError'
        '401':
          description: Unauthorized
          $ref: '#/components/responses/ServerError'
        '404':
          description: User or Form not found
          $ref: '#/components/responses/ServerError'
        '406':
          description: Not Acceptable
          $ref: '#/components/responses/ServerError'
        default:
          description: Unexpected error
          $ref: '#/components/responses/ServerError'
  /billing/payment_method:
    put:
      operationId: PutPaymentMethod
      tags:
        - Billing
      requestBody:
        description: PaymentMethod to update
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PaymentMethodPut'
      responses:
        '200':
          description: Payment method updated
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaymentMethod'
        default:
          description: Unexpected error
          $ref: '#/components/responses/ServerError'
  /billing/invoices:
    get:
      operationId: GetInvoices
      tags:
        - Billing
      responses:
        '200':
          description: A list of invoices
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Invoices'
        '401':
          description: Unauthorized
          $ref: '#/components/responses/ServerError'
        default:
          description: Unexpected error
          $ref: '#/components/responses/ServerError'
  '/billing/invoices/{invoiceId}':
    get:
      operationId: GetInvoicesId
      tags:
        - Billing
      parameters:
        - $ref: '#/components/parameters/TraceSpan'
        - in: path
          name: invoiceId
          schema:
            type: string
          required: true
          description: The ID of the invoice to get.
      responses:
        '200':
          description: Returns the raw binary for the json pdf
          content:
            application/pdf:
              schema:
                type: string
                format: binary
        '401':
          description: Not Authorized or Invalid Session
          $ref: '#/components/responses/ServerError'
        '404':
          description: Invoice not found
          $ref: '#/components/responses/ServerError'
        default:
          description: Unexpected error
          $ref: '#/components/responses/ServerError'
  /orgs:
    post:
      operationId: PostOrgs
      tags:
        - Organizations
      summary: Creates an organization
      requestBody:
        description: Information for provisioning an organization
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/OrganizationCreateRequest'
      responses:
        '201':
          description: |
            Created. The response body contains the newly created organization.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Organization'
        '401':
          description: Unauthorized. The token passed doesn't have permissions necessary to complete the request.
          $ref: '#/components/responses/ServerError'
        '403':
          description: Organization limit reached
          $ref: '#/components/responses/ServerError'
        '409':
          description: Conflict. The organization name is already in use.
          $ref: '#/components/responses/ServerError'
        '422':
          description: |
            Unprocessable entity.
            The error may indicate one of the following problems:
            - The request body isn't valid--the request is well-formed, but InfluxDB can't process it due to semantic errors.
            - You passed a parameter combination that InfluxDB doesn't support
          $ref: '#/components/responses/ServerError'
        default:
          description: Unexpected error
          $ref: '#/components/responses/ServerError'
  '/orgs/{orgId}':
    delete:
      operationId: DeleteOrgId
      tags:
        - Organization
      summary: Deletes an organization
      parameters:
        - in: path
          name: orgId
          schema:
            type: string
          required: true
          description: The IDPE ID of the organization to delete.
      requestBody:
        content:
          application/json; charset=utf-8:
            schema:
              type: object
      responses:
        '200':
          description: Organization successfully deleted.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Organization'
        '401':
          description: Unauthorized
          $ref: '#/components/responses/ServerError'
        '403':
          description: Forbidden
          $ref: '#/components/responses/ServerError'
        '404':
          description: Not Found
          $ref: '#/components/responses/ServerError'
        default:
          description: Unexpected error
          $ref: '#/components/responses/ServerError'
    get:
      operationId: GetOrgsId
      tags:
        - Organizations
      summary: Get an organization
      parameters:
        - in: path
          name: orgId
          schema:
            type: string
          required: true
          description: The IDPE ID of the organization to get.
      responses:
        '200':
          description: Organization returned successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Organization'
        '401':
          description: Unauthorized
          $ref: '#/components/responses/ServerError'
        default:
          description: Unexpected error
          $ref: '#/components/responses/ServerError'
    patch:
      operationId: PatchOrgsId
      tags:
        - Organizations
      summary: Update an organization
      requestBody:
        description: Organization update to apply
        required: true
        content:
          application/json:
            schema:
              properties:
                name:
                  type: string
                  description: The name of the organization.
                description:
                  type: string
                  description: The description of the organization.
      parameters:
        - in: path
          name: orgId
          schema:
            type: string
          required: true
          description: The IDPE ID of the organization to update.
      responses:
        '200':
          description: Organization updated
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Organization'
        '401':
          description: Unauthorized
          $ref: '#/components/responses/ServerError'
        '409':
          description: Conflict. The organization name is already in use.
          $ref: '#/components/responses/ServerError'
        '422':
          description: Missing or invalid information
          $ref: '#/components/responses/ServerError'
        default:
          description: Unexpected error
          $ref: '#/components/responses/ServerError'
  '/orgs/{orgId}/invites':
    get:
      operationId: GetInvites
      tags:
        - Invites
      parameters:
        - $ref: '#/components/parameters/TraceSpan'
        - in: path
          name: orgId
          description: Specifies the organization ID of the Invite.
          required: true
          schema:
            type: string
      responses:
        '200':
          description: A list of cloud invites
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Invites'
        '401':
          description: Unauthorized
          $ref: '#/components/responses/ServerError'
        '404':
          description: Session user not owner or Org not found
          $ref: '#/components/responses/ServerError'
        default:
          description: Unexpected error
          $ref: '#/components/responses/ServerError'
    post:
      operationId: PostOrgsIdInvites
      tags:
        - Invites
        - Organizations
      summary: Creates an invite to an organization
      parameters:
        - $ref: '#/components/parameters/TraceSpan'
        - in: path
          name: orgId
          schema:
            type: string
          required: true
          description: The organization ID.
      requestBody:
        description: Invite to be sent
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Invite'
      responses:
        '200':
          description: User added to organization
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OrgUser'
        '201':
          description: Invite sent
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Invite'
        '401':
          description: Unauthorized
          $ref: '#/components/responses/ServerError'
        '403':
          description: Cannot create invite for user or org
          $ref: '#/components/responses/ServerError'
        '404':
          description: Session user not owner or Org not found
          $ref: '#/components/responses/ServerError'
        '409':
          description: Conflict with invite email
          $ref: '#/components/responses/ServerError'
        '422':
          description: Missing information
          $ref: '#/components/responses/ServerError'
        '429':
          description: Too many requests
          $ref: '#/components/responses/ServerError'
        default:
          description: Unexpected error
          $ref: '#/components/responses/ServerError'
  '/orgs/{orgId}/invites/{inviteId}':
    delete:
      operationId: DeleteOrgsIdInviteId
      tags:
        - Invites
        - Organizations
      summary: Remove an invite to an organization
      requestBody:
        content:
          application/json; charset=utf-8:
            schema:
              type: object
      parameters:
        - $ref: '#/components/parameters/TraceSpan'
        - in: path
          name: inviteId
          schema:
            type: number
          required: true
          description: The ID of the invite to remove.
        - in: path
          name: orgId
          schema:
            type: string
          required: true
          description: The organization ID.
      responses:
        '204':
          description: Invite removed
        default:
          description: Unexpected error
          $ref: '#/components/responses/ServerError'
  '/orgs/{orgId}/invites/{inviteId}/resend':
    post:
      operationId: PostOrgsIdInvitesId
      tags:
        - Invites
        - Organizations
      summary: Re-sends an invite
      requestBody:
        content:
          application/json; charset=utf-8:
            schema:
              type: object
      parameters:
        - $ref: '#/components/parameters/TraceSpan'
        - in: path
          name: inviteId
          schema:
            type: number
          required: true
          description: The ID of the invite to resend.
        - in: path
          name: orgId
          schema:
            type: string
          required: true
          description: The organization ID.
      responses:
        '200':
          description: Invite resent
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Invite'
        '401':
          description: Not Authorized or Invalid Session
          $ref: '#/components/responses/ServerError'
        '404':
          description: Session user not owner or Invite/Org not found
          $ref: '#/components/responses/ServerError'
        default:
          description: Unexpected error
          $ref: '#/components/responses/ServerError'
  '/orgs/{orgId}/users':
    get:
      operationId: GetUsers
      tags:
        - Users
      parameters:
        - $ref: '#/components/parameters/TraceSpan'
        - in: path
          name: orgId
          description: Specifies the organization ID of the User.
          required: true
          schema:
            type: string
      responses:
        '200':
          description: A list of users
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OrgUsers'
        '401':
          description: Unauthorized
          $ref: '#/components/responses/ServerError'
        '404':
          description: Org or Users not found
          $ref: '#/components/responses/ServerError'
        default:
          description: Unexpected error
          $ref: '#/components/responses/ServerError'
  '/orgs/{orgId}/users/{userId}':
    delete:
      operationId: DeleteOrgsIdUserId
      tags:
        - Users
        - Organizations
      summary: Removes a user from an organization and account
      requestBody:
        content:
          application/json; charset=utf-8:
            schema:
              type: object
              properties:
                transferIdpeId:
                  type: string
                  description: User ID to transfer IDPE data to.
      parameters:
        - $ref: '#/components/parameters/TraceSpan'
        - in: path
          name: userId
          schema:
            type: string
          required: true
          description: The ID of the user to remove.
        - in: path
          name: orgId
          schema:
            type: string
          required: true
          description: The organization ID.
      responses:
        '204':
          description: User removed
        '400':
          description: User trying to remove self
          $ref: '#/components/responses/ServerError'
        '401':
          description: Unauthorized
          $ref: '#/components/responses/ServerError'
        '403':
          description: Cannot remove last user
          $ref: '#/components/responses/ServerError'
        '404':
          description: Session user not owner or User/Org not found
          $ref: '#/components/responses/ServerError'
        default:
          description: Unexpected error
          $ref: '#/components/responses/ServerError'
  '/orgs/{orgId}/limits':
    get:
      operationId: GetOrgsIdLimits
      tags:
        - Organizations
        - Operators
      summary: Get the limits of an organization
      parameters:
        - in: path
          name: orgId
          schema:
            type: string
          required: true
          description: The ID of the organization
      responses:
        '200':
          description: Organization limits
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OrgLimits'
        default:
          description: Unexpected error
          $ref: '#/components/responses/ServerError'
    put:
      operationId: PutOrgsIdLimits
      tags:
        - Organizations
        - Operators
      summary: Update the limits of an organization
      requestBody:
        content:
          application/json; charset=utf-8:
            schema:
              type: object
      parameters:
        - in: path
          name: orgId
          schema:
            type: string
          required: true
          description: The ID of the organization
      responses:
        '200':
          description: Organization limits
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OrgLimits'
        default:
          description: Unexpected error
          $ref: '#/components/responses/ServerError'
  /checkout:
    post:
      operationId: PostCheckout
      tags:
        - Accounts
      requestBody:
        description: Information for Upgrading Account
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CheckoutRequest'
      responses:
        '201':
          description: Created
        '400':
          description: Bad Request
          $ref: '#/components/responses/ServerError'
        '401':
          description: Unauthorized
          $ref: '#/components/responses/ServerError'
        '404':
          description: Org/User not found or Beta region
          $ref: '#/components/responses/ServerError'
        default:
          description: Unexpected error
          $ref: '#/components/responses/ServerError'
  /cancel:
    post:
      operationId: PostCancel
      description: Cancel an account
      requestBody:
        content:
          application/json; charset=utf-8:
            schema:
              type: object
      tags:
        - Accounts
      responses:
        '204':
          description: Account cancelled
        default:
          description: Unexpected error
          $ref: '#/components/responses/ServerError'
  /operator/accounts:
    get:
      operationId: GetAccountsForOperator
      tags:
        - Accounts
        - Operators
      summary: Get the list of accounts by search term
      parameters:
        - $ref: '#/components/parameters/TraceSpan'
        - in: query
          name: query
          schema:
            type: string
          required: false
          description: The partial email of any user in an account
        - in: query
          name: accountTypes
          schema:
            type: array
            items:
              $ref: '#/components/schemas/AccountType'
          required: false
          description: A list of account types to filter on
      responses:
        '200':
          description: Account
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OperatorAccounts'
        '401':
          description: Unauthorized
          $ref: '#/components/responses/ServerError'
        default:
          description: Unexpected error
          $ref: '#/components/responses/ServerError'
  '/operator/accounts/{accountId}':
    get:
      operationId: GetAccountById
      tags:
        - Accounts
        - Operators
      parameters:
        - $ref: '#/components/parameters/TraceSpan'
        - in: path
          name: accountId
          schema:
            type: string
          required: true
          description: The ID of the account to get.
      responses:
        '200':
          description: the account
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/OperatorAccount'
                  - properties:
                      organizations:
                        type: array
                        description: organizations in the account
                        $ref: '#/components/schemas/OperatorOrganizations'
                  - required:
                      - organizations
        '401':
          description: Unauthorized
          $ref: '#/components/responses/ServerError'
        '404':
          description: Account not found
          $ref: '#/components/responses/ServerError'
        default:
          description: Unexpected error
          $ref: '#/components/responses/ServerError'
    delete:
      operationId: DeleteAccountById
      requestBody:
        content:
          application/json; charset=utf-8:
            schema:
              type: object
      tags:
        - Accounts
        - Operators
      parameters:
        - $ref: '#/components/parameters/TraceSpan'
        - in: path
          name: accountId
          schema:
            type: string
          required: true
          description: The ID of the account to delete.
      responses:
        '204':
          description: Account deleted
        '400':
          description: Account is not deletable
          $ref: '#/components/responses/ServerError'
        '401':
          description: Unauthorized
          $ref: '#/components/responses/ServerError'
        '403':
          description: Account is not deletable
          $ref: '#/components/responses/ServerError'
        default:
          description: Unexpected error
          $ref: '#/components/responses/ServerError'
  '/operator/accounts/{accountId}/convert':
    patch:
      operationId: ConvertAccountById
      tags:
        - Accounts
      summary: Convert an account to contract
      requestBody:
        description: The data needed to convert the account
        required: true
        content:
          application/json:
            schema:
              properties:
                contractStartDate:
                  type: string
                  format: date-time
                  description: the date the contract starts (YYYY-MM-DD)
              required:
                - contractStartDate
      parameters:
        - $ref: '#/components/parameters/TraceSpan'
        - in: path
          name: accountId
          schema:
            type: string
          required: true
          description: The ID of the account to convert
      responses:
        '200':
          description: Account converted
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OperatorAccount'
        '401':
          description: Unauthorized
          $ref: '#/components/responses/ServerError'
        '422':
          description: Missing or invalid information
          $ref: '#/components/responses/ServerError'
        default:
          description: Unexpected error
          $ref: '#/components/responses/ServerError'
  '/operator/accounts/{fromAccountId}/migrate/{toAccountId}':
    patch:
      operationId: MigrateOrgsByAccountById
      tags:
        - Accounts
      summary: Migrates an account's organizations to another account
      requestBody:
        content:
          application/json; charset=utf-8:
            schema:
              type: object
      parameters:
        - $ref: '#/components/parameters/TraceSpan'
        - in: path
          name: fromAccountId
          schema:
            type: string
          required: true
          description: The ID of the account to migrate organizations from
        - in: path
          name: toAccountId
          schema:
            type: string
          required: true
          description: The ID of the account to migrate organizations to
      responses:
        '200':
          description: Account organizations moved to
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OperatorAccount'
        '401':
          description: Unauthorized
          $ref: '#/components/responses/ServerError'
        '422':
          description: Missing or invalid information
          $ref: '#/components/responses/ServerError'
        default:
          description: Unexpected error
          $ref: '#/components/responses/ServerError'
  '/operator/accounts/{accountId}/reactivate':
    patch:
      operationId: ReactivateAccountById
      tags:
        - Accounts
      summary: Reactivate a cancelled account
      requestBody:
        content:
          application/json; charset=utf-8:
            schema:
              type: object
      parameters:
        - $ref: '#/components/parameters/TraceSpan'
        - in: path
          name: accountId
          schema:
            type: string
          required: true
          description: The ID of the account to reactivate
      responses:
        '200':
          description: Account reactivated
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OperatorAccount'
        '401':
          description: Unauthorized
          $ref: '#/components/responses/ServerError'
        '422':
          description: Missing or invalid information
          $ref: '#/components/responses/ServerError'
        default:
          description: Unexpected error
          $ref: '#/components/responses/ServerError'
  /operator/providers:
    get:
      operationId: GetProvidersInfo
      tags:
        - Operators
        - Regions
        - Providers
      summary: Get a list of providers and their regions
      responses:
        '200':
          description: Provider and Region Info
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OperatorProvidersResponse'
        '401':
          description: Unauthorized
          $ref: '#/components/responses/ServerError'
        default:
          description: Unexpected error
          $ref: '#/components/responses/ServerError'
  /operator/orgs:
    get:
      operationId: GetOrganizations
      tags:
        - Organizations
        - Operators
      summary: Get the list of orgs by search term
      parameters:
        - $ref: '#/components/parameters/TraceSpan'
        - in: query
          name: query
          schema:
            type: string
          required: false
          description: The partial idpe id of the org being searched
        - in: query
          name: accountTypes
          schema:
            type: array
            items:
              $ref: '#/components/schemas/AccountType'
          required: false
          description: A list of account types to filter on
        - in: query
          name: providers
          schema:
            type: array
            items: string
          required: false
          description: An option list of providers to filter on
        - in: query
          name: regions
          schema:
            type: array
            items: string
          required: false
          description: An option list of regions to filter on
      responses:
        '200':
          description: Organization
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OperatorOrganizations'
        '401':
          description: Unauthorized
          $ref: '#/components/responses/ServerError'
        default:
          description: Unexpected error
          $ref: '#/components/responses/ServerError'
  '/operator/orgs/{orgId}':
    get:
      operationId: GetOrganizationById
      tags:
        - Organizations
        - Operators
      summary: Get organization by id
      parameters:
        - $ref: '#/components/parameters/TraceSpan'
        - in: path
          name: orgId
          schema:
            type: string
          required: true
          description: the idpe id of the org
      responses:
        '200':
          description: Organization
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/OperatorOrganization'
        '401':
          description: Unauthorized
          $ref: '#/components/responses/ServerError'
        '404':
          description: Org not found
          $ref: '#/components/responses/ServerError'
        default:
          description: Unexpected error
          $ref: '#/components/responses/ServerError'
  '/operator/orgs/{orgId}/limits':
    get:
      operationId: GetOrganizationLimitsById
      tags:
        - Organizations
        - Operators
      summary: Get the org's limits
      parameters:
        - $ref: '#/components/parameters/TraceSpan'
        - in: path
          name: orgId
          schema:
            type: string
          required: true
          description: The IDPE id of the org
      responses:
        '200':
          description: Organization Limits
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OperatorOrgLimits'
        '401':
          description: Unauthorized
          $ref: '#/components/responses/ServerError'
        '404':
          description: Org not found
          $ref: '#/components/responses/ServerError'
        default:
          description: Unexpected error
          $ref: '#/components/responses/ServerError'
    put:
      operationId: UpdateOrganizationLimitsById
      tags:
        - Organizations
        - Operators
      summary: Update the org's limits
      parameters:
        - $ref: '#/components/parameters/TraceSpan'
        - in: path
          name: orgId
          schema:
            type: string
          required: true
          description: The IDPE id of the org
      requestBody:
        description: Updated limits for an organization
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/OperatorOrgLimits'
      responses:
        '200':
          description: Organization Limits
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OperatorOrgLimits'
        '400':
          description: Invalid request
          $ref: '#/components/responses/ServerError'
        '401':
          description: Unauthorized
          $ref: '#/components/responses/ServerError'
        '403':
          description: Cannot update limits for org
          $ref: '#/components/responses/ServerError'
        '404':
          description: Org not found
          $ref: '#/components/responses/ServerError'
        default:
          description: Unexpected error
          $ref: '#/components/responses/ServerError'
  '/operator/orgs/{orgId}/reactivate':
    post:
      operationId: PostReactivateOrgById
      tags:
        - Organization
        - Operators
      summary: Reactivate a suspended organization.
      parameters:
        - $ref: '#/components/parameters/TraceSpan'
        - in: path
          name: orgId
          schema:
            type: string
          required: true
          description: The IDPE id of the organization to reactivate.
      requestBody:
        content:
          application/json; charset=utf-8:
            schema:
              type: object
      responses:
        '200':
          description: Organization successfully reactivated.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Organization'
        '401':
          description: Unauthorized
          $ref: '#/components/responses/ServerError'
        '403':
          description: Forbidden
          $ref: '#/components/responses/ServerError'
        '404':
          description: Not Found
          $ref: '#/components/responses/ServerError'
        default:
          description: Unexpected error
          $ref: '#/components/responses/ServerError'
  '/operator/orgs/{orgId}/migrate/{toAccountId}':
    patch:
      operationId: MigrateOrgById
      tags:
        - Organization
        - Operators
      summary: Migrates an organization to a different account.
      parameters:
        - $ref: '#/components/parameters/TraceSpan'
        - in: path
          name: orgId
          schema:
            type: string
          required: true
          description: The IDPE id of the organization to migrate.
        - in: path
          name: toAccountId
          schema:
            type: string
          required: true
          description: The ID of the account to migrate organization into
      requestBody:
        content:
          application/json; charset=utf-8:
            schema:
              type: object
      responses:
        '200':
          description: Organization successfully migrated.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Organization'
        '401':
          description: Unauthorized
          $ref: '#/components/responses/ServerError'
        '404':
          description: Not Found
          $ref: '#/components/responses/ServerError'
        '422':
          description: Missing or invalid information
          $ref: '#/components/responses/ServerError'
        default:
          description: Unexpected error
          $ref: '#/components/responses/ServerError'
  '/users/{userId}':
    patch:
      operationId: PatchUser
      tags:
        - User
      summary: Patch the profile for the specified user
      requestBody:
        description: User update to apply
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UserPatchRequest'
      parameters:
        - in: path
          name: userId
          schema:
            type: string
          required: true
          description: The ID of the user
      responses:
        '200':
          description: User
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/User'
        '401':
          description: Unauthorized
          $ref: '#/components/responses/ServerError'
        '422':
          description: Missing or invalid information
          $ref: '#/components/responses/ServerError'
        default:
          description: Unexpected error
          $ref: '#/components/responses/ServerError'
  /auth/connection:
    get:
      operationId: GetConnection
      tags:
        - Connection
      parameters:
        - $ref: '#/components/parameters/TraceSpan'
        - in: query
          name: email
          schema:
            type: string
            format: email
          required: true
          description: The email to get connection for.
      responses:
        '200':
          content:
            application/json:
              schema:
                type: string
                example: connection
          description: Connection name as string
        '204':
          description: No connection for the specified email
        default:
          description: Unexpected error
          $ref: '#/components/responses/ServerError'
      summary: Get connection  for the specified email
components:
  parameters:
    TraceSpan:
      in: header
      name: Zap-Trace-Span
      description: OpenTracing span context
      example:
        trace_id: '1'
        span_id: '1'
        baggage:
          key: value
      required: false
      schema:
        type: string
  schemas:
    Error:
      properties:
        code:
          description: code is the machine-readable error code.
          readOnly: true
          type: string
          enum:
            - internal error
            - not implemented
            - not found
            - conflict
            - invalid
            - unprocessable entity
            - empty value
            - unavailable
            - forbidden
            - too many requests
            - unauthorized
            - method not allowed
            - request too large
            - unsupported media type
        message:
          readOnly: true
          description: Human-readable message.
          type: string
        op:
          readOnly: true
          description: Describes the logical code operation when the error occurred. Useful for debugging.
          type: string
        err:
          readOnly: true
          description: Stack of errors that occurred during processing of the request. Useful for debugging.
          type: string
      required:
        - code
    Account:
      properties:
        id:
          type: number
          description: account id in quartz
        name:
          type: string
          description: name of the account
        type:
          type: string
          enum:
            - contract
            - free
            - pay_as_you_go
          description: the type of the account
        billingProvider:
          type: string
          nullable: true
          enum:
            - aws
            - azure
            - gcm
            - zuora
          description: the billing provider of the account. null if a free account
        isDeletable:
          type: boolean
          description: determines if the account can be deleted
      required:
        - id
        - name
    Cluster:
      properties:
        priority:
          description: priority for sorting the cluster
          nullable: false
          readOnly: true
          type: number
        isProviderAvailable:
          description: determines if the provider is available
          nullable: false
          readOnly: true
          type: boolean
        isRegionAvailable:
          description: determines if the region is available
          nullable: false
          readOnly: true
          type: boolean
        providerId:
          description: the id of the cloud provider
          nullable: false
          readOnly: true
          type: string
        providerName:
          description: the descriptive name of the cloud provider
          nullable: false
          readOnly: true
          type: string
        regionId:
          description: the id of the region
          nullable: false
          readOnly: true
          type: string
        regionName:
          description: the descriptive name of the region
          nullable: false
          readOnly: true
          type: string
    Clusters:
      type: array
      items:
        $ref: '#/components/schemas/Cluster'
    UserAccount:
      properties:
        id:
          type: number
          description: account id in quartz
        isActive:
          type: boolean
          description: is this the currently active account in the session?
        isDefault:
          type: boolean
          description: is this the user's default account?
        name:
          type: string
          description: name of the account
      required:
        - id
        - isActive
        - isDefault
        - name
    Marketplace:
      properties:
        name:
          description: full name of the marketplace
          type: string
          example: Google Cloud Marketplace
        shortName:
          description: marketplace acronyms
          $ref: '#/components/schemas/MarketplaceType'
          example: gcm
        url:
          description: link to marketplace
          type: string
      required:
        - name
        - shortName
        - url
    OperatorAccount:
      properties:
        id:
          type: number
          description: account id in quartz
        name:
          type: string
          description: account name
        type:
          $ref: '#/components/schemas/AccountType'
        zuoraAccountId:
          type: string
          description: Zuora ID associated with the account
        cancellable:
          type: boolean
          description: flag whether the account can be canceled or not
        deletable:
          type: boolean
          description: flag whether the account can be deleted or not
        reactivatable:
          type: boolean
          description: flag whether the account can be reactivated or not
        balance:
          type: number
          description: 'remaining balance on the account, nil if none'
        billingContact:
          $ref: '#/components/schemas/BillingContact'
          description: billing contact for the account
        users:
          type: array
          $ref: '#/components/schemas/OperatorUsers'
        marketplaceSubscription:
          $ref: '#/components/schemas/MarketplaceSubscription'
          description: 'which marketplace, nil if none'
        cancelledAt:
          type: string
          description: the date an account was cancelled on
      required:
        - id
        - name
        - account
        - balance
        - billingContact
        - marketplaceSubscription
        - type
        - users
    OperatorAccounts:
      type: array
      items:
        $ref: '#/components/schemas/OperatorAccount'
    OperatorProvider:
      type: object
      properties:
        provider:
          type: string
          description: name of the provider
        title:
          type: string
          description: title of the provider
        isAvailable:
          type: boolean
          description: the availability of the provider
      required:
        - provider
        - title
        - isAvailable
    OperatorProviders:
      type: array
      items:
        $ref: '#/components/schemas/OperatorProvider'
    OperatorProvidersResponse:
      type: object
      properties:
        providers:
          $ref: '#/components/schemas/OperatorProviders'
        regions:
          type: object
          properties:
            Azure:
              $ref: '#/components/schemas/OperatorRegions'
            AWS:
              $ref: '#/components/schemas/OperatorRegions'
            GCM:
              $ref: '#/components/schemas/OperatorRegions'
      required:
        - providers
        - regions
    OperatorOrgLimits:
      type: object
      properties:
        orgID:
          type: string
          readOnly: true
          description: The ID of the organization that these rates apply to.
        rate:
          $ref: '#/components/schemas/OperatorRateLimits'
        bucket:
          $ref: '#/components/schemas/BucketLimits'
        task:
          $ref: '#/components/schemas/TaskLimits'
        dashboard:
          $ref: '#/components/schemas/DashboardLimits'
        check:
          $ref: '#/components/schemas/CheckLimits'
        notificationRule:
          $ref: '#/components/schemas/NotificationRuleLimits'
        notificationEndpoint:
          $ref: '#/components/schemas/NotificationEndpointLimits'
        stack:
          $ref: '#/components/schemas/StackLimits'
        timeout:
          $ref: '#/components/schemas/TimeoutLimits'
        ioxQuery:
          $ref: '#/components/schemas/OrgLimits/properties/ioxQuery'
      required:
        - orgID
        - rate
        - bucket
        - task
        - dashboard
        - check
        - notificationRule
        - notificationEndpoint
    OperatorRateLimits:
      description: Usage rate limits
      type: object
      properties:
        queryTime:
          description: Query Time limit in nanoseconds
          example: 1500000000000
          oneOf:
            - $ref: '#/components/schemas/RestrictedLimit'
            - $ref: '#/components/schemas/Limit'
              maximum: 3000000000000
        readKBs:
          description: KB of data query'd per second
          example: 1000
          oneOf:
            - $ref: '#/components/schemas/RestrictedLimit'
            - $ref: '#/components/schemas/Limit'
              maximum: 10000
        writeKBs:
          description: KB of data written per second
          example: 17
          oneOf:
            - $ref: '#/components/schemas/RestrictedLimit'
            - $ref: '#/components/schemas/Limit'
              maximum: 10000
        cardinality:
          description: Max cardinality of data
          example: 10000
          oneOf:
            - $ref: '#/components/schemas/RestrictedLimit'
            - $ref: '#/components/schemas/Limit'
              maximum: 1000000
    OperatorRegion:
      type: object
      properties:
        region:
          type: string
          description: the name of the region
        title:
          type: string
          description: the title of the region
        provider:
          type: string
          description: the provider the region belong to
        priority:
          type: integer
          description: the order priority of the region
        isAvailable:
          type: boolean
          description: the availability of the provider
        isPrivate:
          type: boolean
          description: determines if the region is a private region
      required:
        - region
        - title
        - provider
        - priority
        - isAvailable
        - isPrivate
    OperatorRegions:
      type: array
      items:
        $ref: '#/components/schemas/OperatorRegion'
    MarketplaceSubscription:
      properties:
        marketplace:
          $ref: '#/components/schemas/MarketplaceType'
        status:
          type: string
          enum:
            - pending
            - subscribed
            - unsubscribed
            - failed
          description: status of the marketplace
        subscriberId:
          type: string
      required:
        - marketplace
        - status
        - subscriberId
    User:
      properties:
        email:
          type: string
          description: user's email
        firstName:
          type: string
          description: user's first name
        id:
          type: string
          description: user's id in idpe
        lastName:
          type: string
          description: user's last name
      required:
        - firstName
        - id
        - idpeId
        - lastName
    UserPatchRequest:
      properties:
        firstName:
          type: string
          description: user's first name
        lastName:
          type: string
          description: user's last name
    Users:
      type: array
      items:
        $ref: '#/components/schemas/User'
    MarketplaceType:
      type: string
      description: marketplace acronym or name
      enum:
        - aws
        - gcm
        - azure
    TimeRange:
      type: string
      description: The timerange options for usage information
      enum:
        - 24h
        - 1d
        - 2d
        - 3d
        - 4d
        - 5d
        - 6d
        - 7d
        - 8d
        - 9d
        - 10d
        - 11d
        - 12d
        - 13d
        - 14d
        - 15d
        - 16d
        - 17d
        - 18d
        - 19d
        - 20d
        - 21d
        - 22d
        - 23d
        - 24d
        - 25d
        - 26d
        - 27d
        - 28d
        - 29d
        - 30d
      default: 24h
    VectorName:
      type: string
      description: The name of the usage vector.
      enum:
        - storage_gb
        - writes_mb
        - reads_gb
        - query_count
    Role:
      type: string
      description: Role of the User
      enum:
        - owner
        - member
    PaymentFormType:
      type: string
      description: The name of the PaymentForm to query.
      example: checkout
      enum:
        - checkout
        - billing
    AccountType:
      type: string
      description: type of the account
      enum:
        - cancelled
        - contract
        - free
        - pay_as_you_go
    BillingInfo:
      properties:
        balance:
          type: number
          description: account balance
        paymentMethod:
          $ref: '#/components/schemas/PaymentMethod'
        balanceUpdatedAt:
          type: string
          description: date of last update to account
        contact:
          $ref: '#/components/schemas/BillingContact'
      required:
        - balance
        - balanceUpdatedAt
        - contact
    Region:
      properties:
        title:
          type: string
          description: title of the region
      required:
        - title
    BillingDate:
      properties:
        dateTime:
          type: string
          description: UTC datetime representing the start of the billing period for the account
      required:
        - dateTime
    BillingContact:
      properties:
        companyName:
          type: string
          description: name of the company billed
        email:
          type: string
          description: billing email
        firstName:
          type: string
          description: first name of billing contact
        lastName:
          type: string
          description: last name of billing contact
        country:
          type: string
          description: country of billing contact
        street1:
          type: string
          description: street of billing contact
        street2:
          type: string
          description: additional street info
        city:
          type: string
          description: city of billing contact
        subdivision:
          type: string
          description: subdivision
        postalCode:
          type: string
          description: postal code of billing contact
      required:
        - companyName
        - email
        - firstName
        - lastName
        - country
        - city
        - postalCode
    BillingNotifySettings:
      properties:
        isNotify:
          description: opt in to threshold notifications
          type: boolean
        balanceThreshold:
          type: number
          description: threshold that when passed will trigger a notification
        notifyEmail:
          type: string
          description: email to send notification
      required:
        - isNotify
        - balanceThreshold
        - notifyEmail
    CheckoutRequest:
      properties:
        paymentMethodId:
          type: string
          description: id from submitting the zuora form
        street1:
          description: for billing address
          type: string
        street2:
          description: for billing address
          type: string
        city:
          description: for billing address
          type: string
        country:
          description: for billing address
          type: string
        subdivision:
          description: for billing address (state in US)
          type: string
        postalCode:
          description: for billing address
          type: string
        notifyEmail:
          description: the email for the notification
          type: string
        balanceThreshold:
          description: threshold for notification
          type: number
        isNotify:
          description: whether the user will be notified about their balance
          type: boolean
        isPaygCreditActive:
          description: whether the user is a part of the payg credit
          type: boolean
    Identity:
      properties:
        user:
          $ref: '#/components/schemas/IdentityUser'
        account:
          $ref: '#/components/schemas/IdentityAccount'
        org:
          $ref: '#/components/schemas/IdentityOrganization'
      required:
        - user
        - account
        - org
    IdentityUser:
      properties:
        id:
          type: string
          description: user's id in idpe
        email:
          type: string
          description: user's email
        firstName:
          type: string
          nullable: true
          description: user's first name
        lastName:
          type: string
          nullable: true
          description: user's last name
        operatorRole:
          type: string
          nullable: true
          enum:
            - read-only
            - read-write
          description: role permission whether this operator is "read-only" | "read-write"
        accountCount:
          type: integer
          description: number of accounts the user belongs to
        orgCount:
          type: integer
          description: number of orgs the user belongs to within their active account
      required:
        - id
        - email
        - accountCount
        - orgCount
    IdentityAccount:
      properties:
        id:
          type: number
          description: account id in quartz
        name:
          type: string
          description: name of the account
        type:
          $ref: '#/components/schemas/AccountType'
        accountCreatedAt:
          type: string
          description: an ISO8601 timestamp that indicates when the account was created
        availableUpgrade:
          description: the next available upgrade for the account
          type: string
          enum:
            - contract
            - none
            - pay_as_you_go
        isUpgradeable:
          type: boolean
          description: whether or not the account can be upgraded to payg
        paygCreditStartDate:
          type: string
          nullable: true
          description: 'an ISO8601 timestamp indicating if an account is part of the payg credit experiment, nil if not'
      required:
        - id
        - accountCreatedAt
        - name
        - type
    IdentityOrganization:
      properties:
        id:
          type: string
          description: idpe ID of the org
        name:
          type: string
          description: name of the org
        clusterHost:
          type: string
          description: the url of the current cluster
      required:
        - id
        - name
        - clusterHost
    Invite:
      properties:
        id:
          description: the quartz id of the invite
          readOnly: true
          type: number
        email:
          type: string
        role:
          $ref: '#/components/schemas/Role'
        expiresAt:
          description: when the invite will expire
          readOnly: true
          format: date-time
          type: string
      required:
        - email
        - role
    Invites:
      type: array
      items:
        $ref: '#/components/schemas/Invite'
    PaymentMethodPut:
      properties:
        paymentMethodId:
          type: string
          description: ref id from Zuora
          readOnly: true
    CreditCardParams:
      properties:
        id:
          description: id of the page displayed
          readOnly: true
          type: string
        tenantId:
          description: id of our account with the payment processor
          type: string
          readOnly: true
        key:
          description: payment processor secret key
          readOnly: true
          type: string
        signature:
          description: signature of the key or token
          readOnly: true
          type: string
        token:
          description: api token of the payment processor
          readOnly: true
          type: string
        style:
          description: way payment form gets displayed
          type: string
          readOnly: true
        submitEnabled:
          description: boolean string 'true' or 'false' which allows us to handle submits from our form
          type: string
          enum:
            - 'true'
            - 'false'
          readOnly: true
        url:
          type: string
          readOnly: true
          description: uri of the embedded iframe
      required:
        - id
        - tenantId
        - key
        - signature
        - token
        - style
        - submitEnabled
        - url
    PaymentMethod:
      properties:
        cardType:
          description: name of credit card vendor
          type: string
        cardNumber:
          description: masked credit card number
          type: string
        expirationMonth:
          description: month of expiration
          type: string
        expirationYear:
          description: year of expiration
          type: string
        defaultPaymentMethod:
          description: this the default payment method
          type: boolean
      required:
        - cardType
        - cardNumber
        - expirationMonth
        - expirationYear
    UsageVectors:
      type: array
      items:
        $ref: '#/components/schemas/UsageVector'
    UsageVector:
      properties:
        name:
          description: name of usage vector
          type: string
          example: storage
        unit:
          description: unit for usage vector
          type: string
          example: GB-hr
        fluxKey:
          description: key in flux response
          type: string
          example: storage_gb
      required:
        - name
        - unit
        - fluxKey
    Invoice:
      properties:
        id:
          description: id of the invoice
          type: string
        status:
          description: status of the invoice
          readOnly: true
          type: string
        amount:
          description: amount of invoice in dollars
          type: number
          readOnly: true
        targetDate:
          description: date of invoice
          readOnly: true
          type: string
      required:
        - id
        - status
        - amount
        - targetDate
    Invoices:
      type: array
      items:
        $ref: '#/components/schemas/Invoice'
    OrgUser:
      properties:
        id:
          description: the idpe id of the user
          readOnly: true
          type: string
        firstName:
          type: string
        lastName:
          type: string
        email:
          type: string
        role:
          $ref: '#/components/schemas/Role'
      required:
        - id
        - firstName
        - lastName
        - email
        - role
    OrgUsers:
      type: array
      items:
        $ref: '#/components/schemas/OrgUser'
    OperatorOrganization:
      type: object
      properties:
        idpeId:
          type: string
          description: idpe ID of the org
        id:
          type: number
          description: quartz ID of the org
        name:
          type: string
          description: name of the org
        region:
          type: string
          description: region of the org
        provider:
          type: string
          description: provider of the org
        state:
          $ref: '#/components/schemas/Organization/properties/state'
          description: the state of existence that the org is in
        storageType:
          description: the storage type of the organization
          type: string
          enum:
            - tsm
            - iox
        deleteOn:
          type: string
          description: the date a suspended org will be deleted on
        date:
          type: string
          description: date org was created
        account:
          $ref: '#/components/schemas/RelatedAccount'
      required:
        - account
        - id
        - idpeId
        - region
        - provider
        - date
    OperatorOrganizations:
      type: array
      items:
        $ref: '#/components/schemas/OperatorOrganization'
    OperatorUser:
      properties:
        email:
          type: string
          description: user's email
        firstName:
          type: string
          description: user's first name
        id:
          type: string
          description: user's id in quartz
        idpeId:
          type: string
          description: user's id in idpe
        lastName:
          type: string
          description: user's last name
        operator:
          type: boolean
          description: whether or not the user is an operator
        sfdcContactId:
          type: string
          description: the contact id of the user in salesforce
      required:
        - firstName
        - id
        - idpeId
        - lastName
    OperatorUsers:
      type: array
      items:
        $ref: '#/components/schemas/OperatorUser'
    RelatedAccount:
      description: Subset of Account data related to the organization
      type: object
      properties:
        id:
          type: number
          description: account id in quartz
        type:
          $ref: '#/components/schemas/AccountType'
        balance:
          type: number
          description: 'remaining balance on the account, nil if none'
        billingContact:
          $ref: '#/components/schemas/BillingContact'
          description: billing contact for the account
        updatedAt:
          type: string
          description: date of last update to account
      required:
        - id
        - balance
        - type
        - updatedAt
    Organization:
      type: object
      properties:
        id:
          type: string
          description: IDPE Id of the org
        name:
          type: string
          description: name of the org
        description:
          type: string
          description: the description of the organization
        creationDate:
          type: string
          format: date-time
          description: the date the organization was created
        regionCode:
          type: string
          description: the canonical code for the region where the organization is hosted
        regionName:
          type: string
          description: the name of the region where the organization is hosted
        provider:
          type: string
          description: provider of the org
        clusterHost:
          type: string
          description: URL of the current cluster
        state:
          description: Current state of the organization
          type: string
          enum:
            - pending
            - provisioned
            - suspended
        isSuspendable:
          type: boolean
          description: determines if the org can be suspended
      required:
        - id
        - clusterHost
        - regionCode
        - regionName
    OrganizationWithToken:
      allOf:
        - $ref: '#/components/schemas/Organization'
        - type: object
          properties:
            token:
              description: Authentication token to manage the organization and its resources in IDPE
              readOnly: true
              type: string
            links:
              description: Links to the IDPE resources for this organization
              readOnly: true
              type: object
              example:
                resource: path/to/resource
    OrganizationSummaries:
      type: array
      items:
        type: object
        properties:
          id:
            type: string
            description: IDPE ID of the org
          name:
            type: string
            description: name of the org
          isActive:
            type: boolean
            description: is this the currently active organization in the session?
          isDefault:
            type: boolean
            description: is this the user's default organization in this account?
          provider:
            type: string
            description: provider of the org
          regionCode:
            type: string
            description: the canonical code for the region where the organization is hosted
          regionName:
            type: string
            description: the friendly name of the region where the organization is hosted
          state:
            $ref: '#/components/schemas/Organization/properties/state'
            description: Current state of the organization
          isSuspendable:
            type: boolean
            description: determines if the org can be suspended
        required:
          - id
          - name
          - isActive
          - isDefault
    OrganizationCreateRequest:
      type: object
      properties:
        orgName:
          description: name of the organization
          type: string
        provider:
          description: name of the cloud provider
          type: string
          enum:
            - AWS
            - GCP
            - Azure
        region:
          description: name of the region within the cloud provider
          type: string
      required:
        - orgName
        - provider
        - region
    OrganizationDefaultRequest:
      properties:
        id:
          type: string
          description: IDPE id of the organization
      required:
        - id
    OrgLimits:
      type: object
      properties:
        orgID:
          type: string
          readOnly: true
          description: The ID of the organization that the rates apply to.
        rate:
          $ref: '#/components/schemas/RateLimits'
        bucket:
          $ref: '#/components/schemas/BucketLimits'
        task:
          $ref: '#/components/schemas/TaskLimits'
        dashboard:
          $ref: '#/components/schemas/DashboardLimits'
        check:
          $ref: '#/components/schemas/CheckLimits'
        notificationRule:
          $ref: '#/components/schemas/NotificationRuleLimits'
        notificationEndpoint:
          $ref: '#/components/schemas/NotificationEndpointLimits'
        stack:
          $ref: '#/components/schemas/StackLimits'
        timeout:
          $ref: '#/components/schemas/TimeoutLimits'
        ioxQuery:
          description: IOx query limits
          type: object
          properties:
            partitions:
              description: Number of partitions allowed in a single query.
              $ref: '#/components/schemas/Limit'
            parquetFiles:
              description: Number of parquet files allowed in a single query.
              $ref: '#/components/schemas/Limit'
      required:
        - orgID
        - rate
        - bucket
        - task
        - dashboard
        - check
        - notificationRule
        - notificationEndpoint
    RateLimits:
      description: Usage rate limits
      type: object
      properties:
        readKBs:
          description: KB of data query'd per second
          example: 1000
          oneOf:
            - $ref: '#/components/schemas/RestrictedLimit'
            - $ref: '#/components/schemas/Limit'
              maximum: 10000
        writeKBs:
          description: KB of data written per second
          example: 17
          oneOf:
            - $ref: '#/components/schemas/RestrictedLimit'
            - $ref: '#/components/schemas/Limit'
              maximum: 10000
        cardinality:
          description: Max cardinality of data
          example: 10000
          oneOf:
            - $ref: '#/components/schemas/RestrictedLimit'
            - $ref: '#/components/schemas/Limit'
              maximum: 1000000
    Limit:
      description: Limit of at least 1
      type: integer
      minimum: 1
    BucketLimits:
      description: Bucket limits
      type: object
      properties:
        maxBuckets:
          example: 2
          description: Number of buckets allowed
          oneOf:
            - $ref: '#/components/schemas/RestrictedLimit'
            - $ref: '#/components/schemas/Unlimited'
            - $ref: '#/components/schemas/Limit'
        maxRetentionDuration:
          description: Retention duration limits in nanoseconds
          example: 2592000000000000
          oneOf:
            - $ref: '#/components/schemas/RestrictedLimit'
            - $ref: '#/components/schemas/Unlimited'
            - $ref: '#/components/schemas/Limit'
    TaskLimits:
      description: Task limits
      type: object
      properties:
        maxTasks:
          description: Number of tasks allowed
          example: 5
          oneOf:
            - $ref: '#/components/schemas/RestrictedLimit'
            - $ref: '#/components/schemas/Unlimited'
            - $ref: '#/components/schemas/Limit'
    DashboardLimits:
      description: Dashboard limits
      type: object
      properties:
        maxDashboards:
          description: Number of dashboards allowed
          example: 5
          oneOf:
            - $ref: '#/components/schemas/RestrictedLimit'
            - $ref: '#/components/schemas/Unlimited'
            - $ref: '#/components/schemas/Limit'
    CheckLimits:
      description: Check limits
      type: object
      properties:
        maxChecks:
          description: Number of checks allowed
          example: 2
          oneOf:
            - $ref: '#/components/schemas/RestrictedLimit'
            - $ref: '#/components/schemas/Unlimited'
            - $ref: '#/components/schemas/Limit'
    NotificationRuleLimits:
      description: Notification rule limits
      type: object
      properties:
        maxNotifications:
          description: Number of notifications allowed
          example: 2
          oneOf:
            - $ref: '#/components/schemas/RestrictedLimit'
            - $ref: '#/components/schemas/Unlimited'
            - $ref: '#/components/schemas/Limit'
        blockedNotificationRules:
          description: Notification rules not allowed CSV
          example: 'http,pagerduty'
          type: string
    NotificationEndpointLimits:
      description: Notification endpoint limits
      type: object
      properties:
        blockedNotificationEndpoints:
          description: Notification endpoints not allowed CSV
          example: 'http,pagerduty'
          type: string
    StackLimits:
      description: Stack limits
      type: object
      properties:
        enabled:
          example: true
          type: boolean
    TimeoutLimits:
      description: Timeout limits
      type: object
      properties:
        queryUnconditionalTimeoutSeconds:
          example: 10
          oneOf:
            - $ref: '#/components/schemas/RestrictedLimit'
            - $ref: '#/components/schemas/Unlimited'
            - $ref: '#/components/schemas/Limit'
        queryidleWriteTimeoutSeconds:
          example: 10
          oneOf:
            - $ref: '#/components/schemas/RestrictedLimit'
            - $ref: '#/components/schemas/Unlimited'
            - $ref: '#/components/schemas/Limit'
    RestrictedLimit:
      description: Restrict access entirely
      type: integer
      enum:
        - -1
    Unlimited:
      description: Unbounded limit
      type: integer
      enum:
        - 0
  responses:
    ServerError:
      description: Non 2XX error response from server.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'