InfluxDB Organizations API

openapi: 3.0.0
info:
  title: Complete InfluxDB Cloud Authorizations (API tokens) Authorizations (API tokens) Organizations API
  description: 'Create and manage authorizations (API tokens).


    An _authorization_ contains a list of `read` and `write`

    permissions for organization resources and provides an API token for authentication.

    An authorization belongs to an organization and only contains permissions for that organization.


    We recommend the following for managing your tokens:


    - Create a generic user to create and manage tokens for writing data.

    - Store your tokens in a secure password vault for future access.


    ### User sessions with authorizations


    Optionally, when creating an authorization, you can scope it to a specific user.

    If the user signs in with username and password, creating a _user session_,

    the session carries the permissions granted by all the user''s authorizations.

    For more information, see [how to assign a token to a specific user](https://docs.influxdata.com/influxdb/cloud/security/tokens/create-token/).

    To create a user session, use the [`POST /api/v2/signin` endpoint](#operation/PostSignin).


    ### Related endpoints


    - [Signin](#tag/Signin)

    - [Signout](#tag/Signout)


    ### Related guides


    - [Authorize API requests](https://docs.influxdata.com/influxdb/cloud/api-guide/api_intro/#authentication)

    - [Manage API tokens](https://docs.influxdata.com/influxdb/cloud/security/tokens/)

    - [Assign a token to a specific user](https://docs.influxdata.com/influxdb/cloud/security/tokens/create-token/)

    '
servers:
- url: ''
security:
- TokenAuthentication: []
tags:
- description: 'Manage your [organization](https://docs.influxdata.com/influxdb/cloud/reference/glossary/#organization).

    An organization is a workspace for a group of users. Organizations can be

    used to separate different environments, projects, teams or users within

    InfluxDB.


    Use the `/api/v2/orgs` endpoints to view and manage organizations.

    '
  name: Organizations
paths:
  /api/v2/orgs:
    get:
      description: 'Lists [organizations](https://docs.influxdata.com/influxdb/cloud/reference/glossary/#organization/).


        To limit which organizations are returned, pass query parameters in your request.

        If no query parameters are passed, InfluxDB returns all organizations up to the default `limit`.


        #### InfluxDB Cloud


        - Only returns the organization that owns the token passed in the request.


        #### Related guides


        - [View organizations](https://docs.influxdata.com/influxdb/cloud/organizations/view-orgs/)

        '
      operationId: GetOrgs
      parameters:
      - $ref: '#/components/parameters/TraceSpan'
      - $ref: '#/components/parameters/Offset'
      - $ref: '#/components/parameters/Limit'
      - $ref: '#/components/parameters/Descending'
      - description: 'An organization name.

          Only returns the specified organization.

          '
        in: query
        name: org
        schema:
          type: string
      - description: 'An organization ID.

          Only returns the specified organization.

          '
        in: query
        name: orgID
        schema:
          type: string
      - description: 'A user ID.

          Only returns organizations where the specified user is a member or owner.

          '
        in: query
        name: userID
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              examples:
                successResponse:
                  value:
                    links:
                      self: /api/v2/orgs
                    orgs:
                    - createdAt: '2022-07-17T23:00:30.778487Z'
                      description: Example InfluxDB organization
                      id: INFLUX_ORG_ID
                      links:
                        buckets: /api/v2/buckets?org=INFLUX_ORG
                        dashboards: /api/v2/dashboards?org=INFLUX_ORG
                        labels: /api/v2/orgs/INFLUX_ORG_ID/labels
                        logs: /api/v2/orgs/INFLUX_ORG_ID/logs
                        members: /api/v2/orgs/INFLUX_ORG_ID/members
                        owners: /api/v2/orgs/INFLUX_ORG_ID/owners
                        secrets: /api/v2/orgs/INFLUX_ORG_ID/secrets
                        self: /api/v2/orgs/INFLUX_ORG_ID
                        tasks: /api/v2/tasks?org=InfluxData
                      name: INFLUX_ORG
                      updatedAt: '2022-07-17T23:00:30.778487Z'
              schema:
                $ref: '#/components/schemas/Organizations'
          description: Success. The response body contains a list of organizations.
        '400':
          $ref: '#/components/responses/BadRequestError'
        '401':
          $ref: '#/components/responses/AuthorizationError'
        '404':
          $ref: '#/components/responses/ResourceNotFoundError'
        '500':
          $ref: '#/components/responses/InternalServerError'
        default:
          $ref: '#/components/responses/GeneralServerError'
      summary: List organizations
      tags:
      - Organizations
    post:
      description: 'Creates an [organization](https://docs.influxdata.com/influxdb/cloud/reference/glossary/#organization)

        and returns the newly created organization.


        #### InfluxDB Cloud


        - Doesn''t allow you to use this endpoint to create organizations.


        #### Related guides


        - [Manage organizations](https://docs.influxdata.com/influxdb/cloud/organizations)

        '
      operationId: PostOrgs
      parameters:
      - $ref: '#/components/parameters/TraceSpan'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PostOrganizationRequest'
        description: The organization to create.
        required: true
      responses:
        '201':
          content:
            application/json:
              examples:
                successResponse:
                  value:
                    createdAt: '2022-08-24T23:05:52.881317Z'
                    description: ''
                    id: INFLUX_ORG_ID
                    links:
                      buckets: /api/v2/buckets?org=INFLUX_ORG
                      dashboards: /api/v2/dashboards?org=INFLUX_ORG
                      labels: /api/v2/orgs/INFLUX_ORG_ID/labels
                      logs: /api/v2/orgs/INFLUX_ORG_ID/logs
                      members: /api/v2/orgs/INFLUX_ORG_ID/members
                      owners: /api/v2/orgs/INFLUX_ORG_ID/owners
                      secrets: /api/v2/orgs/INFLUX_ORG_ID/secrets
                      self: /api/v2/orgs/INFLUX_ORG_ID
                      tasks: /api/v2/tasks?org=INFLUX_ORG
                    name: INFLUX_ORG
                    updatedAt: '2022-08-24T23:05:52.881318Z'
              schema:
                $ref: '#/components/schemas/Organization'
          description: Created. The response body contains the organization information.
        '400':
          $ref: '#/components/responses/BadRequestError'
          examples:
            invalidRequest:
              summary: The `name` field is missing from the request body.
              value:
                code: invalid
                message: org name is empty
        '401':
          $ref: '#/components/responses/AuthorizationError'
        '404':
          $ref: '#/components/responses/ResourceNotFoundError'
        '500':
          $ref: '#/components/responses/InternalServerError'
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
          description: Unexpected error
      summary: Create an organization
      tags:
      - Organizations
      x-codeSamples:
      - label: cURL
        lang: Shell
        source: "curl --request POST \"http://localhost:8086/api/v2/orgs \\\n  --header \"Authorization: Token INFLUX_API_TOKEN\" \\\n  --header \"Accept: application/json\" \\\n  --header \"Content-Type: application/json\" \\\n  --data '{\n      \"name\": \"INFLUX_ORG\",\n      \"description: \"Example InfluxDB organization\"\n    }'\n"
  /api/v2/orgs/{orgID}:
    delete:
      description: "Deletes an organization.\n\nDeleting an organization from InfluxDB Cloud can't be undone.\nOnce deleted, all data associated with the organization is removed.\n\n#### InfluxDB Cloud\n\n- Does the following when you send a delete request:\n\n  1. Validates the request and queues the delete.\n  2. Returns an HTTP `204` status code if queued; _error_ otherwise.\n  3. Handles the delete asynchronously.\n\n#### InfluxDB OSS\n\n- Validates the request, handles the delete synchronously,\nand then responds with success or failure.\n\n#### Limitations\n\n- Only one organization can be deleted per request.\n\n#### Related guides\n\n- [Delete organizations](https://docs.influxdata.com/influxdb/cloud/organizations/delete-orgs/)\n"
      operationId: DeleteOrgsID
      parameters:
      - $ref: '#/components/parameters/TraceSpan'
      - description: 'The ID of the organization to delete.

          '
        in: path
        name: orgID
        required: true
        schema:
          type: string
      responses:
        '204':
          description: "Success.\n\n#### InfluxDB Cloud\n  - The organization is queued for deletion.\n\n#### InfluxDB OSS\n  - The organization is deleted.\n"
        '400':
          $ref: '#/components/responses/BadRequestError'
        '401':
          $ref: '#/components/responses/AuthorizationError'
        '404':
          content:
            application/json:
              examples:
                notFound:
                  summary: 'The requested organization was not found.

                    '
                  value:
                    code: not found
                    message: org not found
              schema:
                $ref: '#/components/schemas/Error'
          description: 'Not found.

            InfluxDB can''t find the organization.

            '
        '500':
          $ref: '#/components/responses/InternalServerError'
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
          description: Unexpected error
      summary: Delete an organization
      tags:
      - Organizations
    get:
      description: 'Retrieves an organization.


        Use this endpoint to retrieve information for a specific organization.


        #### Related guides


        - [View organizations](https://docs.influxdata.com/influxdb/cloud/organizations/view-orgs/)

        '
      operationId: GetOrgsID
      parameters:
      - $ref: '#/components/parameters/TraceSpan'
      - description: 'The ID of the organization to retrieve.

          '
        in: path
        name: orgID
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Organization'
          description: 'Success.

            The response body contains the organization information.

            '
        '401':
          $ref: '#/components/responses/AuthorizationError'
        '404':
          content:
            application/json:
              examples:
                notFound:
                  summary: 'The requested organization wasn''t found.

                    '
                  value:
                    code: not found
                    message: organization not found
              schema:
                $ref: '#/components/schemas/Error'
          description: 'Not found.

            Organization not found.

            '
        '500':
          $ref: '#/components/responses/InternalServerError'
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
          description: Unexpected error
      summary: Retrieve an organization
      tags:
      - Organizations
    patch:
      description: 'Updates an organization.


        Use this endpoint to update properties

        (`name`, `description`) of an organization.


        Updating an organization’s name affects all resources that reference the

        organization by name, including the following:


        - Queries

        - Dashboards

        - Tasks

        - Telegraf configurations

        - Templates


        If you change an organization name, be sure to update the organization name

        in these resources as well.


        #### Related Guides


        - [Update an organization](https://docs.influxdata.com/influxdb/cloud/organizations/update-org/)

        '
      operationId: PatchOrgsID
      parameters:
      - $ref: '#/components/parameters/TraceSpan'
      - description: 'The ID of the organization to update.

          '
        in: path
        name: orgID
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PatchOrganizationRequest'
        description: The organization update to apply.
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Organization'
          description: Success. The response body contains the updated organization.
        '400':
          $ref: '#/components/responses/BadRequestError'
        '401':
          $ref: '#/components/responses/AuthorizationError'
        '404':
          $ref: '#/components/responses/ResourceNotFoundError'
        '500':
          $ref: '#/components/responses/InternalServerError'
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
          description: Unexpected error
      summary: Update an organization
      tags:
      - Organizations
  /api/v2/orgs/{orgID}/members:
    get:
      description: "Lists all users that belong to an organization.\n\nInfluxDB [users](https://docs.influxdata.com/influxdb/cloud/reference/glossary/#user) have\npermission to access InfluxDB.\n\n[Members](https://docs.influxdata.com/influxdb/cloud/reference/glossary/#member) are users\nwithin the organization.\n\n#### InfluxDB Cloud\n\n- Doesn't use `owner` and `member` roles.\n  Use [`/api/v2/authorizations`](#tag/Authorizations-(API-tokens)) to assign user permissions.\n\n#### Limitations\n\n- Member permissions are separate from API token permissions.\n- Member permissions are used in the context of the InfluxDB UI.\n\n#### Required permissions\n\n- `read-orgs INFLUX_ORG_ID`\n\n*`INFLUX_ORG_ID`* is the ID of the organization that you want to retrieve\nmembers for.\n\n#### Related guides\n\n- [Manage users](https://docs.influxdata.com/influxdb/cloud/users/)\n- [Manage members](https://docs.influxdata.com/influxdb/cloud/organizations/members/)\n"
      operationId: GetOrgsIDMembers
      parameters:
      - $ref: '#/components/parameters/TraceSpan'
      - description: 'The ID of the organization to retrieve users for.

          '
        in: path
        name: orgID
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              examples:
                successResponse:
                  value:
                    links:
                      self: /api/v2/orgs/055aa4783aa38398/members
                    users:
                    - id: 791df274afd48a83
                      links:
                        self: /api/v2/users/791df274afd48a83
                      name: example_user_1
                      role: member
                      status: active
                    - id: 09cfb87051cbe000
                      links:
                        self: /api/v2/users/09cfb87051cbe000
                      name: example_user_2
                      role: owner
                      status: active
              schema:
                $ref: '#/components/schemas/ResourceMembers'
          description: 'Success.

            The response body contains a list of all users within the organization.

            '
        '400':
          $ref: '#/components/responses/BadRequestError'
        '401':
          $ref: '#/components/responses/AuthorizationError'
        '404':
          content:
            application/json:
              examples:
                notFound:
                  summary: 'The requested organization wasn''t found.

                    '
                  value:
                    code: not found
                    message: 404 page not found
              schema:
                $ref: '#/components/schemas/Error'
          description: 'Not found.

            InfluxDB can''t find the organization.

            '
        '500':
          $ref: '#/components/responses/InternalServerError'
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
          description: Unexpected error
      summary: List all members of an organization
      tags:
      - Organizations
    post:
      description: "Add a user to an organization.\n\nInfluxDB [users](https://docs.influxdata.com/influxdb/cloud/reference/glossary/#user) have\npermission to access InfluxDB.\n\n[Members](https://docs.influxdata.com/influxdb/cloud/reference/glossary/#member) are users\nwithin the organization.\n\n#### InfluxDB Cloud\n- Doesn't use `owner` and `member` roles.\n  Use [`/api/v2/authorizations`](#tag/Authorizations-(API-tokens)) to assign user permissions.\n\n#### Limitations\n\n- Member permissions are separate from API token permissions.\n- Member permissions are used in the context of the InfluxDB UI.\n\n#### Required permissions\n\n- `write-orgs INFLUX_ORG_ID`\n\n*`INFLUX_ORG_ID`* is the ID of the organization that you want to add a member to.\n\n#### Related guides\n\n- [Manage users](https://docs.influxdata.com/influxdb/cloud/users/)\n- [Manage members](https://docs.influxdata.com/influxdb/cloud/organizations/members/)\n"
      operationId: PostOrgsIDMembers
      parameters:
      - $ref: '#/components/parameters/TraceSpan'
      - description: 'The ID of the organization.

          '
        in: path
        name: orgID
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AddResourceMemberRequestBody'
        description: 'The user to add to the organization.

          '
        required: true
      responses:
        '201':
          content:
            application/json:
              examples:
                successResponse:
                  value:
                    id: 09cfb87051cbe000
                    links:
                      self: /api/v2/users/09cfb87051cbe000
                    name: example_user_1
                    role: member
                    status: active
              schema:
                $ref: '#/components/schemas/ResourceMember'
          description: 'Success.

            The response body contains the user information.

            '
        '400':
          $ref: '#/components/responses/BadRequestError'
          examples:
            invalidRequest:
              summary: The user `id` is missing from the request body.
              value:
                code: invalid
                message: user id missing or invalid
        '401':
          $ref: '#/components/responses/AuthorizationError'
        '404':
          $ref: '#/components/responses/ResourceNotFoundError'
        '500':
          $ref: '#/components/responses/InternalServerError'
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
          description: Unexpected error
      summary: Add a member to an organization
      tags:
      - Organizations
      x-codeSamples:
      - label: cURL
        lang: Shell
        source: "curl --request POST \"http://localhost:8086/api/v2/orgs/INFLUX_ORG_ID/members \\\n  --header \"Authorization: Token INFLUX_API_TOKEN\" \\\n  --header \"Accept: application/json\" \\\n  --header \"Content-Type: application/json\" \\\n  --data '{\n      \"id\": \"09cfb87051cbe000\"\n    }'\n"
  /api/v2/orgs/{orgID}/members/{userID}:
    delete:
      description: "Removes a member from an organization.\n\nUse this endpoint to remove a user's member privileges for an organization.\nRemoving member privileges removes the user's `read` and `write` permissions\nfrom the organization.\n\n#### InfluxDB Cloud\n\n- Doesn't use `owner` and `member` roles.\n  Use [`/api/v2/authorizations`](#tag/Authorizations-(API-tokens)) to assign user permissions.\n\n#### Limitations\n\n- Member permissions are separate from API token permissions.\n- Member permissions are used in the context of the InfluxDB UI.\n\n#### Required permissions\n\n- `write-orgs INFLUX_ORG_ID`\n\n*`INFLUX_ORG_ID`* is the ID of the organization that you want to remove an\nowner from.\n\n#### Related guides\n\n- [Manage members](https://docs.influxdata.com/influxdb/cloud/organizations/members/)\n"
      operationId: DeleteOrgsIDMembersID
      parameters:
      - $ref: '#/components/parameters/TraceSpan'
      - description: The ID of the user to remove.
        in: path
        name: userID
        required: true
        schema:
          type: string
      - description: The ID of the organization to remove a user from.
        in: path
        name: orgID
        required: true
        schema:
          type: string
      responses:
        '204':
          description: 'Success.

            The user is no longer a member of the organization.

            '
        '401':
          $ref: '#/components/responses/AuthorizationError'
        '404':
          $ref: '#/components/responses/ResourceNotFoundError'
        '500':
          $ref: '#/components/responses/InternalServerError'
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
          description: Unexpected error
      summary: Remove a member from an organization
      tags:
      - Organizations
  /api/v2/orgs/{orgID}/owners:
    get:
      description: "Lists all owners of an organization.\n\n#### InfluxDB Cloud\n\n- Doesn't use `owner` and `member` roles.\n  Use [`/api/v2/authorizations`](#tag/Authorizations-(API-tokens)) to assign user permissions.\n\n#### Required permissions\n\n- `read-orgs INFLUX_ORG_ID`\n\n*`INFLUX_ORG_ID`* is the ID of the organization that you want to retrieve a\nlist of owners from.\n"
      operationId: GetOrgsIDOwners
      parameters:
      - $ref: '#/components/parameters/TraceSpan'
      - description: 'The ID of the organization to list owners for.

          '
        in: path
        name: orgID
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              examples:
                successResponse:
                  value:
                    links:
                      self: /api/v2/orgs/055aa4783aa38398/owners
                    users:
                    - id: 09cfb87051cbe000
                      links:
                        self: /api/v2/users/09cfb87051cbe000
                      name: example_user_2
                      role: owner
                      status: active
              schema:
                $ref: '#/components/schemas/ResourceOwners'
          description: A list of organization owners
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
          description: Organization not found
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
          description: Unexpected error
      summary: List all owners of an organization
      tags:
      - Organizations
    post:
      description: "Adds an owner to an organization.\n\nUse this endpoint to assign the organization `owner` role to a user.\n\n#### InfluxDB Cloud\n\n- Doesn't use `owner` and `member` roles.\n  Use [`/api/v2/authorizations`](#tag/Authorizations-(API-tokens)) to assign user permissions.\n\n#### Required permissions\n\n- `write-orgs INFLUX_ORG_ID`\n\n*`INFLUX_ORG_ID`* is the ID of the organization that you want to add an owner for.\n\n#### Related endpoints\n\n- [Authorizations](#tag/Authorizations-(API-tokens))\n"
      operationId: PostOrgsIDOwners
      parameters:
      - $ref: '#/components/parameters/TraceSpan'
      - description: The ID of the organization that you want to add an owner for.
        in: path
        name: orgID
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            examples:
              successResponse:
                value:
                  id: 09cfb87051cbe000
                  links:
                    self: /api/v2/users/09cfb87051cbe000
                  name: example_user_1
                  role: owner
                  status: active
            schema:
              $ref: '#/components/schemas/AddResourceMemberRequestBody'
        description: The user to add as an owner of the organization.
        required: true
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceOwner'
          description: 'Success. The user is an owner of the organization.

            The response body contains the owner with role and user detail.

            '
        '400':
          $ref: '#/components/responses/BadRequestError'
        '401':
          $ref: '#/components/responses/AuthorizationError'
        '404':
          $ref: '#/components/responses/ResourceNotFoundError'
        '500':
          $ref: '#/components/responses/InternalServerError'
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
          description: Unexpected error
      summary: Add an owner to an organization
      tags:
      - Organizations
      x-codeSamples:
      - label: cURL
        lang: Shell
        source: "curl --request POST \"http://localhost:8086/api/v2/orgs/INFLUX_ORG_ID/owners \\\n  --header \"Authorization: Token INFLUX_API_TOKEN\" \\\n  --header \"Accept: application/json\" \\\n  --header \"Content-Type: application/json\" \\\n  --data '{\n      \"id\": \"09cfb87051cbe000\"\n    }'\n"
  /api/v2/orgs/{orgID}/owners/{userID}:
    delete:
      description: "Removes an [owner](https://docs.influxdata.com/influxdb/cloud/reference/glossary/#owner) from\nthe organization.\n\nOrganization owners have permission to delete organizations and remove user and member\npermissions from the organization.\n\n#### InfluxDB Cloud\n- Doesn't use `owner` and `member` roles.\n  Use [`/api/v2/authorizations`](#tag/Authorizations-(API-tokens)) to assign user permissions.\n\n#### Limitations\n\n- Owner permissions are separate from API token permissions.\n- Owner permissions are used in the context of the InfluxDB UI.\n\n#### Required permissions\n\n- `write-orgs INFLUX_ORG_ID`\n\n*`INFLUX_ORG_ID`* is the ID of the organization that you want to\nremove an owner from.\n\n#### Related endpoints\n- [Authorizations](#tag/Authorizations-(API-tokens))\n"
      operationId: DeleteOrgsIDOwnersID
      parameters:
      - $ref: '#/components/parameters/TraceSpan'
      - description: The ID of the user to remove.
        in: path
        name: userID
        required: true
        schema:
          type: string
      - description: 'The ID of the organization to remove an owner from.

          '
        in: path
        name: orgID
        required: true
        schema:
          type: string
      responses:
        '204':
          description: 'Success.

            The user is no longer an owner of the organization.

            '
        '401':
          $ref: '#/components/responses/AuthorizationError'
        '404':
          $ref: '#/components/responses/ResourceNotFoundError'
        '500':
          $ref: '#/components/responses/InternalServerError'
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
          description: Unexpected error
      summary: Remove an owner from an organization
      tags:
      - Organizations
components:
  responses:
    GeneralServerError:
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
      description: Non 2XX error response from server.
    AuthorizationError:
      content:
        application/json:
          examples:
            tokenNotAuthorized:
              summary: Token is not authorized to access a resource
              value:
                code: unauthorized
                message: unauthorized access
          schema:
            properties:
              code:
                description: 'The HTTP status code description. Default is `unauthorized`.

                  '
                enum:
                - unauthorized
                readOnly: true
                type: string
              message:
                description: A human-readable message that may contain detail about the error.
                readOnly: true
                type: string
      description: "Unauthorized. The error may indicate one of the following:\n\n  * The `Authorization: Token` header is missing or malformed.\n  * The API token value is missing from the header.\n  * The token doesn't have sufficient permissions to write to this organization and bucket.\n"
    BadRequestError:
      content:
        application/json:
          examples:
            orgProvidedNotFound:
              summary: The org or orgID passed doesn't own the token passed in the header
              value:
                code: invalid
                message: 'failed to decode request body: organization not found'
          schema:
            $ref: '#/components/schemas/Error'
      description: 'Bad request.

        The response body contains detail about the error.


        #### InfluxDB OSS


        - Returns this error if an incorrect value is passed in the `org` parameter or `orgID` parameter.

        '
    InternalServerError:
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
      description: 'Internal server error.

        The server encountered an unexpected situation.

        '
    ResourceNotFoundError:
      content:
        application/json:
          examples:
            bucket-not-found:
              summary: Bucket name not found
              value:
                code: not found
                message: bucket "air_sensor" not found
            org-not-found:
              summary: Organization name not found
              value:
                code: not found
                message: organization name "my-org" not found
            orgID-not-found:
              summary: Organization ID not found
              value:
                code: not found
                message: organization not found
          schema:
            $ref: '#/components/schemas/Error'
      description: "Not found.\nA requested resource was not found.\nThe response body contains the requested resource type and the name value\n(if you passed it)--for example:\n\n- `\"organization name \\\"my-org\\\" not found\"`\n- `\"organization not found\"`: indicates you passed an ID that did not match\n   an organization.\n"
  parameters:
    Offset:
      description: 'The offset for pagination.

        The number of records to skip.


        For more information about pagination parameters, see [Pagination](https://docs.influxdata.com/influxdb/cloud/api/#tag/Pagination).

        '
      in: query
      name: offset
      required: false
      schema:
        minimum: 0
        type: integer
    Limit:
      description: 'Limits the number of records returned. Default is `20`.

        '
      in: query
      name: limit
      required: false
      schem

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