ConfigHub Organization Member API

openapi: 3.2.0
info:
  title: Confighub Organization Member 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 OrganizationMember 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: OrganizationMember
paths:
  /organization/{organization_id}/organization_member:
    get:
      tags:
      - OrganizationMember
      summary: List OrganizationMembers
      operationId: ListOrganizationMembers
      parameters:
      - name: organization_id
        in: path
        description: Unique identifier for a organization_id
        required: true
        schema:
          type: string
          format: uuid
      - name: where
        in: query
        description: 'The specified string is an expression for the purpose of filtering

          the list of OrganizationMembers 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 OrganizationMember: DisplayName, ExternalID, Slug, UserID, Username.


          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 OrganizationMember 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 (OrganizationMember).


          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 OrganizationMember include string and map-type attributes from the queryable attributes list.


          The whole string must be query-encoded.'
        required: false
        schema:
          type: string
      - name: where_permission
        in: query
        description: 'Only return OrganizationMember 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.'
        required: false
        schema:
          enum:
          - Manage
          - Edit
          - Use
          - View
          type: string
      - name: view
        in: query
        description: 'UUID of a View whose columns to compute for each OrganizationMember, returned as ViewColumns.


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


          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/ExtendedOrganizationMember'
        '400':
          description: OrganizationMember 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: OrganizationMember not found.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StandardErrorResponse'
        '500':
          description: Something went wrong while processing OrganizationMember.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StandardErrorResponse'
    post:
      tags:
      - OrganizationMember
      summary: Create OrganizationMember
      operationId: CreateOrganizationMember
      parameters:
      - name: organization_id
        in: path
        description: Unique identifier for a organization_id
        required: true
        schema:
          type: string
          format: uuid
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/OrganizationMember'
      responses:
        default:
          description: Unexpected error.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StandardErrorResponse'
        '200':
          description: a User given membership on the Organization
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OrganizationMember'
        '400':
          description: OrganizationMember 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: OrganizationMember not found.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StandardErrorResponse'
        '409':
          description: OrganizationMember data conflict. Data has changed since last read.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StandardErrorResponse'
        '500':
          description: Something went wrong while processing OrganizationMember.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StandardErrorResponse'
    servers:
    - url: https://hub.confighub.com/api
      description: production
  /organization/{organization_id}/organization_member/{organization_member_id}:
    delete:
      tags:
      - OrganizationMember
      summary: Delete OrganizationMember
      operationId: DeleteOrganizationMember
      parameters:
      - name: organization_id
        in: path
        description: Unique identifier for a organization_id
        required: true
        schema:
          type: string
          format: uuid
      - name: organization_member_id
        in: path
        description: Unique identifier for a organization_member_id
        required: true
        schema:
          type: string
          format: uuid
      responses:
        default:
          description: Unexpected error.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StandardErrorResponse'
        '200':
          description: Response for successful delete operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeleteResponse'
        '400':
          description: OrganizationMember 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: OrganizationMember not found.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StandardErrorResponse'
        '409':
          description: 'OrganizationMember is still in use: it has DeleteGates, or other entities still reference it. Or data has changed since last read.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StandardErrorResponse'
        '422':
          description: OrganizationMember could not be deleted.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StandardErrorResponse'
        '500':
          description: Something went wrong while processing OrganizationMember.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StandardErrorResponse'
    get:
      tags:
      - OrganizationMember
      summary: Get OrganizationMember
      operationId: GetOrganizationMember
      parameters:
      - name: organization_id
        in: path
        description: Unique identifier for a organization_id
        required: true
        schema:
          type: string
          format: uuid
      - name: organization_member_id
        in: path
        description: Unique identifier for a organization_member_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/ExtendedOrganizationMember'
        '400':
          description: OrganizationMember 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: OrganizationMember not found.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StandardErrorResponse'
        '500':
          description: Something went wrong while processing OrganizationMember.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StandardErrorResponse'
    servers:
    - url: https://hub.confighub.com/api
      description: production
components:
  schemas:
    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
    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
    ExtendedOrganizationMember:
      type: object
      properties:
        Error:
          $ref: '#/components/schemas/ResponseError'
        OrganizationMember:
          $ref: '#/components/schemas/OrganizationMember'
        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
    DeleteResponse:
      type: object
      properties:
        Error:
          allOf:
          - $ref: '#/components/schemas/ResponseError'
          description: Error information if the delete operation failed.
        Message:
          type: string
          description: Response message.
          x-go-type-skip-optional-pointer: true
      description: Response for successful delete operation
    ViewColumn:
      type: object
      properties:
        Name:
          type: string
          x-go-type-skip-optional-pointer: true
        Value:
          type: string
          x-go-type-skip-optional-pointer: true
    OrganizationMember:
      type: object
      properties:
        DisplayName:
          type: string
          description: Friendly name for the organization member User.
          x-confighub-where:
            dataType: string
          x-go-type-skip-optional-pointer: true
        ExternalID:
          type: string
          description: Unique identifier for the External Identity Provider record matching this User.
          x-confighub-where:
            dataType: uuid
          x-go-type-skip-optional-pointer: true
        ExternalOrganizationID:
          type: string
          description: Unique identifier for the External Identity Provider record matching this organization.
          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-go-type-skip-optional-pointer: true
          x-omitzero: true
        ProfilePictureURL:
          type: string
          description: The URL to get the profile avatar picture of the User.
          x-go-type-skip-optional-pointer: true
        Slug:
          type: string
          description: Unique URL-safe identifier for the organization member User.
          x-confighub-where:
            dataType: string
          x-go-type-skip-optional-pointer: true
        UserID:
          type: string
          description: Unique identifier for the organization member User.
          format: uuid
          example: 248df4b7-aa70-47b8-a036-33ac447e668d
          x-confighub-where:
            dataType: uuid
          x-go-type-skip-optional-pointer: true
          x-omitzero: true
        Username:
          type: string
          description: Unique username for a User. Must be unique for all of ConfigHub.
          x-confighub-where:
            dataType: string
          x-go-type-skip-optional-pointer: true
      description: a User given membership on the Organization
    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