Akuity Organization Service API

openapi: 3.2.0
info:
  contact:
    email: info@akuity.io
    name: Akuity
    url: https://docs.akuity.io/akuity-portal/automation/api
  description: The Organization surface of the Akuity Platform REST API (grpc-gateway projection of organization/v1). Derived mechanically from the protobuf service descriptors and google.api.http annotations published in the akuity/api-client-go Go module.
  title: Akuity Platform API — Organization Organization Service API
  version: v1
servers:
- description: Akuity Platform (SaaS)
  url: https://akuity.cloud
security:
- basicAuth: []
tags:
- name: OrganizationService
paths:
  /api/v1/billing/plans:
    get:
      operationId: OrganizationService_ListAvailablePlans
      parameters:
      - in: query
        name: id
        required: false
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/akuity_organization_v1_ListAvailablePlansResponse'
          description: OK
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Status'
          description: unauthenticated
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Status'
          description: permission denied
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Status'
          description: not found
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Status'
          description: gRPC status error
      summary: List Available Plans
      tags:
      - OrganizationService
      x-grpc-method: akuity.organization.v1.OrganizationService/ListAvailablePlans
  /api/v1/organizations:
    get:
      operationId: OrganizationService_ListAuthenticatedUserOrganizations
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/akuity_organization_v1_ListAuthenticatedUserOrganizationsResponse'
          description: OK
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Status'
          description: unauthenticated
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Status'
          description: permission denied
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Status'
          description: not found
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Status'
          description: gRPC status error
      summary: List Authenticated User Organizations
      tags:
      - OrganizationService
      x-grpc-method: akuity.organization.v1.OrganizationService/ListAuthenticatedUserOrganizations
    post:
      operationId: OrganizationService_CreateOrganization
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/akuity_organization_v1_CreateOrganizationRequest'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/akuity_organization_v1_CreateOrganizationResponse'
          description: OK
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Status'
          description: unauthenticated
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Status'
          description: permission denied
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Status'
          description: not found
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Status'
          description: gRPC status error
      summary: Create Organization
      tags:
      - OrganizationService
      x-grpc-method: akuity.organization.v1.OrganizationService/CreateOrganization
  /api/v1/organizations/{id}:
    delete:
      operationId: OrganizationService_DeleteOrganization
      parameters:
      - in: path
        name: id
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/akuity_organization_v1_DeleteOrganizationResponse'
          description: OK
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Status'
          description: unauthenticated
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Status'
          description: permission denied
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Status'
          description: not found
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Status'
          description: gRPC status error
      summary: Delete Organization
      tags:
      - OrganizationService
      x-grpc-method: akuity.organization.v1.OrganizationService/DeleteOrganization
    get:
      operationId: OrganizationService_GetOrganization
      parameters:
      - in: path
        name: id
        required: true
        schema:
          type: string
      - in: query
        name: idType
        required: false
        schema:
          $ref: '#/components/schemas/akuity_types_id_v1_Type'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/akuity_organization_v1_GetOrganizationResponse'
          description: OK
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Status'
          description: unauthenticated
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Status'
          description: permission denied
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Status'
          description: not found
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Status'
          description: gRPC status error
      summary: Get Organization
      tags:
      - OrganizationService
      x-grpc-method: akuity.organization.v1.OrganizationService/GetOrganization
    put:
      operationId: OrganizationService_UpdateOrganization
      parameters:
      - in: path
        name: id
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/akuity_organization_v1_UpdateOrganizationRequest'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/akuity_organization_v1_UpdateOrganizationResponse'
          description: OK
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Status'
          description: unauthenticated
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Status'
          description: permission denied
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Status'
          description: not found
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Status'
          description: gRPC status error
      summary: Update Organization
      tags:
      - OrganizationService
      x-grpc-method: akuity.organization.v1.OrganizationService/UpdateOrganization
  /api/v1/organizations/{id}/apikeys:
    get:
      operationId: OrganizationService_ListOrganizationAPIKeys
      parameters:
      - in: path
        name: id
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/akuity_organization_v1_ListOrganizationAPIKeysResponse'
          description: OK
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Status'
          description: unauthenticated
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Status'
          description: permission denied
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Status'
          description: not found
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Status'
          description: gRPC status error
      summary: List Organization APIKeys
      tags:
      - OrganizationService
      x-grpc-method: akuity.organization.v1.OrganizationService/ListOrganizationAPIKeys
    post:
      operationId: OrganizationService_CreateOrganizationAPIKey
      parameters:
      - in: path
        name: id
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/akuity_organization_v1_CreateOrganizationAPIKeyRequest'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/akuity_organization_v1_CreateOrganizationAPIKeyResponse'
          description: OK
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Status'
          description: unauthenticated
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Status'
          description: permission denied
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Status'
          description: not found
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Status'
          description: gRPC status error
      summary: Create Organization APIKey
      tags:
      - OrganizationService
      x-grpc-method: akuity.organization.v1.OrganizationService/CreateOrganizationAPIKey
  /api/v1/organizations/{id}/audit-logs:
    get:
      operationId: OrganizationService_GetAuditLogs
      parameters:
      - in: path
        name: id
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/akuity_organization_v1_GetAuditLogsResponse'
          description: OK
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Status'
          description: unauthenticated
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Status'
          description: permission denied
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Status'
          description: not found
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Status'
          description: gRPC status error
      summary: Get Audit Logs
      tags:
      - OrganizationService
      x-grpc-method: akuity.organization.v1.OrganizationService/GetAuditLogs
  /api/v1/organizations/{id}/audit-logs-archives:
    get:
      operationId: OrganizationService_ListAuditLogsArchives
      parameters:
      - in: path
        name: id
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/akuity_organization_v1_ListAuditLogsArchivesResponse'
          description: OK
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Status'
          description: unauthenticated
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Status'
          description: permission denied
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Status'
          description: not found
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Status'
          description: gRPC status error
      summary: List Audit Logs Archives
      tags:
      - OrganizationService
      x-grpc-method: akuity.organization.v1.OrganizationService/ListAuditLogsArchives
  /api/v1/organizations/{id}/billing:
    patch:
      operationId: OrganizationService_UpdateBillingDetails
      parameters:
      - in: path
        name: id
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/akuity_organization_v1_UpdateBillingDetailsRequest'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/akuity_organization_v1_UpdateBillingDetailsResponse'
          description: OK
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Status'
          description: unauthenticated
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Status'
          description: permission denied
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Status'
          description: not found
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Status'
          description: gRPC status error
      summary: Update Billing Details
      tags:
      - OrganizationService
      x-grpc-method: akuity.organization.v1.OrganizationService/UpdateBillingDetails
  /api/v1/organizations/{id}/billing/customer:
    get:
      operationId: OrganizationService_GetCustomerDetails
      parameters:
      - in: path
        name: id
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/akuity_organization_v1_GetCustomerDetailsResponse'
          description: OK
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Status'
          description: unauthenticated
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Status'
          description: permission denied
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Status'
          description: not found
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Status'
          description: gRPC status error
      summary: Get Customer Details
      tags:
      - OrganizationService
      x-grpc-method: akuity.organization.v1.OrganizationService/GetCustomerDetails
  /api/v1/organizations/{id}/billing/subscription:
    patch:
      operationId: OrganizationService_UpdateSubscription
      parameters:
      - in: path
        name: id
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/akuity_organization_v1_UpdateSubscriptionRequest'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/akuity_organization_v1_UpdateSubscriptionResponse'
          description: OK
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Status'
          description: unauthenticated
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Status'
          description: permission denied
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Status'
          description: not found
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Status'
          description: gRPC status error
      summary: Update Subscription
      tags:
      - OrganizationService
      x-grpc-method: akuity.organization.v1.OrganizationService/UpdateSubscription
  /api/v1/organizations/{id}/billing/{plan}/addons:
    get:
      operationId: OrganizationService_GetAvailableAddons
      parameters:
      - in: path
        name: id
        required: true
        schema:
          type: string
      - in: path
        name: plan
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/akuity_organization_v1_GetAvailableAddonsResponse'
          description: OK
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Status'
          description: unauthenticated
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Status'
          description: permission denied
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Status'
          description: not found
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Status'
          description: gRPC status error
      summary: Get Available Addons
      tags:
      - OrganizationService
      x-grpc-method: akuity.organization.v1.OrganizationService/GetAvailableAddons
  /api/v1/organizations/{id}/checkout:
    post:
      operationId: OrganizationService_BillingCheckout
      parameters:
      - in: path
        name: id
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/akuity_organization_v1_BillingCheckoutRequest'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/akuity_organization_v1_BillingCheckoutResponse'
          description: OK
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Status'
          description: unauthenticated
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Status'
          description: permission denied
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Status'
          description: not found
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Status'
          description: gRPC status error
      summary: Billing Checkout
      tags:
      - OrganizationService
      x-grpc-method: akuity.organization.v1.OrganizationService/BillingCheckout
  /api/v1/organizations/{id}/csv-audit-logs:
    get:
      operationId: OrganizationService_GetAuditLogsInCSV
      parameters:
      - in: path
        name: id
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                description: Raw HTTP body (see google.api.HttpBody)
                type: string
          description: OK (server-streaming; grpc-gateway emits a newline-delimited JSON stream of result/error envelopes)
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Status'
          description: unauthenticated
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Status'
          description: permission denied
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Status'
          description: not found
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Status'
          description: gRPC status error
      summary: Get Audit Logs In CSV
      tags:
      - OrganizationService
      x-grpc-method: akuity.organization.v1.OrganizationService/GetAuditLogsInCSV
      x-streaming: server
  /api/v1/organizations/{id}/feature-statuses:
    get:
      operationId: OrganizationService_GetFeatureStatuses
      parameters:
      - in: path
        name: id
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/akuity_organization_v1_GetFeatureStatusesResponse'
          description: OK
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Status'
          description: unauthenticated
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Status'
          description: permission denied
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Status'
          description: not found
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Status'
          description: gRPC status error
      summary: Get Feature Statuses
      tags:
      - OrganizationService
      x-grpc-method: akuity.organization.v1.OrganizationService/GetFeatureStatuses
  /api/v1/organizations/{id}/invitees:
    get:
      operationId: OrganizationService_ListOrganizationInvitees
      parameters:
      - in: path
        name: id
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/akuity_organization_v1_ListOrganizationInviteesResponse'
          description: OK
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Status'
          description: unauthenticated
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Status'
          description: permission denied
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Status'
          description: not found
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Status'
          description: gRPC status error
      summary: List Organization Invitees
      tags:
      - OrganizationService
      x-grpc-method: akuity.organization.v1.OrganizationService/ListOrganizationInvitees
  /api/v1/organizations/{id}/join:
    post:
      operationId: OrganizationService_JoinOrganization
      parameters:
      - in: path
        name: id
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/akuity_organization_v1_JoinOrganizationResponse'
          description: OK
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Status'
          description: unauthenticated
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Status'
          description: permission denied
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Status'
          description: not found
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Status'
          description: gRPC status error
      summary: Join Organization
      tags:
      - OrganizationService
      x-grpc-method: akuity.organization.v1.OrganizationService/JoinOrganization
  /api/v1/organizations/{id}/members:
    get:
      operationId: OrganizationService_ListOrganizationMembers
      parameters:
      - in: path
        name: id
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/akuity_organization_v1_ListOrganizationMembersResponse'
          description: OK
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Status'
          description: unauthenticated
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Status'
          description: permission denied
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Status'
          description: not found
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Status'
          description: gRPC status error
      summary: List Organization Members
      tags:
      - OrganizationService
      x-grpc-method: akuity.organization.v1.OrganizationService/ListOrganizationMembers
  /api/v1/organizations/{id}/members/invite:
    post:
      operationId: OrganizationService_InviteMembers
      parameters:
      - in: path
        name: id
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/akuity_organization_v1_InviteMembersRequest'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/akuity_organization_v1_InviteMembersResponse'
          description: OK
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Status'
          description: unauthenticated
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Status'
          description: permission denied
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Status'
          description: not found
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Status'
          description: gRPC status error
      summary: Invite Members
      tags:
      - OrganizationService
      x-grpc-method: akuity.organization.v1.OrganizationService/InviteMembers
  /api/v1/organizations/{id}/members/uninvite:
    post:
      operationId: OrganizationService_UninviteOrganizationMember
      parameters:
      - in: path
        name: id
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/akuity_organization_v1_UninviteOrganizationMemberRequest'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/akuity_organization_v1_UninviteOrganizationMemberResponse'
          description: OK
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Status'
          description: unauthenticated
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Status'
          description: permission denied
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Status'
          description: not found
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Status'
          description: gRPC status error
      summary: Uninvite Organization Member
      tags:
      - OrganizationService
      x-grpc-method: akuity.organization.v1.OrganizationService/UninviteOrganizationMember
  /api/v1/organizations/{id}/members/{member_id}:
    delete:
      operationId: OrganizationService_RemoveOrganizationMember
      parameters:
      - in: path
        name: id
        required: true
        schema:
          type: string
      - in: path
        name: member_id
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/akuity_organization_v1_RemoveOrganizationMemberResponse'
          description: OK
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Status'
          description: unauthenticated
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Status'
          description: permission denied
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Status'
          description: not found
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Status'
          description: gRPC status error
      summary: Remove Organization Member
      tags:
      - OrganizationService
      x-grpc-method: akuity.organization.v1.OrganizationService/RemoveOrganizationMember
    put:
      operationId: OrganizationService_UpdateOrganizationMemberRole
      parameters:
      - in

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