ConfigHub Organization API

openapi: 3.2.0
info:
  title: Confighub Organization API
  version: 0.1.0
  contact:
    name: ConfigHub Support
    url: https://confighub.com/
    email: hello@confighub.com
  license:
    name: N/A
    url: https://confighub.com/TBD
  termsOfService: TBD
  description: 'Operations tagged Organization across 2 of this provider''s published API definitions: openapi.json, confighub-openapi.json. Each path carries the servers of the definition it was published in.'
servers:
- url: https://hub.confighub.com/api
  description: production
security:
- bearerAuth: []
tags:
- name: Organization
paths:
  /organization:
    get:
      tags:
      - Organization
      summary: List Organizations
      operationId: ListOrganizations
      parameters:
      - name: where
        in: query
        description: 'The specified string is an expression for the purpose of filtering

          the list of Organizations returned. The expression syntax was inspired by SQL.

          It supports conjunctions using `AND` of relational expressions of the form *attribute*

          *operator* *attribute_or_literal*. The attribute names are case-sensitive and PascalCase,

          as in the JSON encoding.

          Strings support the following operators: `<`, `>`, `<=`, `>=`, `=`, `!=`, `LIKE`, `NOT LIKE`, `ILIKE`, `~~`, `!~~`, `~`, `~*`, `!~`, `!~*`, `IN`, `NOT IN`.

          String pattern operators: `LIKE` and `~~` for pattern matching with `%` and `_` wildcards,

          `ILIKE` for case-insensitive pattern matching, `NOT LIKE` and `!~~` for negated pattern matching.

          String regex operators: `~` for regex matching, `~*` for case-insensitive regex,

          `!~` and `!~*` for regex not matching (case-sensitive and insensitive).

          Integers support the following operators: `<`, `>`, `<=`, `>=`, `=`, `!=`, `IN`, `NOT IN`.

          UUIDs and boolean attributes support equality and inequality only.

          UUID and time literals must be quoted as string literals.

          String literals are quoted with single quotes, such as `''string''`.

          Time literals use the same form as when serialized as JSON,

          such as: `CreatedAt > ''2025-02-18T23:16:34''`.

          Integer and boolean literals are also supported for attributes of those types.

          Arrays support the `?` operator to to match any element of the array,

          as in `FromLinkID ? ''7c61626f-ddbe-41af-93f6-b69f4ab6d308''`.

          Arrays can perform LEN() to check for length, as in `LEN(FromLinkID) > 0`.

          An attribute naming a list of other entities can be filtered on their attributes with a `*` segment,

          as in `FromLink.*.Slug = ''upgrade-app''`, which holds when any element satisfies it.

          Without the `*` such a reference is an error, since it names no single value to compare.

          Map support the dot notation to specify a particular map key, as in `Labels.tier = ''Backend''`.

          Maps support `IS NULL` and `IS NOT NULL` with dot notation to check for key absence or presence,

          as in `Labels.tier IS NULL` (key doesn''t exist) or `Labels.tier IS NOT NULL` (key exists).

          Comparison results can be tested with `IS TRUE`, `IS FALSE`, `IS NOT TRUE`, and `IS NOT FALSE`.

          These are useful for nullable columns: `MergeSourceID = ''<uuid>'' IS NOT FALSE` matches rows where MergeSourceID equals the value OR is NULL.

          The `IN` and `NOT IN` operators accept a comma-separated list of values in parentheses,

          such as `Slug IN (''slugone'', ''slugtwo'')` or `Labels.environment IN (''prod'', ''staging'')`.

          Conjunctions are supported using the `AND` operator.

          An example conjunction is:

          `CreatedAt >= ''2025-01-07'' AND Slug = ''test'' AND Labels.mykey = ''myvalue''`.


          Supported attributes for filtering on Organization: Annotations, CreatedAt, DeleteGates, DisplayName, EmailDomain, ExternalID, HiddenReason, Labels, OrganizationID, Permissions, Slug, UpdatedAt.


          The whole string must be query-encoded.'
        required: false
        schema:
          type: string
      - name: filter
        in: query
        description: 'UUID of a Filter entity to apply to the Organization list.


          The Filter must be in the same Organization as the user credentials.


          The Filter''s From field must match the entity type being filtered (Organization).


          For Space-resident entities, if the Filter has a FromSpaceID, it must match the operation''s SpaceID.


          The Filter''s Where clause will be combined with any explicit ''where'' parameter using AND logic.


          If both ''filter'' and ''where'' parameters are specified, they are combined with AND logic.'
        required: false
        schema:
          type: string
      - name: contains
        in: query
        description: 'Free text search that approximately matches the specified string against string fields and map keys/values.


          The search is case-insensitive and uses pattern matching to find entities containing the text.


          Searchable string fields include attributes like Slug, DisplayName, and string-typed custom fields.


          For map fields (like Labels and Annotations), the search matches both map keys and values.


          The search uses OR logic across all searchable fields, so matching any field will return the entity.


          If both ''where'' and ''contains'' parameters are specified, they are combined with AND logic.


          Searchable fields for Organization include string and map-type attributes from the queryable attributes list.


          The whole string must be query-encoded.'
        required: false
        schema:
          type: string
      - name: include
        in: query
        description: 'Include clause for expanding related entities in the response for Organization.

          The attribute names are case-sensitive, PascalCase, and

          expected in a comma-separated list format as in the JSON encoding.


          Supported attributes for Organization are .


          The whole string must be query-encoded.'
        required: false
        schema:
          type: string
      - name: select
        in: query
        description: 'Select clause for specifying which fields to include in the response for Organization.

          The attribute names are case-sensitive, PascalCase, and

          expected in a comma-separated list format as in the JSON encoding.

          If not specified, all fields are returned.

          Entity and parent IDs (like OrganizationID, SpaceID, OrganizationID) and Slug are always returned regardless of the select parameter.

          Fields used in where and contains filters, fields named by order_by, and fields read by the columns of the View named by view are also automatically included.

          Example: ''DisplayName,CreatedAt,Labels'' will return only those fields plus the required ID and Slug fields.

          The whole string must be query-encoded.'
        required: false
        schema:
          type: string
      - name: where_permission
        in: query
        description: 'Only return Organization entities on which the caller has this permission, as well as View, which every entity listed needs.


          A list made to choose an entity to act on can name the permission the action needs, such as Edit to change it or Use to refer to it from another entity, so that it leaves out the entities the action would be refused on.


          Supported values: Manage, Edit, Use, View, ManageChildren, EditChildren, UseChildren, ViewChildren, CreateChildren.'
        required: false
        schema:
          enum:
          - Manage
          - Edit
          - Use
          - View
          - ManageChildren
          - EditChildren
          - UseChildren
          - ViewChildren
          - CreateChildren
          type: string
      - name: include_hidden
        in: query
        description: 'Hidden Organization entities, those with a HiddenReason, are left out of the results, or of what a bulk operation acts on, unless this names their HiddenReason.


          It is a comma-separated list of HiddenReasons, or `*` for all of them.


          A where clause naming the entities, by their Slug or ID with `=` or `IN`, or naming HiddenReason at all, also returns hidden entities it selects.


          ConfigHub/YAML Units, which hold the configuration of entities, are hidden with the HiddenReason `BackingUnit`.'
        required: false
        schema:
          type: string
      - name: view
        in: query
        description: 'UUID of a View whose columns to compute for each Organization, returned as ViewColumns.


          The View must be in the same Organization as the user credentials, and be a View of Organization: its Of, or the From of its Filter, must be Organization.


          If the View has a Filter, the Filter selects the entities as the filter parameter does, so the two may not both be specified.


          The related entities and fields the View''s columns read are included and selected automatically, so neither include nor select has to name them.'
        required: false
        schema:
          type: string
      responses:
        default:
          description: Unexpected error.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StandardErrorResponse'
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/ExtendedOrganization'
        '400':
          description: Organization request is invalid (Bad Request).
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StandardErrorResponse'
        '401':
          description: Unauthorized access.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StandardErrorResponse'
        '403':
          description: Forbidden access.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StandardErrorResponse'
        '404':
          description: Organization not found.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StandardErrorResponse'
        '500':
          description: Something went wrong while processing Organization.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StandardErrorResponse'
    servers:
    - url: https://hub.confighub.com/api
      description: production
  /organization/{organization_id}:
    get:
      tags:
      - Organization
      summary: Get Organization
      operationId: GetOrganization
      parameters:
      - name: include
        in: query
        description: 'Include clause for expanding related entities in the response for Organization.

          The attribute names are case-sensitive, PascalCase, and

          expected in a comma-separated list format as in the JSON encoding.


          Supported attributes for Organization are .


          The whole string must be query-encoded.'
        required: false
        schema:
          type: string
      - name: select
        in: query
        description: 'Select clause for specifying which fields to include in the response for Organization.

          The attribute names are case-sensitive, PascalCase, and

          expected in a comma-separated list format as in the JSON encoding.

          If not specified, all fields are returned.

          Entity and parent IDs (like OrganizationID, SpaceID, OrganizationID) and Slug are always returned regardless of the select parameter.

          Fields used in where and contains filters, fields named by order_by, and fields read by the columns of the View named by view are also automatically included.

          Example: ''DisplayName,CreatedAt,Labels'' will return only those fields plus the required ID and Slug fields.

          The whole string must be query-encoded.'
        required: false
        schema:
          type: string
      - name: organization_id
        in: path
        description: Unique identifier for a organization_id
        required: true
        schema:
          type: string
          format: uuid
      responses:
        default:
          description: Unexpected error.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StandardErrorResponse'
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ExtendedOrganization'
        '400':
          description: Organization request is invalid (Bad Request).
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StandardErrorResponse'
        '401':
          description: Unauthorized access.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StandardErrorResponse'
        '403':
          description: Forbidden access.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StandardErrorResponse'
        '404':
          description: Organization not found.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StandardErrorResponse'
        '500':
          description: Something went wrong while processing Organization.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StandardErrorResponse'
    patch:
      tags:
      - Organization
      summary: Patch Organization
      operationId: PatchOrganization
      parameters:
      - name: organization_id
        in: path
        description: Unique identifier for a organization_id
        required: true
        schema:
          type: string
          format: uuid
      - name: dry_run
        in: query
        description: 'If true, report what the write would do without doing it: the write runs, including every check it makes, and is then rolled back. The response is the one the write would return, with the entities as they would be written. An entity a dry run creates is given an ID that the real create will not reuse.'
        required: false
        schema:
          type: boolean
      requestBody:
        content:
          application/merge-patch+json:
            schema:
              type: object
              properties:
                Annotations:
                  type:
                  - object
                  - 'null'
                  additionalProperties:
                    type:
                    - string
                    - 'null'
                  description: An optional map of Annotation key/value pairs for tools to attach information to entities.
                DeleteGates:
                  type:
                  - object
                  - 'null'
                  additionalProperties:
                    type:
                    - boolean
                    - 'null'
                  description: An optional set of gates that, if any is present, will block deletion
                DisplayName:
                  type:
                  - string
                  - 'null'
                  description: Friendly name for the entity.
                EmailDomain:
                  type:
                  - string
                  - 'null'
                  description: ''
                HiddenReason:
                  type:
                  - string
                  - 'null'
                  description: The reason the entity is hidden, if it is. A hidden entity is left out of List and Search results, and of what bulk operations act on, unless the include_hidden parameter names its reason or is *, or the where parameter names the entity by Slug or ID. ConfigHub/YAML Units are created hidden with the reason BackingUnit unless given another.
                Labels:
                  type:
                  - object
                  - 'null'
                  additionalProperties:
                    type:
                    - string
                    - 'null'
                  description: An optional map of Label key/value pairs to specify identifying attributes of entities for the purpose of grouping and filtering them.
                Permissions:
                  type:
                  - object
                  - 'null'
                  additionalProperties:
                    type:
                    - object
                    - 'null'
                  description: ''
                Slug:
                  type:
                  - string
                  - 'null'
                  description: Unique URL-safe identifier for the entity.
                Version:
                  type:
                  - integer
                  - 'null'
                  description: An entity-specific sequence number used for optimistic concurrency control. The value read must be sent in calls to Update.
              description: JSON Merge Patch schema for Organization. All fields are optional and nullable. Readonly fields are ignored.
      responses:
        default:
          description: Unexpected error.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StandardErrorResponse'
        '200':
          description: The top-level container for an organization using ConfigHub.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Organization'
        '400':
          description: Organization request is invalid (Bad Request).
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StandardErrorResponse'
        '401':
          description: Unauthorized access.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StandardErrorResponse'
        '403':
          description: Forbidden access.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StandardErrorResponse'
        '404':
          description: Organization not found.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StandardErrorResponse'
        '409':
          description: Organization data conflict. Data has changed since last read.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StandardErrorResponse'
        '500':
          description: Something went wrong while processing Organization.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StandardErrorResponse'
    put:
      tags:
      - Organization
      summary: Update Organization
      operationId: UpdateOrganization
      parameters:
      - name: organization_id
        in: path
        description: Unique identifier for a organization_id
        required: true
        schema:
          type: string
          format: uuid
      - name: dry_run
        in: query
        description: 'If true, report what the write would do without doing it: the write runs, including every check it makes, and is then rolled back. The response is the one the write would return, with the entities as they would be written. An entity a dry run creates is given an ID that the real create will not reuse.'
        required: false
        schema:
          type: boolean
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Organization'
      responses:
        default:
          description: Unexpected error.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StandardErrorResponse'
        '200':
          description: The top-level container for an organization using ConfigHub.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Organization'
        '400':
          description: Organization request is invalid (Bad Request).
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StandardErrorResponse'
        '401':
          description: Unauthorized access.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StandardErrorResponse'
        '403':
          description: Forbidden access.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StandardErrorResponse'
        '404':
          description: Organization not found.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StandardErrorResponse'
        '409':
          description: Organization data conflict. Data has changed since last read.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StandardErrorResponse'
        '500':
          description: Something went wrong while processing Organization.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StandardErrorResponse'
    servers:
    - url: https://hub.confighub.com/api
      description: production
components:
  schemas:
    ExtendedOrganization:
      type: object
      properties:
        Error:
          $ref: '#/components/schemas/ResponseError'
        Organization:
          $ref: '#/components/schemas/Organization'
        ViewColumns:
          type: array
          items:
            $ref: '#/components/schemas/ViewColumn'
          description: The values of the columns of the View named by the view parameter, in the View's column order. A column that selects several values, such as one with a wildcard, has an entry for each, all with the column's Name.
          x-go-type-skip-optional-pointer: true
    ErrorMetadata:
      type: object
      properties:
        EntityID:
          type: string
          description: Optional ID of the entity this error relates to
          x-go-type-skip-optional-pointer: true
        EntitySlug:
          type: string
          description: Optional slug of the entity this error relates to
          x-go-type-skip-optional-pointer: true
        EntityType:
          type: string
          description: Optional type of the entity this error relates to
          x-go-type-skip-optional-pointer: true
        Items:
          type: array
          items:
            $ref: '#/components/schemas/ErrorItem'
          description: Collection of error details
          x-go-type-skip-optional-pointer: true
    ErrorItem:
      type: object
      properties:
        Description:
          type: string
          description: A clear explanation of what went wrong
          x-go-type-skip-optional-pointer: true
        Item:
          type: string
          description: The name of the field, resource, or entity that the error relates to
          x-go-type-skip-optional-pointer: true
    Subjects:
      type: object
      properties:
        GroupIDs:
          type: object
          additionalProperties:
            type: boolean
          x-go-type-skip-optional-pointer: true
        UserIDs:
          type: object
          additionalProperties:
            type: boolean
          x-go-type-skip-optional-pointer: true
    ResponseError:
      type: object
      properties:
        Details:
          type: array
          items:
            type: string
          description: Additional context messages
          x-go-type-skip-optional-pointer: true
        ErrorMetadata:
          allOf:
          - $ref: '#/components/schemas/ErrorMetadata'
          description: Structured error details like field violations
        Message:
          type: string
          description: The primary error message
          x-go-type-skip-optional-pointer: true
        Status:
          type: integer
          description: HTTP status code
          x-go-type-skip-optional-pointer: true
        Type:
          type: string
          description: 'The category of the error, as a code: UserInput, Validation, Data, Authentication, Permission, NotFound, Conflict, AlreadyExists, Unprocessable, Locked, PreconditionFailed, TooManyRequests, Unexpected, GatewayTimeout, or ServiceUnavailable'
          x-go-type-skip-optional-pointer: true
    Permissions:
      type: object
      additionalProperties:
        $ref: '#/components/schemas/Subjects'
    Organization:
      required:
      - Slug
      type: object
      properties:
        Annotations:
          type: object
          additionalProperties:
            maxLength: 1024
            pattern: ^(.|\n)*$
            type: string
          description: An optional map of Annotation key/value pairs for tools to attach information to entities.
          x-confighub-where:
            dataType: map[string]string
          x-go-type-skip-optional-pointer: true
        CreatedAt:
          type: string
          description: The timestamp when the entity was created in "2023-01-01T12:00:00Z" format.
          format: date-time
          readOnly: true
          example: '2025-04-04T11:50:02.95102-07:00'
          x-confighub-where:
            dataType: time
          x-go-type-skip-optional-pointer: true
          x-omitzero: true
        DeleteGates:
          type: object
          additionalProperties:
            type: boolean
          description: An optional set of gates that, if any is present, will block deletion.
          x-confighub-where:
            dataType: map[string]bool
          x-go-type-skip-optional-pointer: true
        DisplayName:
          type: string
          description: Friendly name for the entity.
          x-confighub-where:
            dataType: string
          x-go-type-skip-optional-pointer: true
        EmailDomain:
          type: string
          description: Unique email domain name for the External Identity Provider record matching this organization
          x-confighub-where:
            dataType: string
          x-go-type-skip-optional-pointer: true
        EntityType:
          type: string
          description: The type of entity.
          readOnly: true
          x-go-type-skip-optional-pointer: true
        ExternalID:
          type: string
          description: Unique identifier for the External Identity Provider record matching this organization.
          readOnly: true
          x-confighub-where:
            dataType: string
          x-go-type-skip-optional-pointer: true
        HiddenReason:
          maxLength: 64
          pattern: ^([A-Za-z0-9]([\-_.A-Za-z0-9]*[A-Za-z0-9])?)?$
          type: string
          description: The reason the entity is hidden, if it is. A hidden entity is left out of List and Search results, and of what bulk operations act on, unless the include_hidden parameter names its reason or is *, or the where parameter names the entity by Slug or ID. ConfigHub/YAML Units are created hidden with the reason BackingUnit unless given another.
          x-confighub-where:
            dataType: string
          x-go-type-skip-optional-pointer: true
        Labels:
          type: object
          additionalProperties:
            maxLength: 128
            pattern: ^[\-_@/#$%&~+=!?.,:;(){}\[\]<>|A-Za-z0-9](([\-_@/#$%&~+=!?.,:;(){}\[\]<>|A-Za-z0-9]| )*[\-_@/#$%&~+=!?.,:;(){}\[\]<>|A-Za-z0-9])?$
            type: string
          description: An optional map of Label key/value pairs to specify identifying attributes of entities for the purpose of grouping and filtering them.
          x-confighub-where:
            dataType: map[string]string
          x-go-type-skip-optional-pointer: true
        OrganizationID:
          type: string
          description: Unique identifier for an organization.
          format: uuid
          example: 248df4b7-aa70-47b8-a036-33ac447e668d
          x-confighub-where:
            dataType: uuid
          x-go-type-skip-optional-pointer: true
          x-omitzero: true
        Permissions:
          allOf:
          - $ref: '#/components/schemas/Permissions'
          description: Permissions to access this organization. Its Children categories apply to the spaces and the other entities that belong to the organization rather than to a space.
          x-confighub-where:
            dataType: map[string]map[string]map[uuid]bool
        Slug:
          maxLength: 128
          pattern: ^[A-Za-z0-9]([\-_.A-Za-z0-9]*[A-Za-z0-9])?$
          type: string
          description: Unique URL-safe identifier for the entity.
          x-confighub-where:
            dataType: string
          x-go-type-skip-optional-pointer: true
        UpdatedAt:
          type: string
          description: The timestamp when the entity was last updated in "2023-01-01T12:00:00Z" format.
          format: date-time
          readOnly: true
          example: '2025-04-04T11:50:02.95102-07:00'
          x-confighub-where:
            dataType: time
          x-go-type-skip-optional-pointer: true
          x-omitzero: true
        Version:
          type: integer
          description: An entity-specific sequence number used for optimistic concurrency control. The value read must be sent in calls to Update.
          format: int64
          readOnly: false
          x-go-type-skip-optional-pointer: true
      description: The top-level container for an organization using ConfigHub.
    ViewColumn:
      type: object
      properties:
        Name:
          type: string
          x-go-type-skip-optional-pointer: true
        Value:
          type: string
          x-go-type-skip-optional-pointer: true
    StandardErrorResponse:
      type: object
      properties:
        Error:
          allOf:
          - $ref: '#/components/schemas/ResponseError'
          description: 'The error: its message, category (Type), HTTP status, details, and structured items.'
        message:
          type: string
          description: 'The error as one string: its message, with any details, items, and individual errors appended. Kept for clients written before Error; new clients read Error.'
          x-go-type-skip-optional-pointer: true
      description: 'The body of an error response: the error as data (Error), and as one string (message) for clients written before Error.'
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: Bearer authentication
x-refined-from:
- openapi.json
- confighub-openapi.json