Alphaus GuaranteedCommitments API

swagger: '2.0'
info:
  title: Blue API reference Admin GuaranteedCommitments API
  description: 'Alphaus provides an API for interacting with its services. Blue API is a RESTful API that can be accessed by an HTTP client such as `curl`, or any HTTP library which is part of most modern programming languages. This API reference is autogenerated from [protocol buffers](https://developers.google.com/protocol-buffers) defined in this [repository](https://github.com/alphauslabs/blueapi), together with our supported [client libraries](https://alphauslabs.github.io/docs/blueapi/client-sdks/). See the official [documentation](https://alphauslabs.github.io/docs/blueapi/overview/) for more information.


    You may encounter the following feature maturity indicators:

    - **(WORK-IN-PROGRESS)** - Development is ongoing, don''t use yet;

    - **(BETA)** - New or experimental features, subject to changes; and

    - **(DEPRECATED)** - Outdated or replaced features.


    Some endpoints, especially those that return lists of resources, have streaming responses; newline-separated stream of “chunks”. Each chunk is an envelope that can contain either a response message or an error. Only the last chunk will include an error, if any.'
  version: v1
host: api.alphaus.cloud
basePath: /m/blue
schemes:
- https
consumes:
- application/json
produces:
- application/json
tags:
- name: GuaranteedCommitments
  description: '(Alpha) GuaranteedCommitments API. Base URL: https://api.alphaus.cloud/m/blue/gc'
  externalDocs:
    description: Service definition
    url: https://github.com/alphauslabs/blueapi/tree/main/gc/
paths:
  /v1/commitments:
    get:
      summary: 'WORK-IN-PROGRESS: Retrieves a list of commitments.'
      operationId: GuaranteedCommitments_ListCommitments
      responses:
        '200':
          description: A successful response.
          schema:
            $ref: '#/definitions/v1ListCommitmentsResponse'
        default:
          description: An unexpected error response.
          schema:
            $ref: '#/definitions/rpcStatus'
      tags:
      - GuaranteedCommitments
  /v1/commitments/plan/{planId}/apply:
    post:
      summary: 'WORK-IN-PROGRESS: Executes a commitment purchase plan, initiating the commitment purchase process.'
      operationId: GuaranteedCommitments_CommitmentsPlanApply
      responses:
        '200':
          description: A successful response.
          schema:
            $ref: '#/definitions/v1CommitmentPlanDetails'
        default:
          description: An unexpected error response.
          schema:
            $ref: '#/definitions/rpcStatus'
      parameters:
      - name: planId
        in: path
        required: true
        type: string
      - name: body
        in: body
        required: true
        schema:
          $ref: '#/definitions/GuaranteedCommitmentsCommitmentsPlanApplyBody'
      tags:
      - GuaranteedCommitments
  /v1/commitments/purchaseplans:
    get:
      summary: 'WORK-IN-PROGRESS: Retrieves purchase plan of a company.'
      operationId: GuaranteedCommitments_ListPurchasePlansBySegment
      responses:
        '200':
          description: A successful response.
          schema:
            $ref: '#/definitions/v1ListPurchasePlansBySegmentResponse'
        default:
          description: An unexpected error response.
          schema:
            $ref: '#/definitions/rpcStatus'
      tags:
      - GuaranteedCommitments
  /v1/commitments/purchaseplans/availabletypes:
    get:
      summary: 'WORK-IN-PROGRESS: Only works for Alphaus for now. Retrieves the available commitment types for a given provider.'
      operationId: GuaranteedCommitments_GetAvailableCommitmentTypes
      responses:
        '200':
          description: A successful response.
          schema:
            $ref: '#/definitions/v1GetAvailableCommitmentTypesResponse'
        default:
          description: An unexpected error response.
          schema:
            $ref: '#/definitions/rpcStatus'
      parameters:
      - name: provider
        description: 'Required. The cloud provider to query available types for.

          Acceptable values: "aws", "azure", "gcp".'
        in: query
        required: false
        type: string
      tags:
      - GuaranteedCommitments
  /v1/commitments/purchaseplans/custom:
    post:
      summary: 'WORK-IN-PROGRESS: Only works for Alphaus for now. Creates a custom (top-down) commitment purchase plan.'
      operationId: GuaranteedCommitments_CreateCustomCommitmentPlan
      responses:
        '200':
          description: A successful response.
          schema:
            $ref: '#/definitions/v1CreateCustomCommitmentPlanResponse'
        default:
          description: An unexpected error response.
          schema:
            $ref: '#/definitions/rpcStatus'
      parameters:
      - name: body
        description: CreateCustomCommitmentPlanRequest creates a new top-down custom commitment plan.
        in: body
        required: true
        schema:
          $ref: '#/definitions/v1CreateCustomCommitmentPlanRequest'
      tags:
      - GuaranteedCommitments
  /v1/commitments/purchaseplans/draft:
    get:
      summary: 'WORK-IN-PROGRESS: Retrieves the drafted purchase plans'
      operationId: GuaranteedCommitments_ListDraftPurchasePlans
      responses:
        '200':
          description: A successful response.
          schema:
            $ref: '#/definitions/v1ListDraftPurchasePlansResponse'
        default:
          description: An unexpected error response.
          schema:
            $ref: '#/definitions/rpcStatus'
      parameters:
      - name: isDraft
        description: If set to true, returns plans with Draft status. If set to false, returns plans with Submitted and Executed status.
        in: query
        required: false
        type: boolean
      - name: companyId
        in: query
        required: false
        type: string
      tags:
      - GuaranteedCommitments
  /v1/commitments/purchaseplans/draft/{draftPlanId}:
    delete:
      summary: 'WORK-IN-PROGRESS: Deletes a drafted purchase plan.'
      operationId: GuaranteedCommitments_DeleteDraftPurchasePlan
      responses:
        '200':
          description: A successful response.
          schema:
            $ref: '#/definitions/v1DeleteDraftPurchasePlanResponse'
        default:
          description: An unexpected error response.
          schema:
            $ref: '#/definitions/rpcStatus'
      parameters:
      - name: draftPlanId
        description: Required. The draft plan ID to delete.
        in: path
        required: true
        type: string
      - name: companyId
        in: query
        required: false
        type: string
      tags:
      - GuaranteedCommitments
  /v1/commitments/purchaseplans/draft/{planId}:
    post:
      summary: 'WORK-IN-PROGRESS: Saves a commitment purchase plan as draft.'
      operationId: GuaranteedCommitments_SaveCommitmentsPlanAsDraft
      responses:
        '200':
          description: A successful response.
          schema:
            $ref: '#/definitions/v1DefaultPurchasePlan'
        default:
          description: An unexpected error response.
          schema:
            $ref: '#/definitions/rpcStatus'
      parameters:
      - name: planId
        description: Required. The commitment purchase plan ID to save as draft.
        in: path
        required: true
        type: string
      - name: body
        in: body
        required: true
        schema:
          $ref: '#/definitions/GuaranteedCommitmentsSaveCommitmentsPlanAsDraftBody'
      tags:
      - GuaranteedCommitments
  /v1/commitments/purchaseplans/{planId}:
    get:
      summary: 'WORK-IN-PROGRESS: Retrieves full details of a specific purchase plan of a company.

        Includes the basic info, detailed metrics, commitment line items, covered infrastructure resource matches, and audit history.'
      operationId: GuaranteedCommitments_GetPurchasePlansDetails
      responses:
        '200':
          description: A successful response.
          schema:
            $ref: '#/definitions/v1GetPurchasePlansDetailsResponse'
        default:
          description: An unexpected error response.
          schema:
            $ref: '#/definitions/rpcStatus'
      parameters:
      - name: planId
        in: path
        required: true
        type: string
      tags:
      - GuaranteedCommitments
  /v1/commitments/purchaseplans:update:
    post:
      summary: 'WORK-IN-PROGRESS: Get the updated details of the plan after the apply plan.'
      operationId: GuaranteedCommitments_GetUpdatedPurchasePlansBySegment
      responses:
        '200':
          description: A successful response.
          schema:
            $ref: '#/definitions/v1GetUpdatedPurchasePlansBySegmentResponse'
        default:
          description: An unexpected error response.
          schema:
            $ref: '#/definitions/rpcStatus'
      parameters:
      - name: body
        in: body
        required: true
        schema:
          $ref: '#/definitions/v1GetUpdatedPurchasePlansBySegmentRequest'
      tags:
      - GuaranteedCommitments
  /v1/commitments/resources:
    get:
      summary: 'WORK-IN-PROGRESS: Only works for Alphaus for now. Retrieves a paginated list of reservable infrastructure resources for a segment.

        Supports filtering, sorting, and a date range for usage aggregation.'
      operationId: GuaranteedCommitments_ListReservableResources
      responses:
        '200':
          description: A successful response.
          schema:
            $ref: '#/definitions/v1ListReservableResourcesResponse'
        default:
          description: An unexpected error response.
          schema:
            $ref: '#/definitions/rpcStatus'
      parameters:
      - name: companyId
        description: "Required. The company ID to scope the query to.\n\n// Optional. Field to sort by. Example: \"ondemand_cost\".\n string orderBy = 2;\n // Optional. If true, sort in descending order.\n bool desc = 3;\n // Optional. URL-encoded JSON filter expression.\n // Example (decoded): {\"and\":[{\"and\":[{\"field\":\"covered_usage\",\"op\":\"<\",\"value\":1}]},{\"and\":[{\"field\":\"is_reservable\",\"op\":\"=\",\"value\":\"true\"}]}]}\n string filter = 4;\n // Required. Start of the usage lookback window (YYYY-MM-DD).\n string startDate = 5;\n // Required. End of the usage lookback window (YYYY-MM-DD).\n string endDate = 6;\n // Optional. Page number (1-based).\n int32 page = 7;\n // Optional. Number of results per page.\n int32 pageSize = 8;"
        in: query
        required: false
        type: string
      tags:
      - GuaranteedCommitments
  /v1/commitments/{commitmentId}/chart:
    get:
      summary: 'WORK-IN-PROGRESS: Generates time-series chart data for commitment metrics over the specified time period.'
      operationId: GuaranteedCommitments_GetCommitmentsChart
      responses:
        '200':
          description: A successful response.
          schema:
            $ref: '#/definitions/v1CommitmentsChartResponse'
        default:
          description: An unexpected error response.
          schema:
            $ref: '#/definitions/rpcStatus'
      parameters:
      - name: commitmentId
        description: Required. The commitment id.
        in: path
        required: true
        type: string
      - name: groupBy
        description: Required. The group filter. Available filters include `region`, `service`, `instanceType`, `instanceTypeFamily`, `usageType` and `operation`.
        in: query
        required: false
        type: string
      - name: startDate
        in: query
        required: false
        type: string
      - name: endDate
        in: query
        required: false
        type: string
      tags:
      - GuaranteedCommitments
  /v1/commitments/{commitmentId}/utilization:
    get:
      summary: 'WORK-IN-PROGRESS: Generates utilization data for commitment over the active period.'
      operationId: GuaranteedCommitments_GetCommitmentsUtilization
      responses:
        '200':
          description: A successful response.
          schema:
            $ref: '#/definitions/v1CommitmentsUtilizationResponse'
        default:
          description: An unexpected error response.
          schema:
            $ref: '#/definitions/rpcStatus'
      parameters:
      - name: commitmentId
        description: Required. The commitment id.
        in: path
        required: true
        type: string
      tags:
      - GuaranteedCommitments
  /v1/managements/accounts:
    get:
      summary: 'WORK-IN-PROGRESS: Lists payer accounts associated with the organization.

        Retrieves all payer accounts linked to the organization, including their status and associated segments.'
      operationId: GuaranteedCommitments_ListPayerAccounts
      responses:
        '200':
          description: A successful response.
          schema:
            $ref: '#/definitions/v1ListPayerAccountsResponse'
        default:
          description: An unexpected error response.
          schema:
            $ref: '#/definitions/rpcStatus'
      tags:
      - GuaranteedCommitments
  /v1/managements/accounts/status:
    get:
      operationId: GuaranteedCommitments_GetPayerAccountStatus
      responses:
        '200':
          description: A successful response.
          schema:
            $ref: '#/definitions/v1GetPayerAccountStatusResponse'
        default:
          description: An unexpected error response.
          schema:
            $ref: '#/definitions/rpcStatus'
      tags:
      - GuaranteedCommitments
  /v1/managements/accounts/{companyId}:
    post:
      operationId: GuaranteedCommitments_SetPayerAccountEnabled
      responses:
        '200':
          description: A successful response.
          schema:
            $ref: '#/definitions/v1SetPayerAccountEnabledResponse'
        default:
          description: An unexpected error response.
          schema:
            $ref: '#/definitions/rpcStatus'
      parameters:
      - name: companyId
        in: path
        required: true
        type: string
      - name: body
        in: body
        required: true
        schema:
          $ref: '#/definitions/GuaranteedCommitmentsSetPayerAccountEnabledBody'
      tags:
      - GuaranteedCommitments
  /v1/managements/billinggroups:
    get:
      operationId: GuaranteedCommitments_ListBillingGroups
      responses:
        '200':
          description: A successful response.
          schema:
            $ref: '#/definitions/v1ListBillingGroupsResponse'
        default:
          description: An unexpected error response.
          schema:
            $ref: '#/definitions/rpcStatus'
      tags:
      - GuaranteedCommitments
  /v1/managements/billinggroups/status:
    get:
      operationId: GuaranteedCommitments_GetBillingGroupStatus
      responses:
        '200':
          description: A successful response.
          schema:
            $ref: '#/definitions/v1GetBillingGroupStatusResponse'
        default:
          description: An unexpected error response.
          schema:
            $ref: '#/definitions/rpcStatus'
      tags:
      - GuaranteedCommitments
  /v1/managements/billinggroups/terms:accept:
    post:
      operationId: GuaranteedCommitments_AcceptBillingGroupTerms
      responses:
        '200':
          description: A successful response.
          schema:
            $ref: '#/definitions/v1AcceptBillingGroupTermsResponse'
        default:
          description: An unexpected error response.
          schema:
            $ref: '#/definitions/rpcStatus'
      parameters:
      - name: body
        in: body
        required: true
        schema:
          $ref: '#/definitions/v1AcceptBillingGroupTermsRequest'
      tags:
      - GuaranteedCommitments
  /v1/managements/billinggroups/{companyId}:
    post:
      operationId: GuaranteedCommitments_SetBillingGroupStatus
      responses:
        '200':
          description: A successful response.
          schema:
            $ref: '#/definitions/v1SetBillingGroupStatusResponse'
        default:
          description: An unexpected error response.
          schema:
            $ref: '#/definitions/rpcStatus'
      parameters:
      - name: companyId
        in: path
        required: true
        type: string
      - name: body
        in: body
        required: true
        schema:
          $ref: '#/definitions/GuaranteedCommitmentsSetBillingGroupStatusBody'
      tags:
      - GuaranteedCommitments
  /v1/metrics:
    get:
      summary: 'WORK-IN-PROGRESS: Do not use. Retrieves key performance metrics for cloud commitments.'
      operationId: GuaranteedCommitments_GetMetrics
      responses:
        '200':
          description: A successful response.
          schema:
            $ref: '#/definitions/v1MetricsResponse'
        default:
          description: An unexpected error response.
          schema:
            $ref: '#/definitions/rpcStatus'
      parameters:
      - name: provider
        in: query
        required: false
        type: string
        enum:
        - PROVIDER_UNSPECIFIED
        - AWS
        - AZURE
        - GCP
        - KUBERNETES
        - UNKNOWN
        default: PROVIDER_UNSPECIFIED
      tags:
      - GuaranteedCommitments
  /v1/onboarding:
    post:
      summary: 'WORK-IN-PROGRESS: Registers a new child organization under the channel partner.

        Creates the organization, sets up user memberships, and establishes the partnership relationship.'
      operationId: GuaranteedCommitments_RegisterOrg
      responses:
        '200':
          description: A successful response.
          schema:
            $ref: '#/definitions/v1RegisterOrgResponse'
        default:
          description: An unexpected error response.
          schema:
            $ref: '#/definitions/rpcStatus'
      parameters:
      - name: body
        in: body
        required: true
        schema:
          $ref: '#/definitions/v1RegisterOrgRequest'
      tags:
      - GuaranteedCommitments
  /v1/onboarding/aws/cftemplate/guaranteed:
    post:
      summary: CreateGuaranteedCommitmentAccess verifies and registers a deployed guaranteed CloudFormation stack.
      operationId: GuaranteedCommitments_CreateGuaranteedCommitmentAccess
      responses:
        '200':
          description: A successful response.
          schema:
            $ref: '#/definitions/v1CreateGuaranteedCommitmentAccessResponse'
        default:
          description: An unexpected error response.
          schema:
            $ref: '#/definitions/rpcStatus'
      parameters:
      - name: body
        in: body
        required: true
        schema:
          $ref: '#/definitions/v1CreateGuaranteedCommitmentAccessRequest'
      tags:
      - GuaranteedCommitments
  /v1/onboarding/aws/cftemplate/guaranteed:url:
    get:
      summary: 'GetGuaranteedCommitmentTemplateUrl returns a CloudFormation launch URL for deploying

        both Alphaus (Ripple) and Archera IAM roles in a single stack.'
      operationId: GuaranteedCommitments_GetGuaranteedCommitmentTemplateUrl
      responses:
        '200':
          description: A successful response.
          schema:
            $ref: '#/definitions/v1GetGuaranteedCommitmentTemplateUrlResponse'
        default:
          description: An unexpected error response.
          schema:
            $ref: '#/definitions/rpcStatus'
      parameters:
      - name: externalId
        description: The guaranteed-commitments-provided external ID for the guaranteed-commitments IAM role trust policy.
        in: query
        required: false
        type: string
      tags:
      - GuaranteedCommitments
  /v1/onboarding/aws/cloudformation/launchstackurl:
    get:
      summary: 'WORK-IN-PROGRESS: Generates AWS CloudFormation launch stack URL.

        Creates a pre-configured URL to deploy the CloudFormation stack in the AWS console.'
      operationId: GuaranteedCommitments_GetAwsLaunchStackUrl
      responses:
        '200':
          description: A successful response.
          schema:
            $ref: '#/definitions/v1GetAwsLaunchStackUrlResponse'
        default:
          description: An unexpected error response.
          schema:
            $ref: '#/definitions/rpcStatus'
      parameters:
      - name: billingGroupId
        description: 'Optional: if present => MSP customer (3rd layer), else MSP-level org (2nd layer)'
        in: query
        required: false
        type: string
      - name: companyId
        in: query
        required: false
        type: string
      - name: gcOrgId
        in: query
        required: false
        type: string
      - name: payerAccountId
        in: query
        required: false
        type: string
      - name: payerAccountName
        in: query
        required: false
        type: string
      tags:
      - GuaranteedCommitments
  /v1/onboarding/aws/cloudformation/template:
    get:
      summary: 'WORK-IN-PROGRESS: Generates CloudFormation template for AWS integration.

        Creates the necessary IAM role and policy template for setting up AWS access.'
      operationId: GuaranteedCommitments_GetAwsCloudFormationTemplate
      responses:
        '200':
          description: A successful response.
          schema:
            $ref: '#/definitions/v1GetAwsCloudFormationTemplateResponse'
        default:
          description: An unexpected error response.
          schema:
            $ref: '#/definitions/rpcStatus'
      parameters:
      - name: billingGroupId
        description: 'Optional: if present => MSP customer (3rd layer), else MSP-level org (2nd layer)'
        in: query
        required: false
        type: string
      - name: companyId
        in: query
        required: false
        type: string
      - name: gcOrgId
        in: query
        required: false
        type: string
      - name: payerAccountId
        in: query
        required: false
        type: string
      - name: payerAccountName
        in: query
        required: false
        type: string
      tags:
      - GuaranteedCommitments
  /v1/onboarding/aws/privateoffer/{payerAccountId}:
    get:
      summary: 'Retrieves the AWS Marketplace private offer details for a payer account.

        Used by the onboarding "Accept Private Offer" step.'
      operationId: GuaranteedCommitments_GetAwsPrivateOffer
      responses:
        '200':
          description: A successful response.
          schema:
            $ref: '#/definitions/v1GetAwsPrivateOfferResponse'
        default:
          description: An unexpected error response.
          schema:
            $ref: '#/definitions/rpcStatus'
      parameters:
      - name: payerAccountId
        description: Required. The AWS payer account ID that the private offer targets.
        in: path
        required: true
        type: string
      - name: recreate
        description: 'Optional. If true, recreate the private offer when the existing row is

          in a retryable terminal state: FAILED, EXPIRED, or WITHDRAWN.

          ACCEPTED, PENDING, and CREATING are not recreated.'
        in: query
        required: false
        type: boolean
      tags:
      - GuaranteedCommitments
  /v1/onboarding/aws/start:
    post:
      summary: 'WORK-IN-PROGRESS: Starts the onboarding process for an organization.

        Creates or retrieves an onboarding record and sets the provider to AWS.'
      operationId: GuaranteedCommitments_StartAwsOnboarding
      responses:
        '200':
          description: A successful response.
          schema:
            $ref: '#/definitions/v1StartAwsOnboardingResponse'
        default:
          description: An unexpected error response.
          schema:
            $ref: '#/definitions/rpcStatus'
      parameters:
      - name: body
        in: body
        required: true
        schema:
          $ref: '#/definitions/v1StartAwsOnboardingRequest'
      tags:
      - GuaranteedCommitments
  /v1/onboarding/aws/verify:
    post:
      summary: 'WORK-IN-PROGRESS: Runs AWS onboarding verification process.

        Creates a new CUR or uses an existing CUR and verifies AWS integration setup

        and returns validation status for all required features.'
      operationId: GuaranteedCommitments_VerifyAwsOnboarding
      responses:
        '200':
          description: A successful response.
          schema:
            $ref: '#/definitions/v1VerifyAwsOnboardingResponse'
        default:
          description: An unexpected error response.
          schema:
            $ref: '#/definitions/rpcStatus'
      parameters:
      - name: body
        in: body
        required: true
        schema:
          $ref: '#/definitions/v1VerifyAwsOnboardingRequest'
      tags:
      - GuaranteedCommitments
  /v1/onboarding/azure/integration:
    post:
      summary: 'WORK-IN-PROGRESS: Creates the Azure cloud integration after all onboarding steps complete.'
      operationId: GuaranteedCommitments_CreateAzureIntegration
      responses:
        '200':
          description: A successful response.
          schema:
            $ref: '#/definitions/v1CreateAzureIntegrationResponse'
        default:
          description: An unexpected error response.
          schema:
            $ref: '#/definitions/rpcStatus'
      parameters:
      - name: body
        description: 'CreateAzureIntegrationRequest creates the final Azure integration (Step 8).

          Ripple fields are stored alongside Archera integration data to link

          the Azure tenant to the correct Ripple billing group/company/payer context.'
        in: body
        required: true
        schema:
          $ref: '#/definitions/v1CreateAzureIntegrationRequest'
      tags:
      - GuaranteedCommitments
  /v1/onboarding/azure/integrations:
    get:
      summary: 'WORK-IN-PROGRESS: Lists Azure integrations to verify onboarding completion.'
      operationId: GuaranteedCommitments_ListAzureIntegrations
      responses:
        '200':
          description: A successful response.
          schema:
            $ref: '#/definitions/v1ListAzureIntegrationsResponse'
        default:
          description: An unexpected error response.
          schema:
            $ref: '#/definitions/rpcStatus'
      parameters:
      - name: gcOrgId
        description: Required. Archera org ID.
        in: query
        required: false
        type: string
      tags:
      - GuaranteedCommitments
  /v1/onboarding/azure/start:
    post:
      summary: 'WORK-IN-PROGRESS: Starts the Azure onboarding process.

        Creates an onboarding record in Archera for the given org and returns the onboardingId.

        Stores the Ripple billingGroupId/companyId association for later use.'
      operationId: GuaranteedCommitments_StartAzureOnboarding
      responses:
        '200':
          description: A successful response.
          schema:
            $ref: '#/definitions/v1StartAzureOnboardingResponse'
        default:
          description: An unexpected error response.
          schema:
            $ref: '#/definitions/rpcStatus'
      parameters:
      - name: body
        description: 'StartAzureOnboardingRequest initiates Azure onboarding (Step 1).

          Ripple fields are required to link this Azure tenant to the correct

          Ripple billing group and company for cost attribution and management.'
        in: body
        required: true
        schema:
          $ref: '#/definitions/v1StartAzureOnboardingRequest'
      tags:
      - GuaranteedCommitments
  /v1/onboarding/azure/{onboardingId}/accounts:
    get:
      summary: 'WORK-IN-PROGRESS: Lists the available Azure subscriptions or billing accounts

        for the user to select during onboarding.'
      operationId: GuaranteedCommitments_ListAzureOnboardingAccounts
      responses:
        '200':
          description: A successful response.
          schema:
            $ref: '#/definitions/v1ListAzureOnboardingAccountsResponse'
        default:
          description: An unexpected error response.
          schema:
            $ref: '#/definitions/rpcStatus'
      parameters:
      - name: onboardingId
        description: Required. The onboarding ID.
        in: path
        required: true
        type: string
      - name: gcOrgId
        description: Required. Archera org ID.
        in: query
        required: false
        type: string
      tags:
      - GuaranteedCommitments
  /v1/onboarding/azure/{onboardingId}/authurl:
    get:
      summary: 'WORK-IN-PROGRESS: Returns the Azure OAuth URL the user must visit to authorize Archera.'
      operationId: GuaranteedCommitments_GetAzureOnboardingAuthUrl
      responses:
        '200':
          description: A successful response.
          schema:
            $ref: '#/definitions/v1GetAzureOnboardingAuthUrlResponse'
        default:
          description: An unexpected error response.
          schema:
            $ref: '#/definitions/rpcStatus'
      parameters:
      - name: onboardingId
        description: Required. The onboarding ID.
        in: path
        required: true
        type: string
      - name: gcOrgId
        description: Required. Archera org ID.
        in: query
        required: false
        type: string
      - name: tenantId
        description: Azure tenant ID.
        in: query
        required: false
        type: string
      - name: subscriptionId
        description: Azure management subscription ID.
        in: query
        required: false
        type: string
      tags:
      - GuaranteedCommitments
  /v1/onboarding/azure/{onboardingId}/validate:
    post:
      summary: 'WORK-IN-PROGRESS: Validates that the Azure app was installed and the user authorized it.'
      operationId: GuaranteedCommitments_ValidateAzureAppInstall
      responses:
        '200':
          description: A successful response.
          schema:
            $ref: '#/definitions/v1AzureOnboardingState'
        default:
          description: An unexpected error response.
          schema:
            $ref: '#/definitions/rpcStatus'
      parameters:
      - name: onboardingId
        description: Required. The onboarding ID.
        in: path
        required: true
        type: string
      - name: body
        in: body
        required: true
        schema:
          $ref: '#/definitions/GuaranteedCommitmentsValidateAzureAppInstallBody'
      tags:
      - GuaranteedCommitments
  /v1/onboarding/azure/{onboardingId}:update:
    post:
      summary: 'WORK-IN-PROGRESS: Updates the Azure onboarding record.'
      operationId: GuaranteedCommitments_UpdateAzureOnboarding
      responses:
        '200':
          description: A successful response.
          schema:
            $ref: '#/definitions/v1AzureOnboardingState'
        default:
          description: An unexpected error response.
          schema:
            $ref: '#/definitions/rpcStatus'
      parameters:
      - name: onboardingId
        description: Required. The onboarding ID returned from StartAzureOnboarding.
        in: path
        required: true
        type: string
      - name: body
        in: body
        required: true
        schema:
          $ref: '#/definitions/GuaranteedCommitmentsUpdateAzureOnboardingBody'
      tags:
      - GuaranteedCommitments
  /v1/onboarding/billinggroup:validate:
    post:
      operationId: GuaranteedCommitments_ValidateBillingGroup
      responses:
        '200':
          description: A successful response.
          schema:
            $ref: '#/definitions/v1ValidateBillingGroupResponse'
        default:
          description: An unexpected error response.
          schema:
            $ref: '#/definitions/rpcStatus'
      parameters:
      - name: body
        in: body
        required: true
        schema:
          $ref: '#/definitions/v1ValidateBillingGroupRequest'
      tags:
      - GuaranteedCommitments
  /v1/onboarding/status:read:
    post:
      summary: 'WORK-IN-PROGRESS: Retrieves the latest onboarding status for:

        - an MSP

        - a company under an MSP

        - a payer account under an MSP'
      operationId: GuaranteedCommitments_GetOnboardingStatus
      responses:
        '200':
          description: A successful response.
          schema:
            $ref: '#/definitions/v1GetOnboardingStatusResponse'
        default:
          description: An unexpected error response.
          schema:
            $ref: '#/definitions/rpcStatus'
      parameters:
      - name: body
        in: body
        required: true
        schema:
          $ref: '#/definitions/v1GetOnboardingStatusRequest'
      tags:
      - GuaranteedCommitments
  /v1/organizations:read:
    post:
      summary: 'WORK-IN-PROGRESS: List all

# --- truncated at 32 KB (108 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/alphaus/refs/heads/main/openapi/alphaus-guaranteedcommitments-api-openapi.yml