openapi: 3.0.1
info:
  title: Management API
  version: ''
  description: >
    The Synqly Management APIs enable you to manage the resources within your
    Synqly organization, such as setting up Accounts for your customers and
    creating Integrations to connect your product to the different service
    Providers supported by Synqly.


    For more information see the [Synqly
    Overview](/guides/getting-started/overview).
paths:
  /v1/accounts:
    get:
      description: |-
        Returns a list of all `Account` objects. For more information on
        Organizations and Accounts, refer to our
        [Synqly Overview](https://docs.synqly.com/docs/synqly-overview).
      operationId: accounts_list
      tags:
        - Accounts
      parameters:
        - name: limit
          in: query
          description: Number of `Account` objects to return in this page. Defaults to 100.
          required: false
          schema:
            type: integer
            nullable: true
        - name: start_after
          in: query
          description: Return `Account` objects starting after this `name`.
          required: false
          schema:
            type: string
            nullable: true
        - name: order
          in: query
          description: >-
            Select a field to order the results by. Defaults to `name`. To
            control the direction of the sorting, append

            `[asc]` or `[desc]` to the field name. For example, `name[desc]`
            will sort the results by `name` in descending order.

            The ordering defaults to `asc` if not specified. May be used
            multiple times to order by multiple fields, and the

            ordering is applied in the order the fields are specified.
          required: false
          schema:
            type: array
            items:
              type: string
              nullable: true
        - name: filter
          in: query
          description: >-
            Filter results by this query. For more information on filtering,
            refer to our Filtering Guide. Defaults to no filter.

            If used more than once, the queries are ANDed together.
          required: false
          schema:
            type: array
            items:
              type: string
              nullable: true
        - name: total
          in: query
          description: >-
            Return total number of accounts in the system, respecting all
            applied filters. This is expensive, use sparingly.
          required: false
          schema:
            type: boolean
            nullable: true
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListAccountsResponse'
        '400':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '401':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '403':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '404':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '405':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '409':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '415':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '429':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '500':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
      summary: List Accounts
      security:
        - BearerAuth: []
    post:
      description: |-
        Creates an `Account` object. For more information on Organizations and
        Accounts, refer to our
        [Synqly Overview](https://docs.synqly.com/docs/synqly-overview).
      operationId: accounts_create
      tags:
        - Accounts
      parameters: []
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateAccountResponse'
        '400':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '401':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '403':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '404':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '405':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '409':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '415':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '429':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '500':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
      summary: Create Account
      security:
        - BearerAuth: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateAccountRequest'
  /v1/accounts/{accountId}:
    get:
      description: >-
        Returns the `Account` object matching `{accountId}`. For more
        information on

        Organizations and Accounts, refer to our

        [Synqly Overview](https://docs.synqly.com/docs/synqly-overview).
      operationId: accounts_get
      tags:
        - Accounts
      parameters:
        - name: accountId
          in: path
          required: true
          schema:
            $ref: '#/components/schemas/AccountId'
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetAccountResponse'
        '400':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '401':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '403':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '404':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '405':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '409':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '415':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '429':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '500':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
      summary: Get Account
      security:
        - BearerAuth: []
    put:
      description: >-
        Updates the `Account` object matching `{accountId}`. For more
        information on

        Organizations and Accounts, refer to our

        [Synqly Overview](https://docs.synqly.com/docs/synqly-overview).
      operationId: accounts_update
      tags:
        - Accounts
      parameters:
        - name: accountId
          in: path
          required: true
          schema:
            $ref: '#/components/schemas/AccountId'
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UpdateAccountResponse'
        '400':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '401':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '403':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '404':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '405':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '409':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '415':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '429':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '500':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
      summary: Update Account
      security:
        - BearerAuth: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateAccountRequest'
    patch:
      description: >-
        Patches the `Account` object matching `{accountId}`. For more
        information on

        Organizations and Accounts, refer to our

        [Synqly Overview](https://docs.synqly.com/docs/synqly-overview).
      operationId: accounts_patch
      tags:
        - Accounts
      parameters:
        - name: accountId
          in: path
          required: true
          schema:
            $ref: '#/components/schemas/AccountId'
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PatchAccountResponse'
        '400':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '401':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '403':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '404':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '405':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '409':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '415':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '429':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '500':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
      summary: Patch Account
      security:
        - BearerAuth: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: array
              items:
                $ref: '#/components/schemas/PatchOperation'
    delete:
      description: >-
        Deletes the `Account` matching `{accountId}`. Deleting an `Account` also
        deletea

        all `Tokens` and `Credentials` belonging to the `Account`.
      operationId: accounts_delete
      tags:
        - Accounts
      parameters:
        - name: accountId
          in: path
          required: true
          schema:
            $ref: '#/components/schemas/AccountId'
      responses:
        '204':
          description: ''
        '400':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '401':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '403':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '404':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '405':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '409':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '415':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '429':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '500':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
      summary: Delete Account
      security:
        - BearerAuth: []
  /v1/audit/organizations:
    get:
      description: Returns a list of all Synqly `Audit` events for the `Organization`.
      operationId: audit_list
      tags:
        - Audit
      parameters:
        - name: limit
          in: query
          description: Number of `Audit` objects to return in this page. Defaults to 100.
          required: false
          schema:
            type: integer
            nullable: true
        - name: start_after
          in: query
          description: Return `Audit` objects starting after this `created_at`.
          required: false
          schema:
            type: string
            nullable: true
        - name: order
          in: query
          description: >-
            The order defaults to created_at[asc] and can changed to descending
            order by specifying created_at[desc].
          required: false
          schema:
            type: string
            nullable: true
        - name: filter
          in: query
          description: >-
            Filter results by this query. For more information on filtering,
            refer to our Filtering Guide. Defaults to no filter.

            If used more than once, the queries are ANDed together.
          required: false
          schema:
            type: array
            items:
              type: string
              nullable: true
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListAuditEventsResponse'
        '400':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '401':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '403':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '404':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '405':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '409':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '415':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '429':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '500':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
      summary: List Audit Events
      security:
        - BearerAuth: []
  /v1/auth/logon:
    post:
      description: >-
        Initiates a new session for the given member in a Synqly organization.
        The organization is identified by the given organization token.
      operationId: auth_logon
      tags:
        - Auth
      parameters: []
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LogonResponse'
        '400':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '401':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '403':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '404':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '405':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '409':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '415':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '429':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '500':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
      summary: Logon
      security:
        - BearerAuth: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/LogonRequest'
  /v1/auth/change_password:
    post:
      description: Change member password.
      operationId: auth_change_password
      tags:
        - Auth
      parameters: []
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ChangePasswordResponse'
        '400':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '401':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '403':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '404':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '405':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '409':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '415':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '429':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '500':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
      summary: Change Member Password
      security:
        - BearerAuth: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ChangePasswordRequest'
  /v1/auth/logoff:
    post:
      description: Terminates the session identified by the given logon token.
      operationId: auth_logoff
      tags:
        - Auth
      parameters: []
      responses:
        '204':
          description: ''
        '400':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '401':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '403':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '404':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '405':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '409':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '415':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '429':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '500':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
      summary: Logoff
      security:
        - BearerAuth: []
  /v1/bridges/{accountId}:
    get:
      description: >-
        Returns a list of all `Bridge Group` objects that match the query
        params.
      operationId: bridges_list
      tags:
        - Bridges
      parameters:
        - name: accountId
          in: path
          required: true
          schema:
            $ref: '#/components/schemas/AccountId'
        - name: limit
          in: query
          description: Number of `Bridge` objects to return in this page. Defaults to 100.
          required: false
          schema:
            type: integer
            nullable: true
        - name: start_after
          in: query
          description: Return `Bridge` objects starting after this `name`.
          required: false
          schema:
            type: string
            nullable: true
        - name: order
          in: query
          description: >-
            Select a field to order the results by. Defaults to `name`. To
            control the direction of the sorting, append

            `[asc]` or `[desc]` to the field name. For example, `name[desc]`
            will sort the results by `name` in descending order.

            The ordering defaults to `asc` if not specified. May be used
            multiple times to order by multiple fields, and the

            ordering is applied in the order the fields are specified.
          required: false
          schema:
            type: array
            items:
              type: string
              nullable: true
        - name: filter
          in: query
          description: >-
            Filter results by this query. For more information on filtering,
            refer to our Filtering Guide. Defaults to no filter.

            If used more than once, the queries are ANDed together.
          required: false
          schema:
            type: array
            items:
              type: string
              nullable: true
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListBridgesResponse'
        '400':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '401':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '403':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '404':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '405':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '409':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '415':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '429':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '500':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
      summary: List Bridge Groups
      security:
        - BearerAuth: []
    post:
      description: |-
        Creates a `Bridge Group` with a unique identifier and authentication
        credentials. This allows for Bridge Agents to connect to Synqly. For
        more information on Bridges, refer to our
        [Synqly Overview](https://docs.synqly.com/docs/synqly-overview).
      operationId: bridges_create
      tags:
        - Bridges
      parameters:
        - name: accountId
          in: path
          required: true
          schema:
            $ref: '#/components/schemas/AccountId'
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateBridgeResponse'
        '400':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '401':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '403':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '404':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '405':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '409':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '415':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '429':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '500':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
      summary: Create Bridge Group
      security:
        - BearerAuth: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateBridgeRequest'
  /v1/bridges/{accountId}/{bridgeId}:
    get:
      description: >-
        Returns the Bridge Group object matching `{bridgeId}`. For more
        information on Bridges, refer to the

        [Bridge Overview](https://docs.synqly.com/docs/synqly-overview).
      operationId: bridges_get
      tags:
        - Bridges
      parameters:
        - name: accountId
          in: path
          required: true
          schema:
            $ref: '#/components/schemas/AccountId'
        - name: bridgeId
          in: path
          required: true
          schema:
            $ref: '#/components/schemas/BridgeGroupId'
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetBridgeResponse'
        '400':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '401':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '403':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '404':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '405':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '409':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '415':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '429':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '500':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
      summary: Get Bridge Groups
      security:
        - BearerAuth: []
    put:
      description: >-
        Updates the `Bridge Group` object matching `{bridgeId}`. For more
        information on Bridges, refer to our

        [Synqly Overview](https://docs.synqly.com/docs/synqly-overview).
      operationId: bridges_update
      tags:
        - Bridges
      parameters:
        - name: accountId
          in: path
          required: true
          schema:
            $ref: '#/components/schemas/AccountId'
        - name: bridgeId
          in: path
          required: true
          schema:
            $ref: '#/components/schemas/BridgeGroupId'
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UpdateBridgeResponse'
        '400':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '401':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '403':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '404':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '405':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '409':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '415':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '429':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '500':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
      summary: Update Bridge Group
      security:
        - BearerAuth: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateBridgeRequest'
    patch:
      description: >-
        Patches the `Bridge Group` object matching `{bridgeId}`. For more
        information on Bridges, refer to our

        [Synqly Overview](https://docs.synqly.com/docs/synqly-overview).
      operationId: bridges_patch
      tags:
        - Bridges
      parameters:
        - name: accountId
          in: path
          required: true
          schema:
            $ref: '#/components/schemas/AccountId'
        - name: bridgeId
          in: path
          required: true
          schema:
            $ref: '#/components/schemas/BridgeGroupId'
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PatchBridgeResponse'
        '400':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '401':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '403':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '404':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '405':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '409':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '415':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '429':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '500':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
      summary: Patch Bridge Group
      security:
        - BearerAuth: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: array
              items:
                $ref: '#/components/schemas/PatchOperation'
    delete:
      description: >-
        Deletes the `Bridge Group` matching `{bridgeId}`. Deleting an `Bridge
        Group` also deletea

        all `Tokens` and `Credentials` belonging to the `Bridge Group`.
      operationId: bridges_delete
      tags:
        - Bridges
      parameters:
        - name: accountId
          in: path
          required: true
          schema:
            $ref: '#/components/schemas/AccountId'
        - name: bridgeId
          in: path
          required: true
          schema:
            $ref: '#/components/schemas/BridgeGroupId'
      responses:
        '204':
          description: ''
        '400':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '401':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '403':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '404':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '405':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '409':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '415':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '429':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '500':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
      summary: Delete Bridge Group
      security:
        - BearerAuth: []
  /v1/bridges/{accountId}/{bridgeId}/status:
    get:
      description: >-
        Returns the status and local configuration of running Bridges Agents in
        the Bridge Group `{bridgeId}`.
      operationId: bridges_get_status
      tags:
        - Bridges
      parameters:
        - name: accountId
          in: path
          required: true
          schema:
            $ref: '#/components/schemas/AccountId'
        - name: bridgeId
          in: path
          required: true
          schema:
            $ref: '#/components/schemas/BridgeGroupId'
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetBridgeStatusResponse'
        '400':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '401':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '403':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '404':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '405':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '409':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '415':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '429':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '500':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
      summary: Get Bridge Agent Statuses
      security:
        - BearerAuth: []
  /v1/capabilities/connectors:
    get:
      description: Returns a list of all `Connectors`.
      operationId: capabilities_list_connectors
      tags:
        - Capabilities
      parameters:
        - name: expand
          in: query
          description: |-
            Expand the capabilities result fields that are otherwise
            omitted or returned as references to OpenAPI spec components.
            NOTE: This can yield very big response objects.
          required: false
          schema:
            type: array
            items:
              $ref: '#/components/schemas/ListConnectorCapabilitiesExpandOptions'
              nullable: true
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListConnectorsCapabilitiesResponse'
        '400':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '401':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '403':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '404':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '405':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '409':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '415':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '429':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '500':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
      summary: List Connectors
      security:
        - BearerAuth: []
  /v1/capabilities/providers:
    get:
      description: Returns a list of all Provider capabilities and their configurations.
      operationId: capabilities_list_providers
      tags:
        - Capabilities
      parameters:
        - name: expand
          in: query
          description: |-
            Expand the capabilities result fields that are otherwise
            omitted or returned as references to OpenAPI spec components.
            NOTE: This can yield very big response objects.
          required: false
          schema:
            type: array
            items:
              $ref: '#/components/schemas/ListProviderCapabilitiesExpandOptions'
              nullable: true
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListProvidersCapabilitiesResponse'
        '400':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '401':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '403':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '404':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '405':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '409':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '415':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '429':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '500':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
      summary: List Providers
      security:
        - BearerAuth: []
  /v1/capabilities/providers/{providerId}:
    get:
      description: Returns the capabilities and configurations for a specific Provider type
      operationId: capabilities_get_provider
      tags:
        - Capabilities
      parameters:
        - name: providerId
          in: path
          required: true
          schema:
            $ref: '#/components/schemas/ProviderConfigId'
        - name: expand
          in: query
          description: |-
            Expand the capabilities result fields that are otherwise
            omitted or returned as references to OpenAPI spec components.
            NOTE: This can yield very big response objects.
          required: false
          schema:
            type: array
            items:
              $ref: '#/components/schemas/GetProviderCapabilitiesExpandOptions'
              nullable: true
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProviderCapabilitiesResponse'
        '400':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '401':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '403':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '404':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '405':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '415':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '429':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '500':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
      summary: Get Provider
      security:
        - BearerAuth: []
  /v1/credentials/{ownerId}:
    get:
      description: >-
        Returns a list of all `Credential` objects belonging to the `Account`,
        `Integration`, or `IntegrationPoint`, or `OrganizationWebhook` matching

        `{ownerId}`.
      operationId: credentials_list
      tags:
        - Credentials
      parameters:
        - name: ownerId
          in: path
          required: true
          schema:
            $ref: '#/components/schemas/Id'
        - name: limit
          in: query
          description: >-
            Number of `Credential` objects to return in this page. Defaults to
            100.
          required: false
          schema:
            type: integer
            nullable: true
        - name: start_after
          in: query
          description: Return `Credential` objects starting after this `name`.
          required: false
          schema:
            type: string
            nullable: true
        - name: order
          in: query
          description: >-
            Select a field to order the results by. Defaults to `name`. To
            control the direction of the sorting, append

            `[asc]` or `[desc]` to the field name. For example, `name[desc]`
            will sort the results by `name` in descending order.

            The ordering defaults to `asc` if not specified. May be used
            multiple times to order by multiple fields, and the

            ordering is applied in the order the fields are specified.
          required: false
          schema:
            type: array
            items:
              type: string
              nullable: true
        - name: filter
          in: query
          description: >-
            Filter results by this query. For more information on filtering,
            refer to our Filtering Guide. Defaults to no filter.

            If used more than once, the queries are ANDed together.
          required: false
          schema:
            type: array
            items:
              type: string
              nullable: true
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListCredentialsResponse'
        '400':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '401':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '403':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '404':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '405':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '409':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '415':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '429':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '500':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
      summary: List Credentials
      security:
        - BearerAuth: []
    post:
      description: >-
        Creates a `Credential` object in the `Account`, `IntegrationPoint`, or
        `OrganizationWebhook` matching matching

        `{ownerId}`. A `Credential` may only by used by a single `Account`,
        `Integration`, `IntegrationPoint` or `OrganizationWebhook`;

        however, `Credential` objects can be shared by multiple `Integrations`
        within an `Account`.
      operationId: credentials_create
      tags:
        - Credentials
      parameters:
        - name: ownerId
          in: path
          required: true
          schema:
            $ref: '#/components/schemas/Id'
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateCredentialResponse'
        '400':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '401':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '403':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '404':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '405':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '409':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '415':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '429':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '500':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
      summary: Create Credential
      security:
        - BearerAuth: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateCredentialRequest'
  /v1/credentials/{ownerId}/{credentialId}:
    get:
      description: >-
        Returns the `Credential` object matching `{credentialId}` where the

        `Credential` belongs to the `Account`, `Integration`, `IntegrationPoint`
        or `OrganizationWebhook` matching `{ownerId}`.
      operationId: credentials_get
      tags:
        - Credentials
      parameters:
        - name: ownerId
          in: path
          required: true
          schema:
            $ref: '#/components/schemas/Id'
        - name: credentialId
          in: path
          required: true
          schema:
            $ref: '#/components/schemas/CredentialId'
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetCredentialResponse'
        '400':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '401':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '403':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '404':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '405':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '409':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '415':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '429':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '500':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
      summary: Get Credential
      security:
        - BearerAuth: []
    put:
      description: >-
        Updates the `Credential` object matching `{credentialId}`, where the

        `Credential` belongs to the `Account`, `Integration`, `IntegrationPoint`
        or `OrganizationWebhook` matching `{ownerId}`.
      operationId: credentials_update
      tags:
        - Credentials
      parameters:
        - name: ownerId
          in: path
          required: true
          schema:
            $ref: '#/components/schemas/Id'
        - name: credentialId
          in: path
          required: true
          schema:
            $ref: '#/components/schemas/CredentialId'
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UpdateCredentialResponse'
        '400':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '401':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '403':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '404':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '405':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '409':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '415':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '429':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '500':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
      summary: Update Credential
      security:
        - BearerAuth: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateCredentialRequest'
    patch:
      description: >-
        Patches the `Credential` object matching `{credentialId}`, where the

        `Credential` belongs to the `Account`, `Integration`, `IntegrationPoint`
        or `OrganizationWebhook` matching `{ownerId}`.
      operationId: credentials_patch
      tags:
        - Credentials
      parameters:
        - name: ownerId
          in: path
          required: true
          schema:
            $ref: '#/components/schemas/Id'
        - name: credentialId
          in: path
          required: true
          schema:
            $ref: '#/components/schemas/CredentialId'
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PatchCredentialResponse'
        '400':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '401':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '403':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '404':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '405':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '409':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '415':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '429':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '500':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
      summary: Patch Credential
      security:
        - BearerAuth: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: array
              items:
                $ref: '#/components/schemas/PatchOperation'
    delete:
      description: >-
        Deletes the `Credential` object matching `{credentialId}`, where the

        `Credential` belongs to the `Account`, `Integration`, `IntegrationPoint`
        or `OrganizationWebhook` matching `{ownerId}`.
      operationId: credentials_delete
      tags:
        - Credentials
      parameters:
        - name: ownerId
          in: path
          required: true
          schema:
            $ref: '#/components/schemas/Id'
        - name: credentialId
          in: path
          required: true
          schema:
            $ref: '#/components/schemas/CredentialId'
      responses:
        '204':
          description: ''
        '400':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '401':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '403':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '404':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '405':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '409':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '415':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '429':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '500':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
      summary: Delete Credential
      security:
        - BearerAuth: []
  /v1/credentials/lookup/{credentialId}:
    get:
      description: Returns the `Credential` object matching `{credentialId}`.
      operationId: credentials_lookup
      tags:
        - Credentials
      parameters:
        - name: credentialId
          in: path
          required: true
          schema:
            $ref: '#/components/schemas/CredentialId'
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LookupCredentialResponse'
        '400':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '401':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '403':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '404':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '405':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '409':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '415':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '429':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '500':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
      summary: Lookup Credential
      security:
        - BearerAuth: []
  /v1/integration_points:
    get:
      description: Returns a list of all `IntegrationPoint` objects.
      operationId: integrationPoints_list
      tags:
        - IntegrationPoints
      parameters:
        - name: limit
          in: query
          description: >-
            Number of `IntegrationPoint` objects to return in this page.
            Defaults to 100.
          required: false
          schema:
            type: integer
            nullable: true
        - name: start_after
          in: query
          description: Return `IntegrationPoint` objects starting after this `name`.
          required: false
          schema:
            type: string
            nullable: true
        - name: order
          in: query
          description: >-
            Select a field to order the results by. Defaults to `name`. To
            control the direction of the sorting, append

            `[asc]` or `[desc]` to the field name. For example, `name[desc]`
            will sort the results by `name` in descending order.

            The ordering defaults to `asc` if not specified. May be used
            multiple times to order by multiple fields, and the

            ordering is applied in the order the fields are specified.
          required: false
          schema:
            type: array
            items:
              type: string
              nullable: true
        - name: filter
          in: query
          description: >-
            Filter results by this query. For more information on filtering,
            refer to our Filtering Guide. Defaults to no filter.

            If used more than once, the queries are ANDed together.
          required: false
          schema:
            type: array
            items:
              type: string
              nullable: true
        - name: total
          in: query
          description: >-
            Return total number of integration points in the system, respecting
            all applied filters. This is expensive, use sparingly.
          required: false
          schema:
            type: boolean
            nullable: true
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListIntegrationPointsResponse'
        '400':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '401':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '403':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '404':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '405':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '409':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '415':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '429':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '500':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
      summary: List Integration Points
      security:
        - BearerAuth: []
    post:
      description: Create a `IntegrationPoint` object.
      operationId: integrationPoints_create
      tags:
        - IntegrationPoints
      parameters: []
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateIntegrationPointResponse'
        '400':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '401':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '403':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '404':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '405':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '409':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '415':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '429':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '500':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
      summary: Create Integration Point
      security:
        - BearerAuth: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateIntegrationPointRequest'
  /v1/integration_points/{integrationPointId}:
    get:
      description: Returns the `IntegrationPoint` object matching `{integrationPointId}`.
      operationId: integrationPoints_get
      tags:
        - IntegrationPoints
      parameters:
        - name: integrationPointId
          in: path
          required: true
          schema:
            $ref: '#/components/schemas/IntegrationPointId'
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetIntegrationPointResponse'
        '400':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '401':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '403':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '404':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '405':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '409':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '415':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '429':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '500':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
      summary: Get Integration Point
      security:
        - BearerAuth: []
    put:
      description: Updates the `IntegrationPoint` object matching `{integrationPointId}`.
      operationId: integrationPoints_update
      tags:
        - IntegrationPoints
      parameters:
        - name: integrationPointId
          in: path
          required: true
          schema:
            $ref: '#/components/schemas/IntegrationPointId'
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UpdateIntegrationPointResponse'
        '400':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '401':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '403':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '404':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '405':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '409':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '415':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '429':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '500':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
      summary: Update Integration Point
      security:
        - BearerAuth: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateIntegrationPointRequest'
    patch:
      description: Patches the `IntegrationPoint` object matching `{integrationPointId}`.
      operationId: integrationPoints_patch
      tags:
        - IntegrationPoints
      parameters:
        - name: integrationPointId
          in: path
          required: true
          schema:
            $ref: '#/components/schemas/IntegrationPointId'
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PatchIntegrationPointResponse'
        '400':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '401':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '403':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '404':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '405':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '409':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '415':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '429':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '500':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
      summary: Patch Integration Point
      security:
        - BearerAuth: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: array
              items:
                $ref: '#/components/schemas/PatchOperation'
    delete:
      description: Deletes the `IntegrationPoint` object matching `{integrationPointId}`.
      operationId: integrationPoints_delete
      tags:
        - IntegrationPoints
      parameters:
        - name: integrationPointId
          in: path
          required: true
          schema:
            $ref: '#/components/schemas/IntegrationPointId'
      responses:
        '204':
          description: ''
        '400':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '401':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '403':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '404':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '405':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '409':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '415':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '429':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '500':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
      summary: Delete Integration Point
      security:
        - BearerAuth: []
  /v1/integrations:
    get:
      description: Returns a list of all `Integration` objects that match the query params.
      operationId: integrations_list
      tags:
        - Integrations
      parameters:
        - name: limit
          in: query
          description: >-
            Number of `Integration` objects to return in this page. Defaults to
            100.
          required: false
          schema:
            type: integer
            nullable: true
        - name: start_after
          in: query
          description: Return `Integration` objects starting after this `name`.
          required: false
          schema:
            type: string
            nullable: true
        - name: order
          in: query
          description: >-
            Select a field to order the results by. Defaults to `name`. To
            control the direction of the sorting, append

            `[asc]` or `[desc]` to the field name. For example, `name[desc]`
            will sort the results by `name` in descending order.

            The ordering defaults to `asc` if not specified. May be used
            multiple times to order by multiple fields, and the

            ordering is applied in the order the fields are specified.
          required: false
          schema:
            type: array
            items:
              type: string
              nullable: true
        - name: filter
          in: query
          description: >-
            Filter results by this query. For more information on filtering,
            refer to our Filtering Guide. Defaults to no filter.

            If used more than once, the queries are ANDed together.
          required: false
          schema:
            type: array
            items:
              type: string
              nullable: true
        - name: expand
          in: query
          description: >-
            Expand the integration result with the related integration point
            and/or account information.
          required: false
          schema:
            type: array
            items:
              $ref: '#/components/schemas/ListIntegrationOptions'
              nullable: true
        - name: total
          in: query
          description: >-
            Return total number of all integrations in the system, respecting
            all applied filters. This is expensive, use sparingly.
          required: false
          schema:
            type: boolean
            nullable: true
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListIntegrationsResponse'
        '400':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '401':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '403':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '404':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '405':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '409':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '415':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '429':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '500':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
      summary: List Integrations
      security:
        - BearerAuth: []
  /v1/integrations/{accountId}:
    get:
      description: |-
        Returns a list of all `Integration` objects belonging to the
        `Account` matching `{accountId}`.
      operationId: integrations_list_account
      tags:
        - Integrations
      parameters:
        - name: accountId
          in: path
          required: true
          schema:
            $ref: '#/components/schemas/AccountId'
        - name: limit
          in: query
          description: >-
            Number of `Integration` objects to return in this page. Defaults to
            100.
          required: false
          schema:
            type: integer
            nullable: true
        - name: start_after
          in: query
          description: Return `Integration` objects starting after this `name`.
          required: false
          schema:
            type: string
            nullable: true
        - name: order
          in: query
          description: >-
            Select a field to order the results by. Defaults to `name`. To
            control the direction of the sorting, append

            `[asc]` or `[desc]` to the field name. For example, `name[desc]`
            will sort the results by `name` in descending order.

            The ordering defaults to `asc` if not specified. May be used
            multiple times to order by multiple fields, and the

            ordering is applied in the order the fields are specified.
          required: false
          schema:
            type: array
            items:
              type: string
              nullable: true
        - name: filter
          in: query
          description: >-
            Filter results by this query. For more information on filtering,
            refer to our Filtering Guide. Defaults to no filter.

            If used more than once, the queries are ANDed together.
          required: false
          schema:
            type: array
            items:
              type: string
              nullable: true
        - name: expand
          in: query
          description: >-
            Expand the integration result with the related integration point
            and/or account information.
          required: false
          schema:
            type: array
            items:
              $ref: '#/components/schemas/ListIntegrationOptions'
              nullable: true
        - name: total
          in: query
          description: >-
            Return total number of integrations for a particular account. This
            is expensive, use sparingly.
          required: false
          schema:
            type: boolean
            nullable: true
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListAccountIntegrationsResponse'
        '400':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '401':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '403':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '404':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '405':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '409':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '415':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '429':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '500':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
      summary: List Account Integrations
      security:
        - BearerAuth: []
    post:
      description: >-
        Creates an `Integration` object belonging to the `Account` matching

        `{accountId}`. Configures the `Integration` with the Provider specified

        in the request. Returns an `Integration` token for use with
        `Integration` APIs.
      operationId: integrations_create
      tags:
        - Integrations
      parameters:
        - name: accountId
          in: path
          required: true
          schema:
            $ref: '#/components/schemas/AccountId'
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateIntegrationResponse'
        '400':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '401':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '403':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '404':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '405':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '409':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '415':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '429':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '500':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '501':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '502':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '503':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '504':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
      summary: Create Integration
      security:
        - BearerAuth: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateIntegrationRequest'
  /v1/integrations/{accountId}/{integrationId}:
    get:
      description: |-
        Returns the `Integration` object matching `{integrationId}` where
        the `Integration` belongs to the `Account` matching `{accountId}`.
      operationId: integrations_get
      tags:
        - Integrations
      parameters:
        - name: accountId
          in: path
          required: true
          schema:
            $ref: '#/components/schemas/AccountId'
        - name: integrationId
          in: path
          required: true
          schema:
            $ref: '#/components/schemas/IntegrationId'
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetIntegrationResponse'
        '400':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '401':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '403':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '404':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '405':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '409':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '415':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '429':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '500':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
      summary: Get Integration
      security:
        - BearerAuth: []
    put:
      description: |-
        Updates the `Integration` object matching `{integrationId}`, where the
        `Integration` belongs to the `Account` matching `{accountId}`.
      operationId: integrations_update
      tags:
        - Integrations
      parameters:
        - name: accountId
          in: path
          required: true
          schema:
            $ref: '#/components/schemas/AccountId'
        - name: integrationId
          in: path
          required: true
          schema:
            $ref: '#/components/schemas/IntegrationId'
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UpdateIntegrationResponse'
        '400':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '401':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '403':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '404':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '405':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '409':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '415':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '429':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '500':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
      summary: Update Integration
      security:
        - BearerAuth: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateIntegrationRequest'
    patch:
      description: |-
        Patches the `Integration` object matching `{integrationId}`, where the
        `Integration` belongs to the `Account` matching `{accountId}`.
      operationId: integrations_patch
      tags:
        - Integrations
      parameters:
        - name: accountId
          in: path
          required: true
          schema:
            $ref: '#/components/schemas/AccountId'
        - name: integrationId
          in: path
          required: true
          schema:
            $ref: '#/components/schemas/IntegrationId'
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PatchIntegrationResponse'
        '400':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '401':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '403':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '404':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '405':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '409':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '415':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '429':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '500':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
      summary: Patch Integration
      security:
        - BearerAuth: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: array
              items:
                $ref: '#/components/schemas/PatchOperation'
    delete:
      description: >-
        Deletes the `Integration` object matching `{integrationId}, where the
        `Integration`belongs to the`Account`matching`{accountId}`. Deleting an
        `Integration` also deletes any tokens that belong to it.
      operationId: integrations_delete
      tags:
        - Integrations
      parameters:
        - name: accountId
          in: path
          required: true
          schema:
            $ref: '#/components/schemas/AccountId'
        - name: integrationId
          in: path
          required: true
          schema:
            $ref: '#/components/schemas/IntegrationId'
      responses:
        '204':
          description: ''
        '400':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '401':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '403':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '404':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '405':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '409':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '415':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '429':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '500':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
      summary: Delete Integration
      security:
        - BearerAuth: []
  /v1/integrations/{accountId}/verify:
    post:
      description: >-
        Verifies an ephemeral `Integration` and provider configuration and tests
        the authentication and provider connectivity.

        The provider config credential IDs can utilize persistent IDs or use
        "#/n" reference IDs;

        where (n) is the zero based offset in the optional credentials list.
      operationId: integrations_verify
      tags:
        - Integrations
      parameters:
        - name: accountId
          in: path
          required: true
          schema:
            $ref: '#/components/schemas/AccountId'
      responses:
        '204':
          description: ''
        '400':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '401':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '403':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '404':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '405':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '409':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '415':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '429':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '500':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '501':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '502':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '503':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '504':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
      summary: Verify Integration
      security:
        - BearerAuth: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/VerifyIntegrationRequest'
  /v1/members:
    get:
      description: List all members
      operationId: members_list
      tags:
        - Members
      parameters:
        - name: limit
          in: query
          description: Number of `Member` objects to return in this page. Defaults to 100.
          required: false
          schema:
            type: integer
            nullable: true
        - name: start_after
          in: query
          description: Return `Member` objects starting after this `name`.
          required: false
          schema:
            type: string
            nullable: true
        - name: order
          in: query
          description: >-
            Select a field to order the results by. Defaults to `name`. To
            control the direction of the sorting, append

            `[asc]` or `[desc]` to the field name. For example, `name[desc]`
            will sort the results by `name` in descending order.

            The ordering defaults to `asc` if not specified. May be used
            multiple times to order by multiple fields, and the

            ordering is applied in the order the fields are specified.
          required: false
          schema:
            type: array
            items:
              type: string
              nullable: true
        - name: filter
          in: query
          description: >-
            Filter results by this query. For more information on filtering,
            refer to our Filtering Guide. Defaults to no filter.

            If used more than once, the queries are ANDed together.
          required: false
          schema:
            type: array
            items:
              type: string
              nullable: true
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListMembersResponse'
        '400':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '401':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '403':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '404':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '405':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '409':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '415':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '429':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '500':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
      summary: List Members
      security:
        - BearerAuth: []
    post:
      description: Add a new member for this Organization.
      operationId: members_create
      tags:
        - Members
      parameters: []
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateMemberResponse'
        '400':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '401':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '403':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '404':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '405':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '409':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '415':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '429':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '500':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
      summary: Create Member
      security:
        - BearerAuth: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateMemberRequest'
  /v1/members/{memberId}:
    get:
      description: Retrieve a Member by ID
      operationId: members_get
      tags:
        - Members
      parameters:
        - name: memberId
          in: path
          required: true
          schema:
            $ref: '#/components/schemas/MemberId'
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetMemberResponse'
        '400':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '401':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '403':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '404':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '405':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '409':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '415':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '429':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '500':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
      summary: Get Member
      security:
        - BearerAuth: []
    put:
      description: Update a Member by ID
      operationId: members_update
      tags:
        - Members
      parameters:
        - name: memberId
          in: path
          required: true
          schema:
            $ref: '#/components/schemas/MemberId'
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UpdateMemberResponse'
        '400':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '401':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '403':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '404':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '405':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '409':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '415':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '429':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '500':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
      summary: Update Member
      security:
        - BearerAuth: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateMemberRequest'
    patch:
      description: Update a Member by ID
      operationId: members_patch
      tags:
        - Members
      parameters:
        - name: memberId
          in: path
          required: true
          schema:
            $ref: '#/components/schemas/MemberId'
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PatchMemberResponse'
        '400':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '401':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '403':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '404':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '405':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '409':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '415':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '429':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '500':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
      summary: Patch Member
      security:
        - BearerAuth: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: array
              items:
                $ref: '#/components/schemas/PatchOperation'
    delete:
      description: Delete a Member by ID. Also deletes all Tokens for the Member.
      operationId: members_delete
      tags:
        - Members
      parameters:
        - name: memberId
          in: path
          required: true
          schema:
            $ref: '#/components/schemas/MemberId'
      responses:
        '204':
          description: ''
        '400':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '401':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '403':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '404':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '405':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '409':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '415':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '429':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '500':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
      summary: Delete Member
      security:
        - BearerAuth: []
  /v1/meta/openapi/management:
    get:
      description: Retrieve the OpenAPI spec for the Management API
      operationId: meta_managementOpenapiSpec
      tags:
        - Meta
      parameters: []
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetOpenApiSpecResponse'
        '401':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '403':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '405':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '409':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '415':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '429':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '500':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
      summary: Get Management OpenAPI Spec
      security:
        - BearerAuth: []
  /v1/meta/openapi/engine:
    get:
      description: Retrieve the OpenAPI spec for the Engine APIs
      operationId: meta_engineOpenapiSpec
      tags:
        - Meta
      parameters: []
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetOpenApiSpecResponse'
        '401':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '403':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '405':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '409':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '415':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '429':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '500':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
      summary: Get Engine OpenAPI Spec
      security:
        - BearerAuth: []
  /v1/jobs:
    get:
      description: |-
        {% admonition type="warning" name="In Development" %}
        This operation is actively being developed. Breaking changes should be
        expected.

        Please contact us before using this operation.
        {% /admonition %}
        Returns a list of all `Asynchronous Operations` objects.
      operationId: operations_list
      tags:
        - Operations
      parameters:
        - name: limit
          in: query
          description: >-
            Number of `Asynchronous Operations` objects to return in this page.
            Defaults to 100.
          required: false
          schema:
            type: integer
            nullable: true
        - name: start_after
          in: query
          description: Return `Asynchronous Operations` objects starting after this `name`.
          required: false
          schema:
            type: string
            nullable: true
        - name: order
          in: query
          description: >-
            Select a field to order the results by. Defaults to `id`. To control
            the direction of the sorting, append

            `[asc]` or `[desc]` to the field id. For example, `id[desc]` will
            sort the results by `id` in descending order.

            The ordering defaults to `asc` if not specified. May be used
            multiple times to order by multiple fields, and the

            ordering is applied in the order the fields are specified.
          required: false
          schema:
            type: array
            items:
              type: string
              nullable: true
        - name: filter
          in: query
          description: >-
            Filter results by this query. For more information on filtering,
            refer to our Filtering Guide. Defaults to no filter.

            If used more than once, the queries are ANDed together.
          required: false
          schema:
            type: array
            items:
              type: string
              nullable: true
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListOperationsResponse'
        '400':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '401':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '403':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '404':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '405':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '409':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '415':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '429':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '500':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
      summary: List Asynchronous Operations
      security:
        - BearerAuth: []
      x-badges:
        - name: Alpha
          color: in-development
          position: before
  /v1/organization/webhooks:
    get:
      description: List webhooks for the organization
      operationId: organizationWebhooks_list
      tags:
        - OrganizationWebhooks
      parameters:
        - name: limit
          in: query
          description: Number of `Webhook` objects to return in this page. Defaults to 100.
          required: false
          schema:
            type: integer
            nullable: true
        - name: start_after
          in: query
          description: Return `Webhook` objects starting after this `name`.
          required: false
          schema:
            type: string
            nullable: true
        - name: order
          in: query
          description: >-
            Select a field to order the results by. Defaults to `name`. To
            control the direction of the sorting, append

            `[asc]` or `[desc]` to the field name. For example, `name[desc]`
            will sort the results by `name` in descending order.

            The ordering defaults to `asc` if not specified. May be used
            multiple times to order by multiple fields, and the

            ordering is applied in the order the fields are specified.
          required: false
          schema:
            type: array
            items:
              type: string
              nullable: true
        - name: filter
          in: query
          description: >-
            Filter results by this query. For more information on filtering,
            refer to our Filtering Guide. Defaults to no filter.

            If used more than once, the queries are ANDed together.
          required: false
          schema:
            type: array
            items:
              type: string
              nullable: true
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListOrganizationWebhooksResponse'
        '400':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '401':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '403':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '404':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '405':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '409':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '415':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '429':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '500':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
      summary: List Organization Webhooks
      security:
        - BearerAuth: []
    post:
      description: Create a new webhook for the organization
      operationId: organizationWebhooks_create
      tags:
        - OrganizationWebhooks
      parameters: []
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateOrganizationWebhookResponse'
        '400':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '401':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '403':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '404':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '405':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '409':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '415':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '429':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '500':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
      summary: Create Organization Webhook
      security:
        - BearerAuth: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateOrganizationWebhookRequest'
  /v1/organization/webhooks/{webhookId}:
    get:
      description: Returns the `Webhook` object matching `{webhookId}`.
      operationId: organizationWebhooks_get
      tags:
        - OrganizationWebhooks
      parameters:
        - name: webhookId
          in: path
          required: true
          schema:
            $ref: '#/components/schemas/WebhookId'
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetOrganizationWebhookResponse'
        '400':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '401':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '403':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '404':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '405':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '409':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '415':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '429':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '500':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
      summary: Get Organization Webhook
      security:
        - BearerAuth: []
    put:
      description: >-
        Updates the `Webhook` object matching `{webhookId}`. For more
        information on

        Organizations and Webhooks, refer to our

        [Synqly Overview](https://docs.synqly.com/docs/synqly-overview).
      operationId: organizationWebhooks_update
      tags:
        - OrganizationWebhooks
      parameters:
        - name: webhookId
          in: path
          required: true
          schema:
            $ref: '#/components/schemas/WebhookId'
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UpdateOrganizationWebhookResponse'
        '400':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '401':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '403':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '404':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '405':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '409':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '415':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '429':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '500':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
      summary: Update Organization Webhook
      security:
        - BearerAuth: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateOrganizationWebhookRequest'
    patch:
      description: >-
        Patches the `Webhook` object matching `{webhookId}`. For more
        information on

        Organizations and Webhooks, refer to our

        [Synqly Overview](https://docs.synqly.com/docs/synqly-overview).
      operationId: organizationWebhooks_patch
      tags:
        - OrganizationWebhooks
      parameters:
        - name: webhookId
          in: path
          required: true
          schema:
            $ref: '#/components/schemas/WebhookId'
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PatchOrganizationWebhookResponse'
        '400':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '401':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '403':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '404':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '405':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '409':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '415':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '429':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '500':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
      summary: Patch Organization Webhook
      security:
        - BearerAuth: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: array
              items:
                $ref: '#/components/schemas/PatchOperation'
    delete:
      description: Delete a webhook for the organization
      operationId: organizationWebhooks_delete
      tags:
        - OrganizationWebhooks
      parameters:
        - name: webhookId
          in: path
          required: true
          schema:
            $ref: '#/components/schemas/WebhookId'
      responses:
        '204':
          description: ''
        '400':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '401':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '403':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '404':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '405':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '409':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '415':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '429':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '500':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
      summary: Delete Organization Webhook
      security:
        - BearerAuth: []
  /v1/organization:
    get:
      description: Retrieve Organization
      operationId: organization_get
      tags:
        - Organization
      parameters: []
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetOrganizationResponse'
        '400':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '401':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '403':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '404':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '405':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '409':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '415':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '429':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '500':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
      summary: Get Organization
      security:
        - BearerAuth: []
    put:
      description: Update Organization
      operationId: organization_update
      tags:
        - Organization
      parameters: []
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UpdateOrganizationResponse'
        '400':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '401':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '403':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '404':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '405':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '409':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '415':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '429':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '500':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
      summary: Update Organization
      security:
        - BearerAuth: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateOrganizationRequest'
    patch:
      description: Patch Organization
      operationId: organization_patch
      tags:
        - Organization
      parameters: []
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PatchOrganizationResponse'
        '400':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '401':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '403':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '404':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '405':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '409':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '415':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '429':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '500':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
      summary: Patch Organization
      security:
        - BearerAuth: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: array
              items:
                $ref: '#/components/schemas/PatchOperation'
  /v1/permissionsets:
    get:
      description: >-
        Returns a list of all `PermissionSets` objects that match the query
        params.
      operationId: permissionset_list
      tags:
        - Permissionset
      parameters: []
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListPermissionSetsResponse'
        '400':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '401':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '403':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '404':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '405':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '409':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '415':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '429':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '500':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
      summary: List PermissionSets
      security:
        - BearerAuth: []
  /v1/permissionsets/{permissionsetId}:
    get:
      description: >-
        Returns the `PermissionSet` object matching `{permissionsetId}`. For
        more information on PermissionSets, refer to our

        [Synqly Overview](https://docs.synqly.com/docs/synqly-overview).
      operationId: permissionset_get
      tags:
        - Permissionset
      parameters:
        - name: permissionsetId
          in: path
          required: true
          schema:
            $ref: '#/components/schemas/Permissions'
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetPermissionSetResponse'
        '400':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '401':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '403':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '404':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '405':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '409':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '415':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '429':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '500':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
      summary: Get PermissionSet
      security:
        - BearerAuth: []
  /v1/roles:
    get:
      description: Returns a list of all `Roles` objects that match the query params.
      operationId: roles_list
      tags:
        - Roles
      parameters:
        - name: limit
          in: query
          description: Number of `Role` objects to return in this page. Defaults to 100.
          required: false
          schema:
            type: integer
            nullable: true
        - name: start_after
          in: query
          description: Return `Role` objects starting after this `name`.
          required: false
          schema:
            type: string
            nullable: true
        - name: order
          in: query
          description: >-
            Select a field to order the results by. Defaults to `name`. To
            control the direction of the sorting, append

            `[asc]` or `[desc]` to the field name. For example, `name[desc]`
            will sort the results by `name` in descending order.

            The ordering defaults to `asc` if not specified. May be used
            multiple times to order by multiple fields, and the

            ordering is applied in the order the fields are specified.
          required: false
          schema:
            type: array
            items:
              type: string
              nullable: true
        - name: filter
          in: query
          description: >-
            Filter results by this query. For more information on filtering,
            refer to our Filtering Guide. Defaults to no filter.

            If used more than once, the queries are ANDed together.
          required: false
          schema:
            type: array
            items:
              type: string
              nullable: true
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListRolesResponse'
        '400':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '401':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '403':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '404':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '405':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '409':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '415':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '429':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '500':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
      summary: List Roles
      security:
        - BearerAuth: []
    post:
      description: |-
        Creates an `Role` object. For more information on Roles, refer to our
        [Synqly Overview](https://docs.synqly.com/docs/synqly-overview).
      operationId: roles_create
      tags:
        - Roles
      parameters: []
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateRoleResponse'
        '400':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '401':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '403':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '404':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '405':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '409':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '415':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '429':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '500':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
      summary: Create Role
      security:
        - BearerAuth: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateRoleRequest'
  /v1/roles/{roleId}:
    get:
      description: >-
        Returns the `Role` object matching `{roleId}`. For more information on
        Roles, refer to our

        [Synqly Overview](https://docs.synqly.com/docs/synqly-overview).
      operationId: roles_get
      tags:
        - Roles
      parameters:
        - name: roleId
          in: path
          required: true
          schema:
            $ref: '#/components/schemas/RoleId'
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetRoleResponse'
        '400':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '401':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '403':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '404':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '405':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '409':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '415':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '429':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '500':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
      summary: Get Role
      security:
        - BearerAuth: []
    put:
      description: >-
        Updates the `Role` object matching `{roleId}`. For more information on
        Roles, refer to our

        [Synqly Overview](https://docs.synqly.com/docs/synqly-overview).
      operationId: roles_update
      tags:
        - Roles
      parameters:
        - name: roleId
          in: path
          required: true
          schema:
            $ref: '#/components/schemas/RoleId'
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UpdateRoleResponse'
        '400':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '401':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '403':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '404':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '405':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '409':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '415':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '429':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '500':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
      summary: Update Role
      security:
        - BearerAuth: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateRoleRequest'
    patch:
      description: >-
        Patches the `Role` object matching `{roleId}`. For more information on
        Roles, refer to our

        [Synqly Overview](https://docs.synqly.com/docs/synqly-overview).
      operationId: roles_patch
      tags:
        - Roles
      parameters:
        - name: roleId
          in: path
          required: true
          schema:
            $ref: '#/components/schemas/RoleId'
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PatchRoleResponse'
        '400':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '401':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '403':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '404':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '405':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '409':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '415':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '429':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '500':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
      summary: Patch Role
      security:
        - BearerAuth: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: array
              items:
                $ref: '#/components/schemas/PatchOperation'
    delete:
      description: |-
        Deletes the `Role` matching `{roleId}`. Deleting an `Role` also deletea
        all `Tokens` and `Credentials` belonging to the `Role`.
      operationId: roles_delete
      tags:
        - Roles
      parameters:
        - name: roleId
          in: path
          required: true
          schema:
            $ref: '#/components/schemas/RoleId'
      responses:
        '204':
          description: ''
        '400':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '401':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '403':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '404':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '405':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '409':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '415':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '429':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '500':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
      summary: Delete Role
      security:
        - BearerAuth: []
  /v1/status:
    get:
      description: Returns all matching `Status` objects.
      operationId: status_list
      tags:
        - Status
      parameters:
        - name: limit
          in: query
          description: Number of `Status` objects to return in this page. Defaults to 100.
          required: false
          schema:
            type: integer
            nullable: true
        - name: start_after
          in: query
          description: >-
            Return `Status` objects starting after this
            `account_id,integration_id`.
          required: false
          schema:
            type: string
            nullable: true
        - name: order
          in: query
          description: >-
            Select a field to order the results by. Defaults to
            `account_id,integration_id`. To control the direction of the
            sorting, append

            `[asc]` or `[desc]` to the field name. For example, `name[desc]`
            will sort the results by `name` in descending order.

            The ordering defaults to `asc` if not specified. May be used
            multiple times to order by multiple fields, and the

            ordering is applied in the order the fields are specified.
          required: false
          schema:
            type: array
            items:
              type: string
              nullable: true
        - name: filter
          in: query
          description: >-
            Filter results by this query. For more information on filtering,
            refer to our Filtering Guide. Defaults to no filter.

            If used more than once, the queries are ANDed together.
          required: false
          schema:
            type: array
            items:
              type: string
              nullable: true
        - name: expand
          in: query
          description: >-
            Expand the status result with the related integration and/or account
            information.
          required: false
          schema:
            type: array
            items:
              $ref: '#/components/schemas/ListStatusOptions'
              nullable: true
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListStatusResponse'
        '400':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '401':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '403':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '404':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '405':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '409':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '415':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '429':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '500':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
      summary: List Status
      security:
        - BearerAuth: []
  /v1/status/{accountId}/{integrationId}:
    get:
      description: Returns the integration `Status` object.
      operationId: status_get
      tags:
        - Status
      parameters:
        - name: accountId
          in: path
          required: true
          schema:
            $ref: '#/components/schemas/AccountId'
        - name: integrationId
          in: path
          required: true
          schema:
            $ref: '#/components/schemas/IntegrationId'
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetStatusResponse'
        '400':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '401':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '403':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '404':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '405':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '409':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '415':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '429':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '500':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
      summary: Get Status
      security:
        - BearerAuth: []
    put:
      description: Resets the integration `Status` object.
      operationId: status_reset
      tags:
        - Status
      parameters:
        - name: accountId
          in: path
          required: true
          schema:
            $ref: '#/components/schemas/AccountId'
        - name: integrationId
          in: path
          required: true
          schema:
            $ref: '#/components/schemas/IntegrationId'
      responses:
        '204':
          description: ''
        '400':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '401':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '403':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '404':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '405':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '409':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '415':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '429':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '500':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
      summary: Reset Status
      security:
        - BearerAuth: []
  /v1/status/{accountId}/{integrationId}/events:
    get:
      description: Returns integration `Status` object list of `StatusEvent` objects.
      operationId: status_list_events
      tags:
        - Status
      parameters:
        - name: accountId
          in: path
          required: true
          schema:
            $ref: '#/components/schemas/AccountId'
        - name: integrationId
          in: path
          required: true
          schema:
            $ref: '#/components/schemas/IntegrationId'
        - name: limit
          in: query
          description: >-
            Number of `StatusEvent` objects to return in this page. Defaults to
            100.
          required: false
          schema:
            type: integer
            nullable: true
        - name: start_after
          in: query
          description: Return `StatusEvent` objects starting after this `created_at`.
          required: false
          schema:
            type: string
            nullable: true
        - name: order
          in: query
          description: >-
            The order defaults to created_at[asc] and can changed to descending
            order by specifying created_at[desc].
          required: false
          schema:
            type: string
            nullable: true
        - name: filter
          in: query
          description: >-
            Filter results by this query. For more information on filtering,
            refer to our Filtering Guide. Defaults to no filter.

            If used more than once, the queries are ANDed together.
          required: false
          schema:
            type: array
            items:
              type: string
              nullable: true
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListStatusEventsResponse'
        '400':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '401':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '403':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '404':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '405':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '409':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '415':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '429':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '500':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
      summary: List Status Events
      security:
        - BearerAuth: []
  /v1/status/timeseries:
    get:
      description: Returns organization last hour usage timeseries.
      operationId: status_get_timeseries
      tags:
        - Status
      parameters: []
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetStatusTimeseries'
        '400':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '401':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '403':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '404':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '405':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '409':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '415':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '429':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '500':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
      summary: Get Status Timeseries
      security:
        - BearerAuth: []
  /v1/status/{accountId}/{integrationId}/timeseries:
    get:
      description: Returns organization last hour usage timeseries.
      operationId: status_get_integration_timeseries
      tags:
        - Status
      parameters:
        - name: accountId
          in: path
          required: true
          schema:
            $ref: '#/components/schemas/AccountId'
        - name: integrationId
          in: path
          required: true
          schema:
            $ref: '#/components/schemas/IntegrationId'
        - name: interval
          in: query
          description: '[hour] provide most recent 24 hour timeseries. default: hour'
          required: false
          schema:
            type: string
            nullable: true
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetIntegrationTimeseries'
        '400':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '401':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '403':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '404':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '405':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '409':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '415':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '429':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '500':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
      summary: Get Integration Timeseries
      security:
        - BearerAuth: []
  /v1/suborgs:
    get:
      description: List all organizations
      operationId: subOrgs_list
      tags:
        - SubOrgs
      parameters: []
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListOrganizationResponse'
        '400':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '401':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '403':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '404':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '405':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '409':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '415':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '429':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '500':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
      summary: List Sub-Organizations
      security:
        - BearerAuth: []
    post:
      description: Add a new organization.
      operationId: subOrgs_create
      tags:
        - SubOrgs
      parameters: []
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateOrganizationResponse'
        '400':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '401':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '403':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '404':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '405':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '409':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '415':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '429':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '500':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
      summary: Create Sub-Organization
      security:
        - BearerAuth: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateOrganizationRequest'
  /v1/suborgs/{organizationId}:
    get:
      description: Retrieve an Organization by ID
      operationId: subOrgs_get
      tags:
        - SubOrgs
      parameters:
        - name: organizationId
          in: path
          required: true
          schema:
            $ref: '#/components/schemas/OrganizationId'
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetOrganizationResponse'
        '400':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '401':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '403':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '404':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '405':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '409':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '415':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '429':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '500':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
      summary: Get Sub-Organization
      security:
        - BearerAuth: []
    delete:
      description: Delete a Organization by ID. Also deletes
      operationId: subOrgs_delete
      tags:
        - SubOrgs
      parameters:
        - name: organizationId
          in: path
          required: true
          schema:
            $ref: '#/components/schemas/OrganizationId'
      responses:
        '204':
          description: ''
        '400':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '401':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '403':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '404':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '405':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '409':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '415':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '429':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '500':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
      summary: Delete Sub-Organization
      security:
        - BearerAuth: []
  /v1/tokens:
    post:
      description: >-
        Create an adhoc organization token restricted to specified resources and
        permission set.

        Tokens can only be reduced in scope, never expanded.

        Permissions are inherited from the token used to call this API.

        Permissions assigned to the new token will not be persisted, this is not
        a way to create roles.
      operationId: tokens_create_token
      tags:
        - Tokens
      parameters: []
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateTokenResponse'
        '400':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '401':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '403':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '404':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '405':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '409':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '415':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '429':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '500':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
      summary: Create Organization Token
      security:
        - BearerAuth: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateTokenRequest'
    get:
      description: >-
        Returns a list of all `RefreshToken` objects belonging to the
        Authorization Bearer

        token. For more infromation on Tokens, refer to

        [Authentication](https://docs.synqly.com/reference/authentication).
      operationId: tokens_list
      tags:
        - Tokens
      parameters:
        - name: limit
          in: query
          description: Number of `Token` objects to return in this page. Defaults to 100.
          required: false
          schema:
            type: integer
            nullable: true
        - name: start_after
          in: query
          description: Return `Token` objects starting after this `name`.
          required: false
          schema:
            type: string
            nullable: true
        - name: order
          in: query
          description: >-
            Select a field to order the results by. Defaults to `name`. To
            control the direction of the sorting, append

            `[asc]` or `[desc]` to the field name. For example, `name[desc]`
            will sort the results by `name` in descending order.

            The ordering defaults to `asc` if not specified. May be used
            multiple times to order by multiple fields, and the

            ordering is applied in the order the fields are specified.
          required: false
          schema:
            type: array
            items:
              type: string
              nullable: true
        - name: filter
          in: query
          description: >-
            Filter results by this query. For more information on filtering,
            refer to our Filtering Guide. Defaults to no filter.

            If used more than once, the queries are ANDed together.
          required: false
          schema:
            type: array
            items:
              type: string
              nullable: true
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListTokensResponse'
        '400':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '401':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '403':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '404':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '405':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '409':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '415':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '429':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '500':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
      summary: List Refresh Tokens
      security:
        - BearerAuth: []
  /v1/tokens/{accountId}/{integrationId}:
    post:
      description: >-
        Create an adhoc integration token restricted to a single integration.
        The token used to call

        this API must have the necessary permissions to create tokens and have
        access to the account

        and integration IDs. Permissions may not be escalated, so any operation
        that the invocation

        token does not have access to cannot be granted.
      operationId: tokens_create_integration_token
      tags:
        - Tokens
      parameters:
        - name: accountId
          in: path
          required: true
          schema:
            $ref: '#/components/schemas/AccountId'
        - name: integrationId
          in: path
          required: true
          schema:
            $ref: '#/components/schemas/IntegrationId'
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateIntegrationTokenResponse'
        '400':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '401':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '403':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '404':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '405':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '409':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '415':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '429':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '500':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
      summary: Create Integration Token
      security:
        - BearerAuth: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateIntegrationTokenRequest'
  /v1/tokens/{refreshTokenId}:
    delete:
      description: |-
        Deletes the Refresh Token with id `{id}`. This immediately
        invalidates both the primary and secondary token pairs.
      operationId: tokens_delete
      tags:
        - Tokens
      parameters:
        - name: refreshTokenId
          in: path
          required: true
          schema:
            $ref: '#/components/schemas/TokenId'
      responses:
        '204':
          description: ''
        '400':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '401':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '403':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '404':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '405':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '409':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '415':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '429':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '500':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
      summary: Delete Adhoc Refresh Token
      security:
        - BearerAuth: []
  /v1/tokens/{refreshTokenId}/info:
    get:
      description: >-
        Returns the `RefreshToken` object matching `{tokenId}`. For more
        information on

        Tokens, refer to

        [Authentication](https://docs.synqly.com/reference/authentication).
      operationId: tokens_get
      tags:
        - Tokens
      parameters:
        - name: refreshTokenId
          in: path
          required: true
          schema:
            $ref: '#/components/schemas/TokenId'
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetTokenResponse'
        '400':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '401':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '403':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '404':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '405':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '409':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '415':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '429':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '500':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
      summary: Get Refresh Token
      security:
        - BearerAuth: []
  /v1/tokens/{ownerId}/{refreshTokenId}/reset:
    put:
      description: >-
        This API can be used to reset `Organization` or `Integration`
        `RefreshTokens`.

        Resets the specified `RefreshToken` and expiration time, removes the
        secondary, and resets access and refresh tokens for the

        `RefreshToken` object matching `{ownerId}/{refreshTokenId}` where
        `ownerId` is an `organizationId` or `integrationId`.

        An `Organization` token with `administrator` permissions can be used to
        perform this operation.
      operationId: tokens_reset
      tags:
        - Tokens
      parameters:
        - name: ownerId
          in: path
          required: true
          schema:
            $ref: '#/components/schemas/Id'
        - name: refreshTokenId
          in: path
          required: true
          schema:
            $ref: '#/components/schemas/TokenId'
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResetTokenResponse'
        '400':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '401':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '403':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '404':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '405':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '409':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '415':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '429':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '500':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
      summary: Reset Refresh Token
      security:
        - BearerAuth: []
  /v1/tokens/{refreshTokenId}/refresh:
    put:
      description: >-
        Creates a new primary `TokenPair` object, setting the secondary
        `TokenPair`

        to the previous primary value. Call `/v1/removeSecondaryToken` to remove

        this secondary backup once the new primary `TokenPair` has been
        deployed.
      operationId: tokens_refresh
      tags:
        - Tokens
      parameters:
        - name: refreshTokenId
          in: path
          required: true
          schema:
            $ref: '#/components/schemas/TokenId'
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RefreshTokenResponse'
        '400':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '401':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '403':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '404':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '405':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '409':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '415':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '429':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '500':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
      summary: Refresh Token Pair
      security:
        - BearerAuth: []
  /v1/tokens/{refreshTokenId}/secondary:
    delete:
      description: |-
        Deletes the secondary `TokenPair` for the `RefreshToken` object
        matching `{refreshTokenId}`.
      operationId: tokens_remove_secondary
      tags:
        - Tokens
      parameters:
        - name: refreshTokenId
          in: path
          required: true
          schema:
            $ref: '#/components/schemas/TokenId'
      responses:
        '204':
          description: ''
        '400':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '401':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '403':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '404':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '405':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '409':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '415':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '429':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '500':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
      summary: Remove Secondary Token
      security:
        - BearerAuth: []
  /v1/transforms/{accountId}:
    get:
      description: >-
        Returns a list of all `Transform` objects belonging to the Account
        matching

        `{accountId}`.
      operationId: transforms_list
      tags:
        - Transforms
      parameters:
        - name: accountId
          in: path
          required: true
          schema:
            $ref: '#/components/schemas/AccountId'
        - name: limit
          in: query
          description: >-
            Number of `Transform` objects to return in this page. Defaults to
            100.
          required: false
          schema:
            type: integer
            nullable: true
        - name: start_after
          in: query
          description: Return `Transform` objects starting after this `name`.
          required: false
          schema:
            type: string
            nullable: true
        - name: order
          in: query
          description: >-
            Select a field to order the results by. Defaults to `name`. To
            control the direction of the sorting, append

            `[asc]` or `[desc]` to the field name. For example, `name[desc]`
            will sort the results by `name` in descending order.

            The ordering defaults to `asc` if not specified. May be used
            multiple times to order by multiple fields, and the

            ordering is applied in the order the fields are specified.
          required: false
          schema:
            type: array
            items:
              type: string
              nullable: true
        - name: filter
          in: query
          description: >-
            Filter results by this query. For more information on filtering,
            refer to our Filtering Guide. Defaults to no filter.

            If used more than once, the queries are ANDed together.
          required: false
          schema:
            type: array
            items:
              type: string
              nullable: true
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListTransformsResponse'
        '400':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '401':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '403':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '404':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '405':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '409':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '415':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '429':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '500':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
      summary: List Transforms
      security:
        - BearerAuth: []
    post:
      description: >-
        Create a `Transform` object belonging to the `Account` matching
        `{accountId}`.
      operationId: transforms_create
      tags:
        - Transforms
      parameters:
        - name: accountId
          in: path
          required: true
          schema:
            $ref: '#/components/schemas/AccountId'
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateTransformResponse'
        '400':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '401':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '403':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '404':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '405':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '409':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '415':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '429':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '500':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
      summary: Create Transform
      security:
        - BearerAuth: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateTransformRequest'
  /v1/transforms/{accountId}/{transformId}:
    get:
      description: >-
        Returns the `Transform` object matching `{transformId}` where the
        `Transform`

        belongs to the `Account` matching `{accountId}`.
      operationId: transforms_get
      tags:
        - Transforms
      parameters:
        - name: accountId
          in: path
          required: true
          schema:
            $ref: '#/components/schemas/AccountId'
        - name: transformId
          in: path
          required: true
          schema:
            $ref: '#/components/schemas/TransformId'
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetTransformResponse'
        '400':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '401':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '403':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '404':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '405':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '409':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '415':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '429':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '500':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
      summary: Get Transform
      security:
        - BearerAuth: []
    put:
      description: |-
        Updates the `Transform` object matching `{transformId}`, where the
        `Transform` belongs to the `Account` matching `{accountId}`.
      operationId: transforms_update
      tags:
        - Transforms
      parameters:
        - name: accountId
          in: path
          required: true
          schema:
            $ref: '#/components/schemas/AccountId'
        - name: transformId
          in: path
          required: true
          schema:
            $ref: '#/components/schemas/TransformId'
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UpdateTransformResponse'
        '400':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '401':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '403':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '404':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '405':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '409':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '415':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '429':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '500':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
      summary: Update Transform
      security:
        - BearerAuth: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateTransformRequest'
    patch:
      description: >-
        Patches the `Transform` object matching `{transformId}`, where the
        `Transform`

        belongs to the `Account` matching `{accountId}`.
      operationId: transforms_patch
      tags:
        - Transforms
      parameters:
        - name: accountId
          in: path
          required: true
          schema:
            $ref: '#/components/schemas/AccountId'
        - name: transformId
          in: path
          required: true
          schema:
            $ref: '#/components/schemas/TransformId'
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PatchTransformResponse'
        '400':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '401':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '403':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '404':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '405':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '409':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '415':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '429':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '500':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
      summary: Patch Transform
      security:
        - BearerAuth: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: array
              items:
                $ref: '#/components/schemas/PatchOperation'
    delete:
      description: >-
        Deletes the `Transform` object matching `{transformId}`, where the
        `Transform`

        belongs to the `Account` matching `{accountId}`.
      operationId: transforms_delete
      tags:
        - Transforms
      parameters:
        - name: accountId
          in: path
          required: true
          schema:
            $ref: '#/components/schemas/AccountId'
        - name: transformId
          in: path
          required: true
          schema:
            $ref: '#/components/schemas/TransformId'
      responses:
        '204':
          description: ''
        '400':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '401':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '403':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '404':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '405':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '409':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '415':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '429':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '500':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
      summary: Delete Transform
      security:
        - BearerAuth: []
components:
  schemas:
    AccountId:
      title: AccountId
      $ref: '#/components/schemas/Id'
      description: Unique identifier for this Account
    Account:
      title: Account
      type: object
      properties:
        id:
          $ref: '#/components/schemas/AccountId'
        fullname:
          type: string
          description: Human friendly display name for this account.
        organization_id:
          $ref: '#/components/schemas/OrganizationId'
          description: Organization that manages this Account.
        environment:
          $ref: '#/components/schemas/Environment'
          description: Environment this account runs in.
        labels:
          type: array
          items:
            type: string
          nullable: true
          description: >-
            User defined labels that apply to this account. These values can be
            used in role bindings to limit the scope of permissions.
      required:
        - id
        - fullname
        - organization_id
        - environment
      allOf:
        - $ref: '#/components/schemas/Base'
    ListAccountsResponse:
      title: ListAccountsResponse
      type: object
      properties:
        result:
          type: array
          items:
            $ref: '#/components/schemas/Account'
        total:
          type: integer
          nullable: true
      required:
        - result
    GetAccountResponse:
      title: GetAccountResponse
      type: object
      properties:
        result:
          $ref: '#/components/schemas/Account'
      required:
        - result
    CreateAccountRequest:
      title: CreateAccountRequest
      type: object
      properties:
        name:
          type: string
          nullable: true
          description: >-
            Unique short name for this Account (lowercase [a-z0-9_-], can be
            used in URLs). Also used for case insensitive duplicate name
            detection and default sort order. Defaults to AccountId if both name
            and fullname are not specified.
        fullname:
          type: string
          nullable: true
          description: >-
            Human friendly display name for this Account, will auto-generate
            'name' field (if 'name' is not specified). Defaults to the same
            value as the 'name' field if not specified.
        environment:
          $ref: '#/components/schemas/Environment'
          nullable: true
          description: >-
            Environment this account runs in. Defaults to `prod` if not
            specified.
        labels:
          type: array
          items:
            type: string
          nullable: true
          description: >-
            User defined labels that apply to this account. These values can be
            used in role bindings to limit the scope of permissions.
    CreateAccountResponseResult:
      title: CreateAccountResponseResult
      type: object
      properties:
        account:
          $ref: '#/components/schemas/Account'
      required:
        - account
    CreateAccountResponse:
      title: CreateAccountResponse
      type: object
      properties:
        result:
          $ref: '#/components/schemas/CreateAccountResponseResult'
      required:
        - result
    UpdateAccountRequest:
      title: UpdateAccountRequest
      $ref: '#/components/schemas/Account'
    UpdateAccountResponse:
      title: UpdateAccountResponse
      type: object
      properties:
        result:
          $ref: '#/components/schemas/Account'
      required:
        - result
    PatchAccountResponse:
      title: PatchAccountResponse
      type: object
      properties:
        result:
          $ref: '#/components/schemas/Account'
      required:
        - result
    AuditType:
      title: AuditType
      type: string
      enum:
        - ALARM
        - ERROR
        - API
        - UNKNOWN
    HTTPMethod:
      title: HTTPMethod
      type: string
      enum:
        - DELETE
        - GET
        - PATCH
        - POST
        - PUT
    Audit:
      title: Audit
      type: object
      properties:
        environment:
          type: string
        created_at:
          type: string
          format: date-time
          description: Time when the API request occurred.
        remote_addr:
          type: string
        user_agent:
          type: string
        audit_type:
          $ref: '#/components/schemas/AuditType'
        method:
          $ref: '#/components/schemas/HTTPMethod'
        path:
          type: string
        code:
          type: string
        body:
          nullable: true
        response:
          type: string
          nullable: true
        status:
          type: string
          nullable: true
        member_id:
          $ref: '#/components/schemas/MemberId'
          nullable: true
        account_id:
          $ref: '#/components/schemas/AccountId'
          nullable: true
        integration_id:
          $ref: '#/components/schemas/IntegrationId'
          nullable: true
        bridge_group_id:
          $ref: '#/components/schemas/BridgeGroupId'
          nullable: true
      required:
        - environment
        - created_at
        - remote_addr
        - user_agent
        - audit_type
        - method
        - path
        - code
    ListAuditEventsResponse:
      title: ListAuditEventsResponse
      type: object
      properties:
        result:
          type: array
          items:
            $ref: '#/components/schemas/Audit'
      required:
        - result
    AuthCode:
      title: AuthCode
      type: string
      enum:
        - success
        - failure
        - disabled
        - expired
        - invited
        - locked
    LogonRequest:
      title: LogonRequest
      type: object
      properties:
        name:
          type: string
          description: Email address identifying the member to initiate a session for.
        secret:
          type: string
          description: Password of the member to initiate a session for.
      required:
        - name
        - secret
    LogonResponseResult:
      title: LogonResponseResult
      type: object
      properties:
        auth_code:
          $ref: '#/components/schemas/AuthCode'
          description: Authentication result
        auth_msg:
          type: string
          nullable: true
          description: Authentication failure message
        refresh_token_id:
          $ref: '#/components/schemas/TokenId'
        token:
          $ref: '#/components/schemas/TokenPair'
        organization:
          $ref: '#/components/schemas/Organization'
        member:
          $ref: '#/components/schemas/Member'
      required:
        - auth_code
        - refresh_token_id
        - token
        - organization
        - member
    LogonResponse:
      title: LogonResponse
      type: object
      properties:
        result:
          $ref: '#/components/schemas/LogonResponseResult'
      required:
        - result
    ChangePasswordResponseResult:
      title: ChangePasswordResponseResult
      type: object
      properties:
        auth_code:
          $ref: '#/components/schemas/AuthCode'
          description: Authentication result
        auth_msg:
          type: string
          nullable: true
          description: Authentication failure message
      required:
        - auth_code
    ChangePasswordResponse:
      title: ChangePasswordResponse
      type: object
      properties:
        result:
          $ref: '#/components/schemas/ChangePasswordResponseResult'
      required:
        - result
    ChangePasswordRequest:
      title: ChangePasswordRequest
      type: object
      properties:
        old_secret:
          type: string
          description: Old member secret
        new_secret:
          type: string
          description: New member secret
      required:
        - old_secret
        - new_secret
    BridgeGroupId:
      title: BridgeGroupId
      $ref: '#/components/schemas/Id'
      description: Unique identifier for this Bridge Group.
    BridgeGroup:
      title: BridgeGroup
      type: object
      description: >-
        A Bridge Group represents a connection between the Synqly Saas or
        Embedded service and a Bridge Agent. See 'Synqly Bridge Agent' guide in
        Synqly docs for additional information.
      properties:
        id:
          $ref: '#/components/schemas/BridgeGroupId'
        fullname:
          type: string
          description: Full name of bridge
        description:
          type: string
          nullable: true
          description: >-
            Description of the resources included in the bridge and permissions
            granted on those resources. Includes details of when to use this
            bridge along with the intended personas.
        labels:
          type: array
          items:
            type: string
          nullable: true
          description: >-
            Labels applied to Bridges within the group. These labels can be used
            by integrations to select the groups of bridges capable of handling
            requests to the integration.
      required:
        - id
        - fullname
      allOf:
        - $ref: '#/components/schemas/Base'
    ListBridgesResponse:
      title: ListBridgesResponse
      type: object
      properties:
        result:
          type: array
          items:
            $ref: '#/components/schemas/BridgeGroup'
      required:
        - result
    GetBridgeResponse:
      title: GetBridgeResponse
      type: object
      properties:
        result:
          $ref: '#/components/schemas/BridgeGroup'
      required:
        - result
    GetBridgeStatusResponse:
      title: GetBridgeStatusResponse
      type: object
      properties:
        result:
          type: array
          items:
            $ref: '#/components/schemas/BridgeStatus'
      required:
        - result
    CreateBridgeRequest:
      title: CreateBridgeRequest
      type: object
      properties:
        name:
          type: string
          nullable: true
          description: >-
            Unique short name for this Bridge (lowercase [a-z0-9_-], can be used
            in URLs). Also used for case insensitive duplicate name detection
            and default sort order. Defaults to BridgeGroupId if both name and
            fullname are not specified.
        fullname:
          type: string
          nullable: true
          description: >-
            Human friendly display name for this Bridge, will auto-generate
            'name' field (if 'name' is not specified). Defaults to the same
            value as the 'name' field if not specified.
        description:
          type: string
          nullable: true
          description: >-
            Description of the resources included in the bridge and permissions
            granted on those resources. Includes details of when to use this
            bridge along with the intended personas.
        labels:
          type: array
          items:
            type: string
          nullable: true
          description: Bridge selection labels
    CreateBridgeResponseResult:
      title: CreateBridgeResponseResult
      type: object
      properties:
        bridge:
          $ref: '#/components/schemas/BridgeGroup'
        credential:
          type: string
          description: >-
            JWT for the Bridge Group to connect to Synqly. This must be saved in
            a file {bridgeId}.creds in the same directory as the bridge
            executable.
      required:
        - bridge
        - credential
    CreateBridgeResponse:
      title: CreateBridgeResponse
      type: object
      properties:
        result:
          $ref: '#/components/schemas/CreateBridgeResponseResult'
      required:
        - result
    UpdateBridgeRequest:
      title: UpdateBridgeRequest
      $ref: '#/components/schemas/BridgeGroup'
    UpdateBridgeResponse:
      title: UpdateBridgeResponse
      type: object
      properties:
        result:
          $ref: '#/components/schemas/BridgeGroup'
      required:
        - result
    PatchBridgeResponse:
      title: PatchBridgeResponse
      type: object
      properties:
        result:
          $ref: '#/components/schemas/BridgeGroup'
      required:
        - result
    BridgeStatus:
      title: BridgeStatus
      type: object
      properties:
        current_time:
          type: string
          format: date-time
          description: Local time on the Bridge when the status check was performed.
        response_duration:
          type: string
          description: Round trip time for the status check.
        local_config:
          $ref: '#/components/schemas/BridgeLocalConfig'
          description: Local configuration parameters for the Bridge.
        local_stats:
          $ref: '#/components/schemas/BridgeLocalStats'
          description: Local bridge statistics
      required:
        - current_time
        - response_duration
        - local_config
        - local_stats
    BridgeLocalConfig:
      title: BridgeLocalConfig
      type: object
      properties:
        version:
          type: string
          description: Version of the Bridge.
        allow_addresses:
          type: array
          items:
            type: string
          description: List of IP addresses that the Bridge is allowed to connect to.
        vault:
          type: object
          additionalProperties:
            type: string
          nullable: true
          description: Vault configuration for the Bridge.
      required:
        - version
        - allow_addresses
    BridgeLocalStats:
      title: BridgeLocalStats
      type: object
      properties:
        requests:
          type: integer
          format: int64
        failures:
          type: integer
          format: int64
        in_bytes:
          type: integer
          format: int64
        out_bytes:
          type: integer
          format: int64
      required:
        - requests
        - failures
        - in_bytes
        - out_bytes
    ProviderId:
      title: ProviderId
      type: string
    CategoryId:
      title: CategoryId
      type: string
      enum:
        - assets
        - edr
        - identity
        - notifications
        - siem
        - sink
        - storage
        - ticketing
        - vulnerabilities
      description: Id of the Integrations category
    ProviderCapabilities:
      title: ProviderCapabilities
      type: object
      properties:
        id:
          $ref: '#/components/schemas/ProviderId'
          description: Unique identifier for the Provider.
        name:
          type: string
          description: Name of the Provider.
        fullname:
          type: string
          description: Display name of the Provider.
        description:
          type: string
          description: Description of the Provider.
        connector_id:
          $ref: '#/components/schemas/CategoryId'
          description: Id of the Connector that the Provider implements.
        connector:
          $ref: '#/components/schemas/ConnectorOrId'
          nullable: true
          description: |-
            Id of the Connector that the Provider implements – or, if
            `expand=connector` is set – the details of the Connector. NOTE:
            The current default behavior is to return the ID of the
            Connector. This field will soon only be populated when
            `expand=connector` is set in the APIs that support it. It is
            recommended you use `connector_id` for a stable reference to the
            Connector ID. This field will soon only be populated when
            `expand=connector` is set in the APIs that support it.
        operations:
          type: array
          items:
            $ref: '#/components/schemas/ProviderOperations'
          nullable: true
          description: Operations that the Provider implements.
        provider_config:
          nullable: true
          description: Details on the specific configuration options for the Provider.
        release:
          $ref: '#/components/schemas/ProviderRelease'
          nullable: true
          description: Provider availability inforamtion.
      required:
        - id
        - name
        - fullname
        - description
        - connector_id
    ProviderRelease:
      title: ProviderRelease
      type: object
      properties:
        availability:
          $ref: '#/components/schemas/ProviderAvailability'
          description: Availability status.
        environments:
          type: array
          items:
            $ref: '#/components/schemas/ProviderEnvironment'
          description: Environments the Provider is available to.
      required:
        - availability
        - environments
    ProviderAvailability:
      title: ProviderAvailability
      type: string
      enum:
        - in-development
        - pre-release
        - deprecated
        - generally-available
    ProviderEnvironment:
      title: ProviderEnvironment
      type: string
      enum:
        - prod
        - test
    ConnectorOrId:
      title: ConnectorOrId
      oneOf:
        - $ref: '#/components/schemas/CategoryId'
        - $ref: '#/components/schemas/Connector'
    Connector:
      title: Connector
      type: object
      description: Provides details of the Connector.
      properties:
        id:
          $ref: '#/components/schemas/CategoryId'
          description: Unique identifier for the Connector.
        name:
          $ref: '#/components/schemas/CategoryId'
          description: Name of the connector.
        fullname:
          type: string
          description: Display name of the Connector.
        description:
          type: string
          description: Description of the Connector.
        provider_ids:
          type: array
          items:
            $ref: '#/components/schemas/ProviderId'
          description: List of Providers that implement the Connector.
        providers:
          type: array
          items:
            $ref: '#/components/schemas/ProviderCapabilities'
          nullable: true
          description: List of capabilities for Providers that implement the Connector.
        connector:
          $ref: '#/components/schemas/CategoryId'
          nullable: true
          description: DEPRECATED – use `id` instead.
      required:
        - id
        - name
        - fullname
        - description
        - provider_ids
    ProviderOperations:
      title: ProviderOperations
      type: object
      properties:
        id:
          type: string
          description: Unique identifier for the operation.
        name:
          type: string
          description: Name of the operation.
        fullname:
          type: string
          nullable: true
          description: Display name of the operation.
        description:
          type: string
          nullable: true
          description: Description of the operation.
        request_method:
          type: string
          nullable: true
          description: HTTP method used for the operation.
        request_path:
          type: string
          nullable: true
          description: URI template path for the operation, including path parameters.
        supported:
          type: boolean
          description: Whether the operation is supported by the provider.
        required_fields:
          type: array
          items:
            type: string
          nullable: true
          description: |-
            List of fields in the request body that are required by the
            provider for this operation. Due to limitations of the OpenAPI
            format these fields may be marked as optional, even though they
            are in fact required by this provider.
        supported_response_fields:
          type: array
          items:
            type: string
          nullable: true
          description: |-
            List of fields that may be returned in the response body. Any
            fields not listed in this array are not supported by this
            provider and will not be returned in the response body.
        filters:
          type: array
          items:
            $ref: '#/components/schemas/ProviderFilter'
          nullable: true
          description: Filters that can be applied to this operation.
        request_body:
          $ref: '#/components/schemas/RequestBody'
          nullable: true
          description: |-
            This field is only available if the operation supports a request
            body. Describes the request body and its schema.
      required:
        - id
        - name
        - supported
    RequestBody:
      title: RequestBody
      type: object
      description: Describes the request body and its schema.
      properties:
        required:
          type: boolean
          description: If true the request body is required, false otherwise.
        schema:
          type: object
          additionalProperties: true
          description: |-
            The schema defining the type used for the request body. If
            expanded will be a full JSON schema of the entire request body,
            otherwise this will be a reference object. The reference object
            has a single key `$ref`, which is a URI [RFC3986] identifying the
            location of a component within the Engine OpenAPI specification.
      required:
        - required
        - schema
    ProviderFilter:
      title: ProviderFilter
      type: object
      properties:
        name:
          type: string
          description: Name of the filter.
        type:
          $ref: '#/components/schemas/FilterType'
          description: Type of the value that this filter can apply to
        operators:
          type: array
          items:
            type: string
          description: List of operators that this filter supports.
        values:
          type: array
          items:
            type: string
          nullable: true
          description: List of possible values for this filter.
      required:
        - name
        - type
        - operators
    FilterType:
      title: FilterType
      type: string
      enum:
        - string
        - datetime
        - enum
        - boolean
        - number
    FilterOperation:
      title: FilterOperation
      type: string
      enum:
        - eq
        - neq
        - gt
        - lt
        - gte
        - lte
        - in
        - like
        - not in
        - not like
    ListConnectorsCapabilitiesResponse:
      title: ListConnectorsCapabilitiesResponse
      type: object
      properties:
        result:
          type: array
          items:
            $ref: '#/components/schemas/Connector'
      required:
        - result
    ListProvidersCapabilitiesResponse:
      title: ListProvidersCapabilitiesResponse
      type: object
      properties:
        result:
          type: array
          items:
            $ref: '#/components/schemas/ProviderCapabilities'
      required:
        - result
    ProviderCapabilitiesResponse:
      title: ProviderCapabilitiesResponse
      type: object
      properties:
        result:
          $ref: '#/components/schemas/ProviderCapabilities'
      required:
        - result
    ListConnectorCapabilitiesExpandOptions:
      title: ListConnectorCapabilitiesExpandOptions
      type: string
      enum:
        - providers
    ListProviderCapabilitiesExpandOptions:
      title: ListProviderCapabilitiesExpandOptions
      type: string
      enum:
        - connector
        - operations
        - provider_config
    GetProviderCapabilitiesExpandOptions:
      title: GetProviderCapabilitiesExpandOptions
      type: string
      enum:
        - connector
        - operations
        - request_body
        - provider_config
    Id:
      title: Id
      type: string
    Base:
      title: Base
      type: object
      properties:
        name:
          type: string
          description: Human-readable name for this resource
        created_at:
          type: string
          format: date-time
          description: Time object was originally created
        updated_at:
          type: string
          format: date-time
          description: Last time object was updated
      required:
        - name
        - created_at
        - updated_at
    Problem:
      title: Problem
      type: object
      description: >-
        Generic base type for problems in Synqly. This object carries both
        machine-readable data as well as information intended for display
        purposes.
      properties:
        type:
          $ref: '#/components/schemas/ProblemType'
          nullable: true
        occurred_at:
          type: string
          format: date-time
          description: The date and time the problem occurred.
        status:
          type: integer
          description: >-
            The HTTP status code of the problem. Matches the HTTP response code
            sent by the server.
        instance:
          type: string
          description: >-
            A URI reference that identifies the specific occurrence of the
            problem. It may or may not yield further information if
            dereferenced.
        cause:
          type: array
          items:
            $ref: '#/components/schemas/ProblemCause'
          nullable: true
          description: >-
            A list of the root cause(s) for this problem occurrence. Includes at
            minimum one root cause, and is otherwise an unordered list of
            causes.
      required:
        - occurred_at
        - status
        - instance
      allOf:
        - $ref: '#/components/schemas/ProblemDetails'
    ProblemCause:
      title: ProblemCause
      type: object
      properties:
        type:
          $ref: '#/components/schemas/ProblemType'
      required:
        - type
      allOf:
        - $ref: '#/components/schemas/ProblemDetails'
    ProblemType:
      title: ProblemType
      type: string
      description: >-
        A URI reference that identifies the type of problem that occurred. When
        the URI scheme is HTTP(s), it may or may not be possible to deference
        the URL to a display-friendly description of the problem type.
    ProblemDetails:
      title: ProblemDetails
      type: object
      properties:
        message:
          type: string
          description: A short, display-friendly summary of the problem.
        detail:
          type: string
          nullable: true
          description: >-
            A display-friendly and more detailed explanation of the problem. It
            may offer additional contextual detail, but may also be just a
            generic description of the problem.
        remediation:
          type: string
          nullable: true
          description: >-
            A display-friendly explanation for how to remediate the problem.
            This field may be omitted in case there are multiple problems, each
            with its own remediation, or if no remediation is possible.
        context:
          $ref: '#/components/schemas/ProblemContext'
          nullable: true
          description: >-
            Additional context providing further detail about the problem, such
            as a problematic input parameter and/or a list of related resources.
      required:
        - message
    ProblemContext:
      title: ProblemContext
      type: object
      properties:
        parameter:
          $ref: '#/components/schemas/ProblematicParameter'
          nullable: true
          description: >-
            If the problem is related to a `query`, `header`, `path` or `body`
            parameter, this field will describe the problematic parameter and
            where to find it.
        resources:
          type: array
          items:
            $ref: '#/components/schemas/ResourceReference'
          nullable: true
        raw_error:
          type: string
          nullable: true
          description: >-
            If available this represents the underlying raw error, for example
            an error response from a Provider.
    ProblematicParameter:
      title: ProblematicParameter
      type: object
      properties:
        id:
          type: string
          description: >-
            If the `location` of the parameter is `body`, this value is always a
            JSON Pointer, otherwise it's the name of the parameter.
        location:
          $ref: '#/components/schemas/ParameterLocation'
          description: >-
            The location of the parameter. Possible values are `query`,
            `header`, `path` or `body`.
        value:
          nullable: true
          description: The given value of the parameter.
      required:
        - id
        - location
    ParameterLocation:
      title: ParameterLocation
      type: string
      enum:
        - header
        - path
        - query
        - body
    ResourceReference:
      title: ResourceReference
      type: object
      properties:
        type:
          $ref: '#/components/schemas/ResourceType'
          description: Type of the related resource.
        id:
          type: string
          description: ID of the related resource.
        rel:
          $ref: '#/components/schemas/ProblemRelation'
          description: The way in which the resource relates to the problem.
      required:
        - type
        - id
        - rel
    ProblemRelation:
      title: ProblemRelation
      type: string
      enum:
        - affected
        - cause
    ResourceType:
      title: ResourceType
      type: string
      enum:
        - account
        - bridge
        - credential
        - integration_point
        - integration
        - member
        - operation
        - organization_webhook
        - role
        - sub_org
        - token
        - transform
    PatchOp:
      title: PatchOp
      type: string
      enum:
        - add
        - copy
        - move
        - remove
        - replace
        - test
    PatchOperation:
      title: PatchOperation
      type: object
      description: >-
        JSON patch to apply. A JSON patch is a list of patch operations. (see
        https://jsonpatch.com/)
      properties:
        op:
          $ref: '#/components/schemas/PatchOp'
          description: >-
            The operation to perform. Supported values are `add`, `copy`,
            `move`, `replace`, `remove`, and `test`.
        path:
          type: string
          description: The path to the field to update. The path is a JSON Pointer.
        from:
          type: string
          nullable: true
          description: >-
            The path to the field to copy from. This is required for `copy` and
            `move` operations.
        value:
          nullable: true
          description: >-
            The value to set the field to. This is required for `add`, `replace`
            and `test` operations.
      required:
        - op
        - path
    ResourceId:
      title: ResourceId
      type: string
      enum:
        - devices
        - events
        - investigations
        - log_providers
        - evidence
    ActionId:
      title: ActionId
      type: string
      enum:
        - query
        - read
        - create
        - update
        - delete
        - patch
    CredentialId:
      title: CredentialId
      $ref: '#/components/schemas/Id'
      description: Unique identifier for this Credential
    OwnerType:
      title: OwnerType
      type: string
      enum:
        - account
        - integration
        - integration_point
        - organization_webhook
    ManagedType:
      title: ManagedType
      type: string
      enum:
        - Managed
        - Unmanaged
    Credential:
      title: Credential
      type: object
      description: >-
        Credential to access an integration. Each credential is owned by an
        Account, Integration, IntegrationPoint or OrganizationWebhook.
      properties:
        id:
          $ref: '#/components/schemas/CredentialId'
        account_id:
          $ref: '#/components/schemas/AccountId'
          nullable: true
          description: Account that manages this credential.
        integration_id:
          $ref: '#/components/schemas/IntegrationId'
          nullable: true
          description: Integration associated with this credential.
        integration_point_id:
          $ref: '#/components/schemas/IntegrationPointId'
          nullable: true
          description: Integration Point associated with this credential.
        organization_webhook_id:
          $ref: '#/components/schemas/WebhookId'
          nullable: true
          description: Organization Webhook associated with this credential.
        owner_type:
          $ref: '#/components/schemas/OwnerType'
          description: One of `account` or `integration_point`.
        fullname:
          type: string
          description: Human friendly display name for this Credential
        config:
          $ref: '#/components/schemas/CredentialConfig'
          nullable: true
          description: Credential configuration
        expires:
          type: string
          format: date-time
          nullable: true
          description: Time when this credential expires and can no longer be used again.
        managed:
          $ref: '#/components/schemas/ManagedType'
          description: >-
            Field is set by the management process. Determines lifecycle and
            ownership of the credential.
      required:
        - id
        - owner_type
        - fullname
        - managed
      allOf:
        - $ref: '#/components/schemas/Base'
    CredentialResponse:
      title: CredentialResponse
      type: object
      description: Response object for a Credential
      properties:
        id:
          $ref: '#/components/schemas/CredentialId'
        account_id:
          $ref: '#/components/schemas/AccountId'
          nullable: true
          description: Account that manages this credential.
        integration_id:
          $ref: '#/components/schemas/IntegrationId'
          nullable: true
          description: Integration associated with this credential.
        integration_point_id:
          $ref: '#/components/schemas/IntegrationPointId'
          nullable: true
          description: Integration Point associated with this credential.
        organization_webhook_id:
          $ref: '#/components/schemas/WebhookId'
          nullable: true
          description: Integration Point associated with this credential.
        owner_type:
          $ref: '#/components/schemas/OwnerType'
          description: One of `account` or `integration_point`.
        fullname:
          type: string
          description: >-
            Human friendly display name for this Credential. Defaults to the
            same value as the 'name' field if not specified.
        config:
          $ref: '#/components/schemas/CredentialConfigNoSecret'
        expires:
          type: string
          format: date-time
          nullable: true
          description: Time when this credential expires and can no longer be used again.
        managed:
          $ref: '#/components/schemas/ManagedType'
          description: >-
            Field is set by the management process. Determines lifecycle and
            ownership of the credential.
      required:
        - id
        - owner_type
        - fullname
        - config
        - managed
      allOf:
        - $ref: '#/components/schemas/Base'
    CredentialConfigNoSecret:
      title: CredentialConfigNoSecret
      type: object
      properties:
        type:
          type: string
      required:
        - type
    CredentialType:
      title: CredentialType
      type: string
      enum:
        - aws
        - token
        - basic
        - secret
        - o_auth_client
        - bridge
    BridgeType:
      title: BridgeType
      type: string
      enum:
        - bridge_aws
        - bridge_aws_id
        - bridge_token
        - bridge_token_id
        - bridge_basic
        - bridge_basic_id
        - bridge_secret
        - bridge_secret_id
        - bridge_o_auth_client
        - bridge_o_auth_client_id
    LocalType:
      title: LocalType
      type: string
      enum:
        - literal
        - environment
        - vault
    AwsCredentialId:
      title: AwsCredentialId
      $ref: '#/components/schemas/CredentialId'
      description: Unique identifier for an AWS Credential
    BasicCredentialId:
      title: BasicCredentialId
      $ref: '#/components/schemas/CredentialId'
      description: Unique identifier for a basic auth Credential
    TokenCredentialId:
      title: TokenCredentialId
      $ref: '#/components/schemas/CredentialId'
      description: Unique identifier for a token Credential
    SecretCredentialId:
      title: SecretCredentialId
      $ref: '#/components/schemas/CredentialId'
      description: Unique identifier for a secret Credential
    OAuthClientCredentialId:
      title: OAuthClientCredentialId
      $ref: '#/components/schemas/CredentialId'
      description: Unique identifier for an OAuth client Credential
    BridgeBasicCredentialId:
      title: BridgeBasicCredentialId
      $ref: '#/components/schemas/CredentialId'
      description: Unique identifier for a bridge basic auth Credential
    BridgeTokenCredentialId:
      title: BridgeTokenCredentialId
      $ref: '#/components/schemas/CredentialId'
      description: Unique identifier for a bridge token Credential
    BridgeSecretCredentialId:
      title: BridgeSecretCredentialId
      $ref: '#/components/schemas/CredentialId'
      description: Unique identifier for an bridge secret Credential
    BridgeOAuthClientCredentialId:
      title: BridgeOAuthClientCredentialId
      $ref: '#/components/schemas/CredentialId'
      description: Unique identifier for an bridge OAuth client Credential
    CredentialConfig:
      title: CredentialConfig
      oneOf:
        - type: object
          allOf:
            - type: object
              properties:
                type:
                  type: string
                  enum:
                    - aws
            - $ref: '#/components/schemas/AwsCredential'
          required:
            - type
        - type: object
          allOf:
            - type: object
              properties:
                type:
                  type: string
                  enum:
                    - token
            - $ref: '#/components/schemas/TokenCredential'
          required:
            - type
        - type: object
          allOf:
            - type: object
              properties:
                type:
                  type: string
                  enum:
                    - basic
            - $ref: '#/components/schemas/BasicCredential'
          required:
            - type
        - type: object
          allOf:
            - type: object
              properties:
                type:
                  type: string
                  enum:
                    - secret
            - $ref: '#/components/schemas/SecretCredential'
          required:
            - type
        - type: object
          allOf:
            - type: object
              properties:
                type:
                  type: string
                  enum:
                    - o_auth_client
            - $ref: '#/components/schemas/OAuthClientCredential'
          required:
            - type
        - type: object
          properties:
            type:
              type: string
              enum:
                - bridge
            value:
              $ref: '#/components/schemas/BridgeCredential'
          required:
            - type
    BridgeCredential:
      title: BridgeCredential
      oneOf:
        - type: object
          allOf:
            - type: object
              properties:
                type:
                  type: string
                  enum:
                    - bridge_aws
            - $ref: '#/components/schemas/BridgeAwsCredential'
          required:
            - type
        - type: object
          allOf:
            - type: object
              properties:
                type:
                  type: string
                  enum:
                    - bridge_token
            - $ref: '#/components/schemas/BridgeTokenCredential'
          required:
            - type
        - type: object
          allOf:
            - type: object
              properties:
                type:
                  type: string
                  enum:
                    - bridge_basic
            - $ref: '#/components/schemas/BridgeBasicCredential'
          required:
            - type
        - type: object
          allOf:
            - type: object
              properties:
                type:
                  type: string
                  enum:
                    - bridge_secret
            - $ref: '#/components/schemas/BridgeSecretCredential'
          required:
            - type
        - type: object
          allOf:
            - type: object
              properties:
                type:
                  type: string
                  enum:
                    - bridge_o_auth_client
            - $ref: '#/components/schemas/BridgeOAuthClientCredential'
          required:
            - type
    CredentialBase:
      title: CredentialBase
      type: object
      description: Base type for all credential types
      properties: {}
    AwsCredential:
      title: AwsCredential
      type: object
      description: >-
        AWS access key to authenticate with AWS. Access keys are long-term
        credentials for an IAM user and consist of an ID and secret. Follow
        [this guide to generate access and secret
        keys](https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys).
        You may optionally provide a session token if you are using temporary
        credentials.
      properties:
        access_key_id:
          type: string
          description: ID portion of the AWS access key pair.
        secret_access_key:
          type: string
          description: Secret portion of the AWS access key pair.
        session:
          type: string
          nullable: true
          description: >-
            A temporary session token. Session tokens are optional and are only
            necessary if you are using temporary credentials.
      required:
        - access_key_id
        - secret_access_key
      allOf:
        - $ref: '#/components/schemas/CredentialBase'
    TokenCredential:
      title: TokenCredential
      type: object
      description: Token used to authenticate with an external service.
      properties:
        secret:
          type: string
          description: Secret value of the token.
      required:
        - secret
      allOf:
        - $ref: '#/components/schemas/CredentialBase'
    BasicCredential:
      title: BasicCredential
      type: object
      description: Username and secret used to authenticate with an external service.
      properties:
        username:
          type: string
          description: Username value for authentication
        secret:
          type: string
          description: Secret value for authentication
      required:
        - username
        - secret
      allOf:
        - $ref: '#/components/schemas/CredentialBase'
    SecretCredential:
      title: SecretCredential
      type: object
      description: Secret value such as password or webhook url
      properties:
        secret:
          type: string
          description: Secret value
      required:
        - secret
      allOf:
        - $ref: '#/components/schemas/CredentialBase'
    OAuthClientCredential:
      title: OAuthClientCredential
      type: object
      description: >-
        A Client ID and secret used for authenticating with OAuth 2.0 compatible
        service using the client credentials grant.
      properties:
        token_url:
          type: string
          nullable: true
          description: >-
            Optional URL for the OAuth 2.0 token exchange if it can not be
            constructed based on provider configuration
        client_id:
          type: string
          description: The ID of the client application defined at the service provider
        client_secret:
          type: string
          description: Secret value for authentication
        extra:
          type: object
          additionalProperties: true
          nullable: true
          description: >-
            Optional connection specific JSON map data such as a signing key ID
            or organization ID
      required:
        - client_id
        - client_secret
      allOf:
        - $ref: '#/components/schemas/CredentialBase'
    BridgeLiteral:
      title: BridgeLiteral
      type: object
      properties:
        value:
          type: string
          description: literal value to use
      required:
        - value
    BridgeEnvironment:
      title: BridgeEnvironment
      type: object
      properties:
        key:
          type: string
          description: system environment variable to retrieve value from.
      required:
        - key
    VaultCredential:
      title: VaultCredential
      type: object
      properties:
        path:
          type: string
          description: path (including item) to secret store in vault secret storage.
      required:
        - path
    BridgeLocalCredential:
      title: BridgeLocalCredential
      oneOf:
        - type: object
          allOf:
            - type: object
              properties:
                type:
                  type: string
                  enum:
                    - literal
            - $ref: '#/components/schemas/BridgeLiteral'
          required:
            - type
        - type: object
          allOf:
            - type: object
              properties:
                type:
                  type: string
                  enum:
                    - environment
            - $ref: '#/components/schemas/BridgeEnvironment'
          required:
            - type
        - type: object
          allOf:
            - type: object
              properties:
                type:
                  type: string
                  enum:
                    - vault
            - $ref: '#/components/schemas/VaultCredential'
          required:
            - type
    BridgeAwsCredential:
      title: BridgeAwsCredential
      type: object
      description: >-
        AWS access key to authenticate with AWS. Access keys are long-term
        credentials for an IAM user and consist of an ID and secret. Follow
        [this guide to generate access and secret
        keys](https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys).
        You may optionally provide a session token if you are using temporary
        credentials.
      properties:
        access_key_id:
          $ref: '#/components/schemas/BridgeLocalCredential'
          description: ID portion of the AWS access key pair.
        secret_access_key:
          $ref: '#/components/schemas/BridgeLocalCredential'
          description: Secret portion of the AWS access key pair.
        session:
          $ref: '#/components/schemas/BridgeLocalCredential'
          nullable: true
          description: >-
            A temporary session token. Session tokens are optional and are only
            necessary if you are using temporary credentials.
      required:
        - access_key_id
        - secret_access_key
    BridgeTokenCredential:
      title: BridgeTokenCredential
      type: object
      description: >-
        Token used to authenticate with an external service. Secret contain the
        key to the local credential store.
      properties:
        secret:
          $ref: '#/components/schemas/BridgeLocalCredential'
          description: Secret value of the token.
      required:
        - secret
    BridgeBasicCredential:
      title: BridgeBasicCredential
      type: object
      description: >-
        Username and secret used to authenticate with an external service. These
        fields contain the keys to the local credential store.
      properties:
        username:
          $ref: '#/components/schemas/BridgeLocalCredential'
          description: Username value for authentication
        secret:
          $ref: '#/components/schemas/BridgeLocalCredential'
          description: Secret value for authentication
      required:
        - username
        - secret
    BridgeSecretCredential:
      title: BridgeSecretCredential
      type: object
      description: >-
        Secret value such as password or webhook url. Secret contain the key to
        the local credential store.
      properties:
        secret:
          $ref: '#/components/schemas/BridgeLocalCredential'
          description: Secret value
      required:
        - secret
    BridgeOAuthClientCredential:
      title: BridgeOAuthClientCredential
      type: object
      description: >-
        A Client ID and secret used for authenticating with OAuth 2.0 compatible
        service using the client credentials grant. ClientId and ClientSecret
        contain the keys to the local credential store.
      properties:
        token_url:
          $ref: '#/components/schemas/BridgeLocalCredential'
          nullable: true
          description: >-
            Optional URL for the OAuth 2.0 token exchange if it can not be
            constructed based on provider configuration
        client_id:
          $ref: '#/components/schemas/BridgeLocalCredential'
          description: The ID of the client application defined at the service provider
        client_secret:
          $ref: '#/components/schemas/BridgeLocalCredential'
          description: Secret value for authentication
        extra:
          $ref: '#/components/schemas/BridgeLocalCredential'
          nullable: true
          description: >-
            Optional connection specific meta data such as a signing key ID or
            organization ID
      required:
        - client_id
        - client_secret
    ListCredentialsResponse:
      title: ListCredentialsResponse
      type: object
      properties:
        result:
          type: array
          items:
            $ref: '#/components/schemas/CredentialResponse'
      required:
        - result
    GetCredentialResponse:
      title: GetCredentialResponse
      type: object
      properties:
        result:
          $ref: '#/components/schemas/CredentialResponse'
      required:
        - result
    LookupCredentialResponse:
      title: LookupCredentialResponse
      type: object
      properties:
        result:
          $ref: '#/components/schemas/CredentialResponse'
      required:
        - result
    CreateCredentialRequest:
      title: CreateCredentialRequest
      type: object
      properties:
        name:
          type: string
          nullable: true
          description: >-
            Unique short name for this Credential (lowercase [a-z0-9_-], can be
            used in URLs). Also used for case insensitive duplicate name
            detection and default sort order. Defaults to CredentialId if both
            name and fullname are not specified.
        fullname:
          type: string
          nullable: true
          description: >-
            Human friendly display name for this Credential, will auto-generate
            'name' field (if 'name' is not specified). Defaults to the same
            value as the 'name' field if not specified.
        config:
          $ref: '#/components/schemas/CredentialConfig'
          nullable: true
          description: Credential configuration
        owner_type:
          $ref: '#/components/schemas/OwnerType'
          nullable: true
          description: >-
            One of `account` or `integration_point`; defaults to `account` if
            not specified.
        expires:
          type: string
          format: date-time
          nullable: true
          description: Time when this credential expires and can no longer be used again.
    CreateCredentialResponse:
      title: CreateCredentialResponse
      type: object
      properties:
        result:
          $ref: '#/components/schemas/CredentialResponse'
      required:
        - result
    UpdateCredentialRequest:
      title: UpdateCredentialRequest
      $ref: '#/components/schemas/Credential'
    UpdateCredentialResponse:
      title: UpdateCredentialResponse
      type: object
      properties:
        result:
          $ref: '#/components/schemas/CredentialResponse'
      required:
        - result
    PatchCredentialResponse:
      title: PatchCredentialResponse
      type: object
      properties:
        result:
          $ref: '#/components/schemas/CredentialResponse'
      required:
        - result
    IntegrationId:
      title: IntegrationId
      $ref: '#/components/schemas/Id'
      description: Unique identifier for this Integration
    IntegrationPointId:
      title: IntegrationPointId
      $ref: '#/components/schemas/Id'
      description: Unique identifier for this IntegrationPoint
    IntegrationEnvironments:
      title: IntegrationEnvironments
      type: object
      properties:
        test:
          type: array
          items:
            $ref: '#/components/schemas/ProviderConfigId'
          nullable: true
          description: List of allowed providers for test environment.
        prod:
          type: array
          items:
            $ref: '#/components/schemas/ProviderConfigId'
          nullable: true
          description: List of allowed providers for production environment.
    AdditionalMappingType:
      title: AdditionalMappingType
      type: string
      enum:
        - recommended
        - optional
        - fixed
    AdditionalMappingTemplate:
      title: AdditionalMappingTemplate
      type: object
      properties:
        providers:
          type: array
          items:
            $ref: '#/components/schemas/ProviderConfigId'
          description: >-
            A list of provider ID strings that this mapping applies to. Mapping
            templates must have at least one provider.
        mapping_type:
          $ref: '#/components/schemas/AdditionalMappingType'
          nullable: true
          description: >-
            This controls the end-user's responsibility for this mapping when
            creating an integration in this integration point. Default:
            'optional'.

            When set to 'fixed' the mapping is always included and can not be
            overridden by the end-user.

            When 'optional', the end-user can choose to override the mapping.

            When 'recommended', the provider will enter a warning state if the
            mapping is missing.
      required:
        - providers
      allOf:
        - $ref: '#/components/schemas/AdditionalMapping'
    IntegrationPoint:
      title: IntegrationPoint
      type: object
      description: Enables creation, editing and deletion of Integrations.
      properties:
        id:
          $ref: '#/components/schemas/IntegrationPointId'
        fullname:
          type: string
          nullable: true
          description: >-
            Name of integration point, will be shown to end-users in the Connect
            UI.
        description:
          type: string
          nullable: true
          description: >-
            Optional description of the Integration Point. Will not be displayed
            to end-users of Connect UI.
        connector:
          $ref: '#/components/schemas/CategoryId'
          description: Connector to use for the Integration Point.
        environments:
          $ref: '#/components/schemas/IntegrationEnvironments'
          description: Selects providers to use for account environments.
        additional_mappings:
          type: array
          items:
            $ref: '#/components/schemas/AdditionalMappingTemplate'
          nullable: true
          description: >-
            Additional data mappings for integrations added to this integration
            point. This allows for custom data to be mapped to the custom_fields
            portion of the response.
      required:
        - id
        - connector
        - environments
      allOf:
        - $ref: '#/components/schemas/Base'
    ListIntegrationPointsResponse:
      title: ListIntegrationPointsResponse
      type: object
      properties:
        result:
          type: array
          items:
            $ref: '#/components/schemas/IntegrationPoint'
        total:
          type: integer
          nullable: true
      required:
        - result
    GetIntegrationPointResponse:
      title: GetIntegrationPointResponse
      type: object
      properties:
        result:
          $ref: '#/components/schemas/IntegrationPoint'
      required:
        - result
    CreateIntegrationPointRequest:
      title: CreateIntegrationPointRequest
      type: object
      properties:
        name:
          type: string
          nullable: true
          description: >-
            Unique short name for this Integration Point (lowercase [a-z0-9_-],
            can be used in URLs). Also used for case insensitive duplicate name
            detection and default sort order. Defaults to IntegrationPointId if
            both name and fullname are not specified.
        fullname:
          type: string
          nullable: true
          description: >-
            Name of integration point, will be shown to end-users in the Connect
            UI. Defaults to the same value as the 'name' field if not specified.
        description:
          type: string
          nullable: true
          description: >-
            Optional description of the Integration Point. Will not be displayed
            to end-users of Connect UI.
        connector:
          $ref: '#/components/schemas/CategoryId'
          description: Connector to use for the Integration Point.
        environments:
          $ref: '#/components/schemas/IntegrationEnvironments'
          description: Selects providers to use for account environments.
        additional_mappings:
          type: array
          items:
            $ref: '#/components/schemas/AdditionalMappingTemplate'
          nullable: true
          description: >-
            Additional data mappings for integrations added to this integration
            point. This allows for custom data to be mapped to the custom_fields
            portion of the response.
      required:
        - connector
        - environments
    CreateIntegrationPointResponse:
      title: CreateIntegrationPointResponse
      type: object
      properties:
        result:
          $ref: '#/components/schemas/IntegrationPoint'
      required:
        - result
    UpdateIntegrationPointRequest:
      title: UpdateIntegrationPointRequest
      $ref: '#/components/schemas/IntegrationPoint'
    UpdateIntegrationPointResponse:
      title: UpdateIntegrationPointResponse
      type: object
      properties:
        result:
          $ref: '#/components/schemas/IntegrationPoint'
      required:
        - result
    PatchIntegrationPointResponse:
      title: PatchIntegrationPointResponse
      type: object
      properties:
        result:
          $ref: '#/components/schemas/IntegrationPoint'
      required:
        - result
    ListIntegrationOptions:
      title: ListIntegrationOptions
      type: string
      enum:
        - account
        - accounts
        - integration_point
        - integration_points
        - all
    WebhookEvent:
      title: WebhookEvent
      type: string
      enum:
        - TicketCreated
        - TicketUpdated
        - TicketDeleted
        - TicketCommentCreated
        - TicketCommentDeleted
    WebhookConfig:
      title: WebhookConfig
      type: object
      properties:
        items:
          type: array
          items:
            $ref: '#/components/schemas/WebhookItem'
          description: >-
            List of webhooks for an integration. If the provider supports
            webhooks, they will be sent to the servers provided in this list.
      required:
        - items
    WebhookItem:
      title: WebhookItem
      type: object
      properties:
        webhook_url:
          type: string
          description: Webhook URL. Events from providers will be sent to this URL.
        event_filter:
          type: array
          items:
            $ref: '#/components/schemas/WebhookEvent'
          nullable: true
          description: >-
            If specified, only events matching this list will be sent to
            `webhook_url`. If no filters are specified, all events sent from
            providers will be forwarded to `webhook_url`.
      required:
        - webhook_url
    Integration:
      title: Integration
      type: object
      description: Connects an Account to an external service
      properties:
        id:
          $ref: '#/components/schemas/IntegrationId'
        fullname:
          type: string
          description: Human friendly display name for this integration.
        refresh_token_id:
          $ref: '#/components/schemas/TokenId'
          description: Integration refresh token id
        account_id:
          $ref: '#/components/schemas/AccountId'
          description: >-
            Account associated with this integration. Use the expand=accounts
            parameter with the List and ListAccount APIs to expand the Account
            to the full object
        account:
          $ref: '#/components/schemas/Account'
          nullable: true
          description: >-
            When using the expand option on the List or ListAccount APIs, the
            full account object is included in the response
        category:
          $ref: '#/components/schemas/CategoryId'
          description: Id of the Connector Category for this Integration.
        provider_config:
          $ref: '#/components/schemas/ProviderConfig'
          description: Provider configuration for this Integration.
        provider_fullname:
          type: string
          description: Human friendly display name for the provider.
        provider_type:
          type: string
          description: Type of the provider for this Integration.
        integration_point_id:
          $ref: '#/components/schemas/IntegrationPointId'
          nullable: true
          description: >-
            Integration Point associated with this integration. Use the
            expand=integration_points parameter with the List and ListAccount
            APIs to expand the Integration Point to the full object
        integration_point:
          $ref: '#/components/schemas/IntegrationPoint'
          nullable: true
          description: >-
            When using the expand option on the List or ListAccount APIs, the
            full integration_point object is included in the response
        bridge_selector:
          $ref: '#/components/schemas/BridgeSelector'
          nullable: true
          description: Use a Bridge to connect to the provider.
        webhook_config:
          $ref: '#/components/schemas/WebhookConfig'
          nullable: true
          description: >-
            Webhook configuration for this integration. Some providers support
            webhooks, and will allow end users providers to send events to a
            server for new or updated data.
        additional_mappings:
          type: array
          items:
            $ref: '#/components/schemas/AdditionalMapping'
          nullable: true
          description: >-
            Additional data mappings for this integration. This allows for
            custom data to be mapped to the custom_fields portion of the
            response.
      required:
        - id
        - fullname
        - refresh_token_id
        - account_id
        - category
        - provider_config
        - provider_fullname
        - provider_type
      allOf:
        - $ref: '#/components/schemas/Base'
    BridgeSelector:
      title: BridgeSelector
      oneOf:
        - type: object
          properties:
            type:
              type: string
              enum:
                - id
            value:
              type: string
          required:
            - type
        - type: object
          properties:
            type:
              type: string
              enum:
                - labels
            value:
              type: array
              items:
                type: string
          required:
            - type
    ListIntegrationsResponse:
      title: ListIntegrationsResponse
      type: object
      properties:
        result:
          type: array
          items:
            $ref: '#/components/schemas/Integration'
        total:
          type: integer
          nullable: true
      required:
        - result
    ListAccountIntegrationsResponse:
      title: ListAccountIntegrationsResponse
      type: object
      properties:
        result:
          type: array
          items:
            $ref: '#/components/schemas/Integration'
        total:
          type: integer
          nullable: true
      required:
        - result
    GetIntegrationResponse:
      title: GetIntegrationResponse
      type: object
      properties:
        result:
          $ref: '#/components/schemas/Integration'
      required:
        - result
    CreateIntegrationRequest:
      title: CreateIntegrationRequest
      type: object
      properties:
        name:
          type: string
          nullable: true
          description: >-
            Unique short name for this Integrations (lowercase [a-z0-9_-], can
            be used in URLs). Also used for case insensitive duplicate name
            detection and default sort order. Defaults to IntegrationId if both
            name and fullname are not specified.
        fullname:
          type: string
          nullable: true
          description: >-
            Human friendly display name for this Integrations, will
            auto-generate 'name' field (if 'name' is not specified). Defaults to
            the same value as the 'name' field if not specified.
        provider_config:
          $ref: '#/components/schemas/ProviderConfig'
          description: Provider configuration for this Integration.
        integration_point_id:
          $ref: '#/components/schemas/IntegrationPointId'
          nullable: true
          description: Integration Point associated with this integration.
        bridge_selector:
          $ref: '#/components/schemas/BridgeSelector'
          nullable: true
          description: Use a Bridge to connect to the provider.
        webhook_config:
          $ref: '#/components/schemas/WebhookConfig'
          nullable: true
          description: Web hook config for this integration
        additional_mappings:
          type: array
          items:
            $ref: '#/components/schemas/AdditionalMapping'
          nullable: true
          description: >-
            Additional data mappings for this integration. This allows for
            custom data to be mapped to the custom_fields portion of the
            response.
      required:
        - provider_config
    CreateIntegrationResponseResult:
      title: CreateIntegrationResponseResult
      type: object
      properties:
        credentials_created:
          type: array
          items:
            $ref: '#/components/schemas/CredentialResponse'
          nullable: true
        integration:
          $ref: '#/components/schemas/Integration'
        token:
          $ref: '#/components/schemas/TokenPair'
      required:
        - integration
        - token
    CreateIntegrationResponse:
      title: CreateIntegrationResponse
      type: object
      properties:
        result:
          $ref: '#/components/schemas/CreateIntegrationResponseResult'
      required:
        - result
    UpdateIntegrationRequest:
      title: UpdateIntegrationRequest
      $ref: '#/components/schemas/Integration'
    UpdateIntegrationResponse:
      title: UpdateIntegrationResponse
      type: object
      properties:
        result:
          $ref: '#/components/schemas/Integration'
      required:
        - result
    PatchIntegrationResponse:
      title: PatchIntegrationResponse
      type: object
      properties:
        result:
          $ref: '#/components/schemas/Integration'
      required:
        - result
    VerifyIntegrationRequest:
      title: VerifyIntegrationRequest
      type: object
      properties:
        integration:
          $ref: '#/components/schemas/CreateIntegrationRequest'
      required:
        - integration
    MappingDataType:
      title: MappingDataType
      type: string
      enum:
        - string
        - number
        - datetime
        - boolean
        - array
        - any
    AdditionalMapping:
      title: AdditionalMapping
      type: object
      properties:
        resource:
          $ref: '#/components/schemas/ResourceId'
          description: The resources that this mapping applies to.
        actions:
          type: array
          items:
            $ref: '#/components/schemas/ActionId'
          description: >-
            The actions that this mapping applies to. At least one action must
            be specified.
        source:
          type: string
          description: >-
            The dot-separated path to the field in the source data coming from
            the provider. Use `\.` to escape literal dots in the field name.
        destination:
          type: string
          description: >-
            The dot-separated path to where the data should reside in the custom
            fields object when data is returned from the provider.
        literal:
          type: boolean
          nullable: true
          description: >-
            When true, the value in 'source' is treated as a literal value
            rather than a mapping. This allows adding static values to custom
            fields. Default: false
        data_type:
          $ref: '#/components/schemas/MappingDataType'
          description: >-
            The data type of the field. This ensures the data is processed to
            the correct type when mapping. Fields set to 'any' will not get
            validated

            or processed. Other types are cast depending as defined by each
            provider. For example, a field with 'datetime' is parsed based on
            the date

            format used by the provider, and normalized to a unix timestamp with
            millisecond precision.
      required:
        - resource
        - actions
        - source
        - destination
        - data_type
    MemberId:
      title: MemberId
      $ref: '#/components/schemas/Id'
      description: Unique identifier for this Member
    State:
      title: State
      type: string
      enum:
        - disabled
        - enabled
        - forgotten
        - invited
        - locked
    Options:
      title: Options
      type: string
      enum:
        - disabled
        - expired
        - forgotten
        - invited
        - locked
    Member:
      title: Member
      type: object
      properties:
        id:
          $ref: '#/components/schemas/MemberId'
        state:
          $ref: '#/components/schemas/State'
        last_logon:
          type: string
          format: date-time
          description: Last logon time
        fullname:
          type: string
          description: User's full display name.
        nickname:
          type: string
          nullable: true
          description: User's nickname
        picture:
          type: string
          nullable: true
          description: Url of user's picture
        ttl:
          type: string
        token_ttl:
          type: string
        expires:
          type: string
          format: date-time
        pin_expires:
          type: string
          format: date-time
        role_binding:
          type: array
          items:
            $ref: '#/components/schemas/RoleName'
          description: Roles granted to this member. Tokens inherit this access.
      required:
        - id
        - state
        - last_logon
        - fullname
        - ttl
        - token_ttl
        - expires
        - pin_expires
        - role_binding
      allOf:
        - $ref: '#/components/schemas/Base'
    MemberOptions:
      title: MemberOptions
      type: object
      properties:
        ttl:
          type: string
          description: >-
            Optional member time-to-live duration. After a member expires,
            system requires a change password to re-enable member. Minimum 1
            day, Maximum 1 year, Default 180 days.
        options:
          type: array
          items:
            $ref: '#/components/schemas/Options'
          description: 'Options: "expired" will force change password on first logon.'
        token_ttl:
          type: string
          description: >-
            Optional token time-to-live duration. Tokens are created for this
            member with this duration as their TTL. Minimum 10 miniutes, Maximum
            1 week, Defaults 1 hour.
      required:
        - ttl
        - options
        - token_ttl
    CreateMemberRequest:
      title: CreateMemberRequest
      type: object
      properties:
        name:
          type: string
          description: >-
            Email name to use for this Member. Also used for duplicate detection
            and default sort order.
        fullname:
          type: string
          nullable: true
          description: >-
            User's full display name. Defaults to the same value as the 'name'
            field if not specified.
        nickname:
          type: string
          nullable: true
          description: User's nickname
        picture:
          type: string
          nullable: true
          description: Url of user's picture
        secret:
          type: string
          description: >-
            Member secret used to logon. Must be at least 8 characters long and
            fewer than 72 characters. There are no restrictions on the
            characters used; however, the secret must be sufficiently complex.
            It cannot be a common word, previously leaked password, or easily
            guessed sequences like `qwerty` or `12345`.
        role_binding:
          type: array
          items:
            $ref: '#/components/schemas/RoleName'
          nullable: true
          description: >-
            Roles granted to this member. Tokens inherit this access. Defaults
            to `member`.
        options:
          $ref: '#/components/schemas/MemberOptions'
      required:
        - name
        - secret
        - options
    CreateMemberResponseResult:
      title: CreateMemberResponseResult
      type: object
      properties:
        member:
          $ref: '#/components/schemas/Member'
      required:
        - member
    CreateMemberResponse:
      title: CreateMemberResponse
      type: object
      properties:
        result:
          $ref: '#/components/schemas/CreateMemberResponseResult'
      required:
        - result
    ListMembersResponse:
      title: ListMembersResponse
      type: object
      properties:
        result:
          type: array
          items:
            $ref: '#/components/schemas/Member'
      required:
        - result
    GetMemberResponse:
      title: GetMemberResponse
      type: object
      properties:
        result:
          $ref: '#/components/schemas/Member'
      required:
        - result
    UpdateMemberRequest:
      title: UpdateMemberRequest
      $ref: '#/components/schemas/Member'
    UpdateMemberResponse:
      title: UpdateMemberResponse
      type: object
      properties:
        result:
          $ref: '#/components/schemas/Member'
      required:
        - result
    PatchMemberResponse:
      title: PatchMemberResponse
      type: object
      properties:
        result:
          $ref: '#/components/schemas/Member'
      required:
        - result
    GetOpenApiSpecResponse:
      title: GetOpenApiSpecResponse
    OperationId:
      title: OperationId
      $ref: '#/components/schemas/Id'
      description: Unique identifier for this Asynchronous Operation
    OperationSchedule:
      title: OperationSchedule
      type: object
      properties:
        run_at:
          type: string
          format: date-time
          nullable: true
          description: Run now or on the specified time.
        interval:
          type: string
          nullable: true
          description: Set the interval duration for recuring operations. (minimum 1h)
    OperationInput:
      title: OperationInput
      type: object
      properties:
        filters:
          type: array
          items:
            type: string
          nullable: true
          description: >-
            Limit the number of results returned by the operation. If not
            specified, the operation will return all results.
        limit:
          type: integer
          nullable: true
          description: Limit query results by these filters.
    Operation:
      title: Operation
      type: object
      properties:
        id:
          $ref: '#/components/schemas/OperationId'
          description: ID of the operation
        created_at:
          type: string
          format: date-time
          description: Time object was originally created
        updated_at:
          type: string
          format: date-time
          description: Last time object was updated
        account_id:
          $ref: '#/components/schemas/Id'
          description: Account ID containing the integration.
        integration_id:
          $ref: '#/components/schemas/Id'
          description: Integration ID to use for the operation.
        schedule:
          $ref: '#/components/schemas/OperationSchedule'
          nullable: true
          description: Run now or on the specified schedule.
        operation:
          type: string
          description: Name of the operation that will be run for this operation.
        input:
          $ref: '#/components/schemas/OperationInput'
          description: Parameters for the operation that will be run for this operation.
        status:
          $ref: '#/components/schemas/OperationStatus'
          description: Status of the operation
        errors:
          type: array
          items:
            $ref: '#/components/schemas/OperationError'
          nullable: true
          description: Errors that occurred during the operation
        cpu_time:
          type: integer
          format: int64
          description: Cpu time in microseconds
        in_bytes:
          type: integer
          format: int64
          description: Number of bytes sent to sink integration
      required:
        - id
        - created_at
        - updated_at
        - account_id
        - integration_id
        - operation
        - input
        - status
        - cpu_time
        - in_bytes
    OperationStatus:
      title: OperationStatus
      type: string
      enum:
        - SCHEDULED
        - PROCESSING
        - CANCELLED
        - COMPLETE
    OperationError:
      title: OperationError
      type: object
      properties:
        message:
          type: string
          description: Error message
      required:
        - message
    ListOperationsResponse:
      title: ListOperationsResponse
      type: object
      properties:
        result:
          type: array
          items:
            $ref: '#/components/schemas/Operation'
      required:
        - result
    OrganizationId:
      title: OrganizationId
      $ref: '#/components/schemas/Id'
      description: Unique identifier for this Organization
    Environment:
      title: Environment
      type: string
      enum:
        - test
        - prod
    OrganizationType:
      title: OrganizationType
      type: string
      enum:
        - root
        - standard
    OrganizationOptions:
      title: OrganizationOptions
      type: object
      properties:
        invite_duration:
          type: string
          nullable: true
          description: >-
            Duration new member invitations will be valid. Default: 168h (7
            days), minimum 24h, maximum 168h (7 days).
        forgot_duration:
          type: string
          nullable: true
          description: >-
            Duration forgotten password invitations will be valid. Default: 24h,
            minimum 24h, maximum 168h (7 days).
        password_duration:
          type: string
          nullable: true
          description: >-
            Duration before member password expires, part of required password
            rotation. Default: 4320h (180 days), minimum: 24h, maximum: 8760h
            (365 days).
        minimum_password_length:
          type: integer
          nullable: true
          description: 'Minimum password length. Default: 8, minimum 8, maximum 72.'
    Organization:
      title: Organization
      type: object
      properties:
        id:
          $ref: '#/components/schemas/OrganizationId'
        refresh_token_id:
          $ref: '#/components/schemas/TokenId'
          description: Organization refresh token id
        organization_type:
          $ref: '#/components/schemas/OrganizationType'
          description: 'Organization type: root or standard'
        fullname:
          type: string
          description: Human friendly display name for this Organization
        contact:
          type: string
          nullable: true
          description: Organization email address
        reply_to:
          type: string
          nullable: true
          description: >-
            Reply-to email address, used for SMTP emails. Defaults to
            no-reply@synqly.com
        picture:
          type: string
          nullable: true
          description: Picture URL of the organization
        options:
          $ref: '#/components/schemas/OrganizationOptions'
          nullable: true
          description: Organization options
      required:
        - id
        - refresh_token_id
        - organization_type
        - fullname
      allOf:
        - $ref: '#/components/schemas/Base'
    CreateOrganizationRequest:
      title: CreateOrganizationRequest
      type: object
      properties:
        name:
          type: string
          nullable: true
          description: >-
            Unique short name for this Organization (lowercase [a-z0-9_-], can
            be used in URLs). Used for case insensitive duplicate name detection
            and default sort order. Defaults to OrganizationId if both name and
            fullname are not specified.
        fullname:
          type: string
          nullable: true
          description: >-
            Human friendly display name for this Organization, will
            auto-generate 'name' field (if 'name' is not specified). Defaults to
            the same value as the 'name' field if not specified.
        contact:
          type: string
          nullable: true
          description: Organization email address
        reply_to:
          type: string
          nullable: true
          description: >-
            Reply-to email address, used for SMTP emails. Defaults to
            no-reply@synqly.com
        picture:
          type: string
          nullable: true
          description: URL of the organization
        member:
          $ref: '#/components/schemas/CreateMemberRequest'
          nullable: true
          description: Create organization member
    CreateOrganizationResponseResult:
      title: CreateOrganizationResponseResult
      type: object
      properties:
        member:
          $ref: '#/components/schemas/Member'
          nullable: true
        organization:
          $ref: '#/components/schemas/Organization'
        token:
          $ref: '#/components/schemas/TokenPair'
      required:
        - organization
        - token
    CreateOrganizationResponse:
      title: CreateOrganizationResponse
      type: object
      properties:
        result:
          $ref: '#/components/schemas/CreateOrganizationResponseResult'
      required:
        - result
    GetOrganizationResponse:
      title: GetOrganizationResponse
      type: object
      properties:
        result:
          $ref: '#/components/schemas/Organization'
      required:
        - result
    ListOrganizationResponse:
      title: ListOrganizationResponse
      type: object
      properties:
        result:
          type: array
          items:
            $ref: '#/components/schemas/Organization'
      required:
        - result
    WebhookId:
      title: WebhookId
      $ref: '#/components/schemas/Id'
      description: Unique identifier for a Webhook
    WebhookFilter:
      title: WebhookFilter
      type: string
      enum:
        - all
        - account_create
        - account_delete
        - account_update
        - integration_create
        - integration_delete
        - integration_update
        - operation_complete
    OrganizationWebhookPayload:
      title: OrganizationWebhookPayload
      type: object
      description: >-
        Response payload for webhook events. This payload is sent to the webhook
        URL when an event occurs.
      properties:
        event:
          $ref: '#/components/schemas/WebhookFilter'
          description: The event that triggered the webhook
        account:
          $ref: '#/components/schemas/Account'
          nullable: true
          description: The account that the event occurred in
        integration:
          $ref: '#/components/schemas/Integration'
          nullable: true
          description: The integration that the event occurred in
        nonce:
          type: string
          description: A unique identifier for this webhook event
      required:
        - event
        - nonce
    OrganizationWebhook:
      title: OrganizationWebhook
      type: object
      properties:
        id:
          $ref: '#/components/schemas/WebhookId'
        fullname:
          type: string
          description: Human friendly slug for this webhook
        environment:
          $ref: '#/components/schemas/Environment'
          description: >-
            Environment that the webhook is configured for. Only events
            associated with this environment will trigger the webhook.
        filters:
          type: array
          items:
            $ref: '#/components/schemas/WebhookFilter'
          description: Specifies which Webhooks to send.
        url:
          type: string
          description: URL that webhooks will be sent to
        credential_id:
          $ref: '#/components/schemas/CredentialId'
          description: Credential contain secret
      required:
        - id
        - fullname
        - environment
        - filters
        - url
        - credential_id
      allOf:
        - $ref: '#/components/schemas/Base'
    OrganizationWebhookSecret:
      title: OrganizationWebhookSecret
      type: object
      properties:
        value:
          type: string
          description: >-
            Secret used for signing webhooks. This value is used to verify the
            authenticity of the webhook payload.
        expires:
          type: string
          format: date-time
          nullable: true
          description: Time when this secret expires and can no longer be used again.
      required:
        - value
    CreateOrganizationWebhookRequest:
      title: CreateOrganizationWebhookRequest
      type: object
      properties:
        name:
          type: string
          nullable: true
          description: Human friendly slug for this webhook
        fullname:
          type: string
          nullable: true
          description: Fullname for this webhook
        environment:
          $ref: '#/components/schemas/Environment'
          nullable: true
          description: >-
            Environment that the webhook is configured for. Only events for
            accounts associated with this environment will trigger the webhook.
        filters:
          type: array
          items:
            $ref: '#/components/schemas/WebhookFilter'
          description: Specifies which Webhooks to send.
        url:
          type: string
          description: URL that webhooks will be sent to.
        secret:
          $ref: '#/components/schemas/OrganizationWebhookSecret'
          description: >-
            Secret used for signing webhooks. This value is used to verify the
            authenticity of the webhook payload.
      required:
        - filters
        - url
        - secret
    CreateOrganizationWebhookResponse:
      title: CreateOrganizationWebhookResponse
      type: object
      properties:
        result:
          $ref: '#/components/schemas/OrganizationWebhook'
          description: The created webhook.
      required:
        - result
    GetOrganizationWebhookResponse:
      title: GetOrganizationWebhookResponse
      type: object
      properties:
        result:
          $ref: '#/components/schemas/OrganizationWebhook'
      required:
        - result
    ListOrganizationWebhooksResponse:
      title: ListOrganizationWebhooksResponse
      type: object
      properties:
        result:
          type: array
          items:
            $ref: '#/components/schemas/OrganizationWebhook'
          description: List of webhooks for the organization.
      required:
        - result
    PatchOrganizationWebhookResponse:
      title: PatchOrganizationWebhookResponse
      type: object
      properties:
        result:
          $ref: '#/components/schemas/OrganizationWebhook'
      required:
        - result
    UpdateOrganizationWebhookRequest:
      title: UpdateOrganizationWebhookRequest
      $ref: '#/components/schemas/OrganizationWebhook'
    UpdateOrganizationWebhookResponse:
      title: UpdateOrganizationWebhookResponse
      type: object
      properties:
        result:
          $ref: '#/components/schemas/OrganizationWebhook'
      required:
        - result
    UpdateOrganizationRequest:
      title: UpdateOrganizationRequest
      $ref: '#/components/schemas/Organization'
    UpdateOrganizationResponse:
      title: UpdateOrganizationResponse
      type: object
      properties:
        result:
          $ref: '#/components/schemas/Organization'
      required:
        - result
    PatchOrganizationResponse:
      title: PatchOrganizationResponse
      type: object
      properties:
        result:
          $ref: '#/components/schemas/Organization'
      required:
        - result
    Permission:
      title: Permission
      type: object
      properties:
        role_binding:
          type: array
          items:
            $ref: '#/components/schemas/RoleName'
          nullable: true
          description: Roles granted to this token.
        adhoc_role:
          $ref: '#/components/schemas/AdhocRole'
          nullable: true
          description: Adhoc role granted to this token.
        resource_id:
          $ref: '#/components/schemas/Id'
          description: ID of the resource that this permission grants access to.
        resource_type:
          type: string
          description: >-
            Type of the resource that this permission grants access to. Must be
            one of the following: "organization, "integration"
        parent_id:
          $ref: '#/components/schemas/Id'
          description: Token parentId
        id:
          $ref: '#/components/schemas/Id'
          description: Token Id
        organization_id:
          $ref: '#/components/schemas/Id'
          description: Token organizationId
        root_organization_id:
          $ref: '#/components/schemas/Id'
          nullable: true
          description: Token root organizationId
        member_id:
          $ref: '#/components/schemas/Id'
          description: Token memberId
      required:
        - resource_id
        - resource_type
        - parent_id
        - id
        - organization_id
        - member_id
    Permissions:
      title: Permissions
      type: string
      enum:
        - administrator
        - viewer
        - member
        - account-manager
        - connect-ui
        - token-issuer
    PermissionSet:
      title: PermissionSet
      type: object
      properties:
        name:
          $ref: '#/components/schemas/Permissions'
        description:
          type: string
          nullable: true
          description: >-
            Description of when the permission set should be used and what
            permissions are granted by the permission set.
        resource_restrictions:
          type: array
          items:
            $ref: '#/components/schemas/ResourceRestrictions'
          nullable: true
          description: Resources that can be used with this permission set
        permissions:
          $ref: '#/components/schemas/ApiPermissionMap'
          description: API permissions granted by the permission set.
      required:
        - name
        - permissions
    ApiPermissionMap:
      title: ApiPermissionMap
      type: object
      properties:
        all:
          $ref: '#/components/schemas/ReadWritePermissions'
          nullable: true
        accounts:
          $ref: '#/components/schemas/AccountsPermissions'
          nullable: true
        alarms:
          $ref: '#/components/schemas/AlarmsPermissions'
          nullable: true
        alarm_policies:
          $ref: '#/components/schemas/AlarmPoliciesPermissions'
          nullable: true
        audit:
          $ref: '#/components/schemas/AuditPermissions'
          nullable: true
        auth:
          $ref: '#/components/schemas/AuthPermissions'
          nullable: true
        bridges:
          $ref: '#/components/schemas/BridgesPermissions'
          nullable: true
        credentials:
          $ref: '#/components/schemas/CredentialsPermissions'
          nullable: true
        integrations:
          $ref: '#/components/schemas/IntegrationsPermissions'
          nullable: true
        integration_points:
          $ref: '#/components/schemas/IntegrationPointsPermissions'
          nullable: true
        operations:
          $ref: '#/components/schemas/OperationsPermissions'
          nullable: true
        members:
          $ref: '#/components/schemas/MembersPermissions'
          nullable: true
        organizations:
          $ref: '#/components/schemas/OrganizationPermissions'
          nullable: true
        permission_set:
          $ref: '#/components/schemas/PermissionSetPermissions'
          nullable: true
        roles:
          $ref: '#/components/schemas/RolesPermissions'
          nullable: true
        status:
          $ref: '#/components/schemas/StatusPermissions'
          nullable: true
        suborgs:
          $ref: '#/components/schemas/SubOrgsPermissions'
          nullable: true
        tokens:
          $ref: '#/components/schemas/TokensPermissions'
          nullable: true
        transforms:
          $ref: '#/components/schemas/TransformsPermissions'
          nullable: true
        webhooks:
          $ref: '#/components/schemas/WebhooksPermissions'
          nullable: true
    ReadWritePermissions:
      title: ReadWritePermissions
      type: object
      description: Permissions for all accounts
      properties:
        actions:
          type: array
          items:
            $ref: '#/components/schemas/ReadWriteActions'
      required:
        - actions
    AccountsPermissions:
      title: AccountsPermissions
      type: object
      description: Permissions for the accounts API
      properties:
        actions:
          type: array
          items:
            $ref: '#/components/schemas/AccountsActions'
      required:
        - actions
    AlarmsPermissions:
      title: AlarmsPermissions
      type: object
      description: Permissions for the alarms API
      properties:
        actions:
          type: array
          items:
            $ref: '#/components/schemas/AlarmsActions'
      required:
        - actions
    AlarmPoliciesPermissions:
      title: AlarmPoliciesPermissions
      type: object
      description: Permissions for the alarm policy API
      properties:
        actions:
          type: array
          items:
            $ref: '#/components/schemas/AlarmPoliciesActions'
      required:
        - actions
    AuditPermissions:
      title: AuditPermissions
      type: object
      description: Permissions for the audit API
      properties:
        actions:
          type: array
          items:
            $ref: '#/components/schemas/AuditActions'
      required:
        - actions
    AuthPermissions:
      title: AuthPermissions
      type: object
      description: Permissions for the auth logon/logoff API
      properties:
        actions:
          type: array
          items:
            $ref: '#/components/schemas/AuthActions'
      required:
        - actions
    BridgesPermissions:
      title: BridgesPermissions
      type: object
      description: Permissions for the bridge API
      properties:
        actions:
          type: array
          items:
            $ref: '#/components/schemas/BridgesActions'
      required:
        - actions
    CredentialsPermissions:
      title: CredentialsPermissions
      type: object
      description: Permissions for the credentials API
      properties:
        actions:
          type: array
          items:
            $ref: '#/components/schemas/CredentialsActions'
      required:
        - actions
    IntegrationsPermissions:
      title: IntegrationsPermissions
      type: object
      description: Permissions for the integrations API
      properties:
        actions:
          type: array
          items:
            $ref: '#/components/schemas/IntegrationsActions'
      required:
        - actions
    IntegrationPointsPermissions:
      title: IntegrationPointsPermissions
      type: object
      description: Permissions for the integrations points API
      properties:
        actions:
          type: array
          items:
            $ref: '#/components/schemas/IntegrationPointsActions'
      required:
        - actions
    OperationsPermissions:
      title: OperationsPermissions
      type: object
      description: Permissions for the operations API
      properties:
        actions:
          type: array
          items:
            $ref: '#/components/schemas/OperationsActions'
      required:
        - actions
    MembersPermissions:
      title: MembersPermissions
      type: object
      description: Permissions for the members API
      properties:
        actions:
          type: array
          items:
            $ref: '#/components/schemas/MembersActions'
      required:
        - actions
    OrganizationPermissions:
      title: OrganizationPermissions
      type: object
      description: Permissions for the organization API
      properties:
        actions:
          type: array
          items:
            $ref: '#/components/schemas/OrganizationActions'
      required:
        - actions
    PermissionSetPermissions:
      title: PermissionSetPermissions
      type: object
      description: Permissions for the permissionset API
      properties:
        actions:
          type: array
          items:
            $ref: '#/components/schemas/PermissionSetActions'
      required:
        - actions
    RolesPermissions:
      title: RolesPermissions
      type: object
      description: Permissions for the roles API
      properties:
        actions:
          type: array
          items:
            $ref: '#/components/schemas/RolesActions'
      required:
        - actions
    SubOrgsPermissions:
      title: SubOrgsPermissions
      type: object
      description: Permissions for the roles API
      properties:
        actions:
          type: array
          items:
            $ref: '#/components/schemas/SubOrgsActions'
      required:
        - actions
    StatusPermissions:
      title: StatusPermissions
      type: object
      description: Permissions for the status API
      properties:
        actions:
          type: array
          items:
            $ref: '#/components/schemas/StatusActions'
      required:
        - actions
    TokensPermissions:
      title: TokensPermissions
      type: object
      description: Permissions for the tokens API
      properties:
        actions:
          type: array
          items:
            $ref: '#/components/schemas/TokensActions'
      required:
        - actions
    TransformsPermissions:
      title: TransformsPermissions
      type: object
      description: Permissions for the transforms API
      properties:
        actions:
          type: array
          items:
            $ref: '#/components/schemas/TransformsActions'
      required:
        - actions
    WebhooksPermissions:
      title: WebhooksPermissions
      type: object
      description: Permissions for the webhooks API
      properties:
        actions:
          type: array
          items:
            $ref: '#/components/schemas/WebhooksActions'
      required:
        - actions
    ResourceRestrictions:
      title: ResourceRestrictions
      type: string
      enum:
        - accounts
        - integrations
    ReadWriteActions:
      title: ReadWriteActions
      type: string
      enum:
        - read
        - '*'
    AccountsActions:
      title: AccountsActions
      type: string
      enum:
        - list
        - create
        - get
        - update
        - patch
        - delete
        - '*'
    AlarmsActions:
      title: AlarmsActions
      type: string
      enum:
        - list
        - get
        - mode
        - priority
        - clear
        - '*'
    AlarmPoliciesActions:
      title: AlarmPoliciesActions
      type: string
      enum:
        - get
        - update
        - patch
        - '*'
    AuditActions:
      title: AuditActions
      type: string
      enum:
        - list
        - '*'
    AuthActions:
      title: AuthActions
      type: string
      enum:
        - logon
        - change_password
        - logoff
        - '*'
    BridgesActions:
      title: BridgesActions
      type: string
      enum:
        - list
        - create
        - get
        - update
        - patch
        - delete
        - status
        - '*'
    CredentialsActions:
      title: CredentialsActions
      type: string
      enum:
        - list
        - create
        - get
        - update
        - patch
        - delete
        - lookup
        - '*'
    IntegrationsActions:
      title: IntegrationsActions
      type: string
      enum:
        - list
        - create
        - get
        - update
        - patch
        - delete
        - list_account
        - verify
        - '*'
    IntegrationPointsActions:
      title: IntegrationPointsActions
      type: string
      enum:
        - list
        - create
        - get
        - update
        - patch
        - delete
        - '*'
    OperationsActions:
      title: OperationsActions
      type: string
      enum:
        - list
        - '*'
    MembersActions:
      title: MembersActions
      type: string
      enum:
        - list
        - create
        - get
        - update
        - patch
        - delete
        - '*'
    OrganizationActions:
      title: OrganizationActions
      type: string
      enum:
        - get
        - update
        - patch
        - '*'
    PermissionSetActions:
      title: PermissionSetActions
      type: string
      enum:
        - list
        - get
        - '*'
    RolesActions:
      title: RolesActions
      type: string
      enum:
        - list
        - create
        - get
        - update
        - patch
        - delete
        - '*'
    SubOrgsActions:
      title: SubOrgsActions
      type: string
      enum:
        - list
        - create
        - get
        - delete
        - '*'
    StatusActions:
      title: StatusActions
      type: string
      enum:
        - list
        - get
        - reset
        - list_events
        - timeseries
        - integration_timeseries
        - '*'
    TokensActions:
      title: TokensActions
      type: string
      enum:
        - list
        - create
        - create_integration
        - create_synqly_integrations
        - delete
        - get
        - reset
        - refresh
        - remove_secondary
        - '*'
    TransformsActions:
      title: TransformsActions
      type: string
      enum:
        - list
        - create
        - get
        - update
        - patch
        - delete
        - '*'
    WebhooksActions:
      title: WebhooksActions
      type: string
      enum:
        - list
        - create
        - get
        - update
        - patch
        - delete
        - '*'
    ListPermissionSetsResponse:
      title: ListPermissionSetsResponse
      type: object
      properties:
        result:
          type: array
          items:
            $ref: '#/components/schemas/PermissionSet'
      required:
        - result
    GetPermissionSetResponse:
      title: GetPermissionSetResponse
      type: object
      properties:
        result:
          $ref: '#/components/schemas/PermissionSet'
      required:
        - result
    ArmisCredential:
      title: ArmisCredential
      oneOf:
        - type: object
          allOf:
            - type: object
              properties:
                type:
                  type: string
                  enum:
                    - token
            - $ref: '#/components/schemas/TokenCredential'
          required:
            - type
        - type: object
          properties:
            type:
              type: string
              enum:
                - token_id
            value:
              $ref: '#/components/schemas/TokenCredentialId'
          required:
            - type
    Assets_ArmisCentrix:
      title: Armis Centrix
      type: object
      description: Configuration for the Armis Centrix Assets Provider
      properties:
        credential:
          $ref: '#/components/schemas/ArmisCredential'
        url:
          type: string
          description: >-
            URL for the Armis Centrix API. This should be the base URL for the
            API, without any path components. For example,
            "https://tenant.armis.com".
      required:
        - credential
        - url
    Assets_NozomiVantage:
      title: Nozomi Vantage
      type: object
      description: Configuration for the Nozomi Vantage provider
      properties:
        credential:
          $ref: '#/components/schemas/NozomiVantageCredential'
        url:
          type: string
          description: >-
            URL for the Nozomi Vantage API. This should be the base URL for the
            API, without any path components. For example,
            "https://tenant.us1.vantage.nozominetworks.io".
      required:
        - credential
        - url
    Assets_ServiceNow:
      title: ServiceNow CMDB
      type: object
      description: Configuration for ServiceNow as an Assets Provider
      properties:
        credential:
          $ref: '#/components/schemas/ServiceNowCredential'
        url:
          type: string
          description: >-
            URL for the ServiceNow API. This should be the base URL for the API,
            without any path components and must be HTTPS. For example,
            "https://tenant.service-now.com".
      required:
        - credential
        - url
    Assets_ServiceNow_Mock:
      title: '[MOCK] ServiceNow CMDB'
      type: object
      description: Configuration for a mocked ServiceNow as an Assets Provider
      properties:
        dataset:
          $ref: '#/components/schemas/AssetsServiceNowDataset'
      required:
        - dataset
    AssetsServiceNowDataset:
      title: AssetsServiceNowDataset
      type: string
      enum:
        - basic_v0
    AutotaskApiIntegrationCodeCredential:
      title: AutotaskApiIntegrationCodeCredential
      oneOf:
        - type: object
          allOf:
            - type: object
              properties:
                type:
                  type: string
                  enum:
                    - secret
            - $ref: '#/components/schemas/SecretCredential'
          required:
            - type
        - type: object
          properties:
            type:
              type: string
              enum:
                - secret_id
            value:
              $ref: '#/components/schemas/SecretCredentialId'
          required:
            - type
    AutotaskSecretCredential:
      title: AutotaskSecretCredential
      oneOf:
        - type: object
          allOf:
            - type: object
              properties:
                type:
                  type: string
                  enum:
                    - secret
            - $ref: '#/components/schemas/SecretCredential'
          required:
            - type
        - type: object
          properties:
            type:
              type: string
              enum:
                - secret_id
            value:
              $ref: '#/components/schemas/SecretCredentialId'
          required:
            - type
    AwsS3Credential:
      title: AwsS3Credential
      oneOf:
        - type: object
          allOf:
            - type: object
              properties:
                type:
                  type: string
                  enum:
                    - aws
            - $ref: '#/components/schemas/AwsCredential'
          required:
            - type
        - type: object
          properties:
            type:
              type: string
              enum:
                - aws_id
            value:
              $ref: '#/components/schemas/AwsCredentialId'
          required:
            - type
    AwsSQSCredential:
      title: AwsSQSCredential
      oneOf:
        - type: object
          allOf:
            - type: object
              properties:
                type:
                  type: string
                  enum:
                    - aws
            - $ref: '#/components/schemas/AwsCredential'
          required:
            - type
        - type: object
          properties:
            type:
              type: string
              enum:
                - aws_id
            value:
              $ref: '#/components/schemas/AwsCredentialId'
          required:
            - type
    AwsSecurityLakeCredential:
      title: AwsSecurityLakeCredential
      oneOf:
        - type: object
          allOf:
            - type: object
              properties:
                type:
                  type: string
                  enum:
                    - aws
            - $ref: '#/components/schemas/AwsCredential'
          required:
            - type
        - type: object
          properties:
            type:
              type: string
              enum:
                - aws_id
            value:
              $ref: '#/components/schemas/AwsCredentialId'
          required:
            - type
    AzureBlobCredential:
      title: AzureBlobCredential
      oneOf:
        - type: object
          allOf:
            - type: object
              properties:
                type:
                  type: string
                  enum:
                    - token
            - $ref: '#/components/schemas/TokenCredential'
          required:
            - type
        - type: object
          properties:
            type:
              type: string
              enum:
                - token_id
            value:
              $ref: '#/components/schemas/TokenCredentialId'
          required:
            - type
    AzureMonitorLogsCredential:
      title: AzureMonitorLogsCredential
      oneOf:
        - type: object
          allOf:
            - type: object
              properties:
                type:
                  type: string
                  enum:
                    - token
            - $ref: '#/components/schemas/TokenCredential'
          required:
            - type
        - type: object
          properties:
            type:
              type: string
              enum:
                - token_id
            value:
              $ref: '#/components/schemas/TokenCredentialId'
          required:
            - type
    CrowdStrikeCredential:
      title: CrowdStrikeCredential
      oneOf:
        - type: object
          allOf:
            - type: object
              properties:
                type:
                  type: string
                  enum:
                    - o_auth_client
            - $ref: '#/components/schemas/OAuthClientCredential'
          required:
            - type
        - type: object
          properties:
            type:
              type: string
              enum:
                - o_auth_client_id
            value:
              $ref: '#/components/schemas/OAuthClientCredentialId'
          required:
            - type
    CrowdstrikeHECCredential:
      title: CrowdstrikeHECCredential
      oneOf:
        - type: object
          allOf:
            - type: object
              properties:
                type:
                  type: string
                  enum:
                    - token
            - $ref: '#/components/schemas/TokenCredential'
          required:
            - type
        - type: object
          properties:
            type:
              type: string
              enum:
                - token_id
            value:
              $ref: '#/components/schemas/TokenCredentialId'
          required:
            - type
      description: Supported credential types for Crowdstrike HEC
    CustomFieldMapping:
      title: CustomFieldMapping
      type: object
      properties:
        name:
          type: string
          description: >-
            Name for the custom field that you will use in the `custom_fields`
            field in ticket objects within Synqly.
        project_id:
          type: string
          description: >-
            ID of the project this field mapping is associated with. ID of "\*"
            is used to apply to all projects.
        provider_field_path:
          type: string
          description: Path to or name of the custom field in the provider.
      required:
        - name
        - project_id
        - provider_field_path
    DefenderCredential:
      title: DefenderCredential
      oneOf:
        - type: object
          allOf:
            - type: object
              properties:
                type:
                  type: string
                  enum:
                    - o_auth_client
            - $ref: '#/components/schemas/OAuthClientCredential'
          required:
            - type
        - type: object
          properties:
            type:
              type: string
              enum:
                - o_auth_client_id
            value:
              $ref: '#/components/schemas/OAuthClientCredentialId'
          required:
            - type
    Edr_CrowdStrike:
      title: CrowdStrike EDR
      type: object
      description: Configuration for the CrowdStrike EDR Provider
      properties:
        credential:
          $ref: '#/components/schemas/CrowdStrikeCredential'
        url:
          type: string
          nullable: true
          description: The root domain where your CrowdStrike Falcon tenant is located.
          default: https://api.crowdstrike.com
      required:
        - credential
    Edr_Defender:
      title: Defender EDR
      type: object
      description: Configuration for the Microsoft Defender EDR Provider
      properties:
        credential:
          $ref: '#/components/schemas/DefenderCredential'
        tenant_id:
          type: string
          description: TenantId for the Microsoft Defender Management Console.
        url:
          type: string
          description: URL for the Microsoft Defender Management Console.
          default: https://api-us.securitycenter.windows.com
      required:
        - credential
        - tenant_id
        - url
    Edr_Malwarebytes:
      title: Malwarebytes EDR
      type: object
      description: Configuration for the Malwarebytes EDR Provider
      properties:
        account_identifier:
          type: string
          description: >-
            Account identifier for the Malwarebytes EDR Provider. Can be either
            the account ID directly (e.g. xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx)
            or the full tenant URL (e.g.
            https://cloud.malwarebytes.com/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/dashboard)
        credential:
          $ref: '#/components/schemas/MalwarebytesCredential'
        url:
          type: string
          nullable: true
          description: URL for the Malwarebytes EDR Provider
          default: https://api.malwarebytes.com
      required:
        - account_identifier
        - credential
    Edr_SentinelOne:
      title: SentinelOne EDR
      type: object
      description: Configuration for the SentinelOne EDR Provider
      properties:
        credential:
          $ref: '#/components/schemas/SentinelOneCredential'
        url:
          type: string
          description: >-
            URL for the SentinelOne Management API. This should be the base URL
            for the API, without any path components. For example,
            "https://your_management_url".
      required:
        - credential
        - url
    Edr_Sophos:
      title: Sophos EDR
      type: object
      description: Configuration for the Sophos EDR Provider
      properties:
        credential:
          $ref: '#/components/schemas/SophosCredential'
        url:
          type: string
          nullable: true
          description: Optional root domain where your Sophos tenant is located.
          default: https://api.central.sophos.com
      required:
        - credential
    ElasticsearchAuthOptions:
      title: Elasticsearch Authentication Options
      type: object
      description: >-
        Options used to control how requests are made to elasticsearch when
        different authentication types are used.
      properties:
        run_as:
          type: string
          nullable: true
          description: >-
            When you have the correct permissions, this allows API requests to
            get made as a specific user, with all of their roles and
            permissions. When populated, this option will send the
            'es-security-runas-user' header with every request made to the
            Elasticsearch API.
        shared_secret:
          $ref: '#/components/schemas/ElasticsearchSharedSecret'
          nullable: true
          description: >-
            Some auth cases, notably JWT auth can be configured to require
            sending a shared secret in the `ES-Client-Authentication` header.
            When this secret is populated, it will get added as the shared
            secret for every request made to Elasticsearch.
    ElasticsearchBridgeCredentials:
      title: ElasticsearchBridgeCredentials
      oneOf:
        - type: object
          allOf:
            - type: object
              properties:
                type:
                  type: string
                  enum:
                    - bridge_basic
            - $ref: '#/components/schemas/BridgeBasicCredential'
          required:
            - type
        - type: object
          properties:
            type:
              type: string
              enum:
                - bridge_basic_id
            value:
              $ref: '#/components/schemas/BridgeBasicCredentialId'
          required:
            - type
        - type: object
          allOf:
            - type: object
              properties:
                type:
                  type: string
                  enum:
                    - bridge_o_auth_client
            - $ref: '#/components/schemas/BridgeOAuthClientCredential'
          required:
            - type
        - type: object
          properties:
            type:
              type: string
              enum:
                - bridge_o_auth_client_id
            value:
              $ref: '#/components/schemas/BridgeOAuthClientCredentialId'
          required:
            - type
        - type: object
          allOf:
            - type: object
              properties:
                type:
                  type: string
                  enum:
                    - bridge_token
            - $ref: '#/components/schemas/BridgeTokenCredential'
          required:
            - type
        - type: object
          properties:
            type:
              type: string
              enum:
                - bridge_token_id
            value:
              $ref: '#/components/schemas/BridgeTokenCredentialId'
          required:
            - type
    ElasticsearchBridgeSharedSecret:
      title: ElasticsearchBridgeSharedSecret
      oneOf:
        - type: object
          allOf:
            - type: object
              properties:
                type:
                  type: string
                  enum:
                    - bridge_secret
            - $ref: '#/components/schemas/BridgeSecretCredential'
          required:
            - type
        - type: object
          properties:
            type:
              type: string
              enum:
                - bridge_secret_id
            value:
              $ref: '#/components/schemas/BridgeSecretCredentialId'
          required:
            - type
    ElasticsearchCredential:
      title: ElasticsearchCredential
      oneOf:
        - type: object
          allOf:
            - type: object
              properties:
                type:
                  type: string
                  enum:
                    - basic
            - $ref: '#/components/schemas/BasicCredential'
          required:
            - type
        - type: object
          properties:
            type:
              type: string
              enum:
                - basic_id
            value:
              $ref: '#/components/schemas/BasicCredentialId'
          required:
            - type
        - type: object
          properties:
            type:
              type: string
              enum:
                - bridge
            value:
              $ref: '#/components/schemas/ElasticsearchBridgeCredentials'
          required:
            - type
        - type: object
          allOf:
            - type: object
              properties:
                type:
                  type: string
                  enum:
                    - o_auth_client
            - $ref: '#/components/schemas/OAuthClientCredential'
          required:
            - type
        - type: object
          properties:
            type:
              type: string
              enum:
                - o_auth_client_id
            value:
              $ref: '#/components/schemas/OAuthClientCredentialId'
          required:
            - type
        - type: object
          allOf:
            - type: object
              properties:
                type:
                  type: string
                  enum:
                    - token
            - $ref: '#/components/schemas/TokenCredential'
          required:
            - type
        - type: object
          properties:
            type:
              type: string
              enum:
                - token_id
            value:
              $ref: '#/components/schemas/TokenCredentialId'
          required:
            - type
    ElasticsearchSharedSecret:
      title: ElasticsearchSharedSecret
      oneOf:
        - type: object
          properties:
            type:
              type: string
              enum:
                - bridge
            value:
              $ref: '#/components/schemas/ElasticsearchBridgeSharedSecret'
          required:
            - type
        - type: object
          allOf:
            - type: object
              properties:
                type:
                  type: string
                  enum:
                    - secret
            - $ref: '#/components/schemas/SecretCredential'
          required:
            - type
        - type: object
          properties:
            type:
              type: string
              enum:
                - secret_id
            value:
              $ref: '#/components/schemas/SecretCredentialId'
          required:
            - type
    EntraIdCredential:
      title: EntraIdCredential
      oneOf:
        - type: object
          allOf:
            - type: object
              properties:
                type:
                  type: string
                  enum:
                    - o_auth_client
            - $ref: '#/components/schemas/OAuthClientCredential'
          required:
            - type
        - type: object
          properties:
            type:
              type: string
              enum:
                - o_auth_client_id
            value:
              $ref: '#/components/schemas/OAuthClientCredentialId'
          required:
            - type
    GCSCredential:
      title: GCSCredential
      oneOf:
        - type: object
          allOf:
            - type: object
              properties:
                type:
                  type: string
                  enum:
                    - aws
            - $ref: '#/components/schemas/AwsCredential'
          required:
            - type
        - type: object
          properties:
            type:
              type: string
              enum:
                - aws_id
            value:
              $ref: '#/components/schemas/AwsCredentialId'
          required:
            - type
    GoogleChronicleCredential:
      title: GoogleChronicleCredential
      oneOf:
        - type: object
          allOf:
            - type: object
              properties:
                type:
                  type: string
                  enum:
                    - o_auth_client
            - $ref: '#/components/schemas/OAuthClientCredential'
          required:
            - type
        - type: object
          properties:
            type:
              type: string
              enum:
                - o_auth_client_id
            value:
              $ref: '#/components/schemas/OAuthClientCredentialId'
          required:
            - type
    GoogleCredential:
      title: GoogleCredential
      oneOf:
        - type: object
          allOf:
            - type: object
              properties:
                type:
                  type: string
                  enum:
                    - o_auth_client
            - $ref: '#/components/schemas/OAuthClientCredential'
          required:
            - type
        - type: object
          properties:
            type:
              type: string
              enum:
                - o_auth_client_id
            value:
              $ref: '#/components/schemas/OAuthClientCredentialId'
          required:
            - type
    Identity_EntraId:
      title: Microsoft Entra ID
      type: object
      description: Configuration for the Microsoft Entra ID Identity Provider
      properties:
        credential:
          $ref: '#/components/schemas/EntraIdCredential'
        tenant_id:
          type: string
          description: Azure Directory (tenant) ID.
        url:
          type: string
          nullable: true
          description: >-
            Optional URL override for the Microsoft Graph API. This should be
            the base URL for the API without any path components.
      required:
        - credential
        - tenant_id
    Identity_Google:
      title: Google Workspace
      type: object
      description: Configuration for the Google Identity Provider
      properties:
        client_email:
          type: string
          description: >-
            The client email associated with the service account key. Typically
            this will be of the form
            `<service-account-name>@<project-id>.iam.gserviceaccount.com`.
        credential:
          $ref: '#/components/schemas/GoogleCredential'
        delegate:
          type: string
          description: >-
            The email address of the user that the service account is
            impersonating for domain-wide delegation. For more information, see
            [this Google support
            article](https://support.google.com/a/answer/162106).
      required:
        - client_email
        - credential
        - delegate
    Identity_Okta:
      title: Okta
      type: object
      description: Configuration for the Okta Identity Provider
      properties:
        credential:
          $ref: '#/components/schemas/OktaCredential'
        url:
          type: string
          description: >-
            URL for the Okta API. This should be the base URL for the API,
            without any path components and must be HTTPS. For example,
            "https://tenant.okta.com".
      required:
        - credential
        - url
    Identity_PingOne:
      title: PingOne Identity
      type: object
      description: Configuration for the PingOne Identity Platform
      properties:
        auth_url:
          type: string
          description: The URL base for making authentication requests to PingOne.
        client_id:
          type: string
          description: The client ID for the application set up as a worker.
        credential:
          $ref: '#/components/schemas/PingOneCredential'
        organization_id:
          type: string
          description: The organization ID that the client app is a part of.
        url:
          type: string
          description: >-
            URL for the PingOne API. This should be the base URL for the API,
            without any path components.
      required:
        - auth_url
        - client_id
        - credential
        - organization_id
        - url
    JiraCredential:
      title: JiraCredential
      oneOf:
        - type: object
          allOf:
            - type: object
              properties:
                type:
                  type: string
                  enum:
                    - basic
            - $ref: '#/components/schemas/BasicCredential'
          required:
            - type
        - type: object
          properties:
            type:
              type: string
              enum:
                - basic_id
            value:
              $ref: '#/components/schemas/BasicCredentialId'
          required:
            - type
    MalwarebytesCredential:
      title: MalwarebytesCredential
      oneOf:
        - type: object
          allOf:
            - type: object
              properties:
                type:
                  type: string
                  enum:
                    - o_auth_client
            - $ref: '#/components/schemas/OAuthClientCredential'
          required:
            - type
        - type: object
          properties:
            type:
              type: string
              enum:
                - o_auth_client_id
            value:
              $ref: '#/components/schemas/OAuthClientCredentialId'
          required:
            - type
    Notifications_Jira:
      title: Jira
      type: object
      description: Configuration for Jira as a Notification Provider
      properties:
        credential:
          $ref: '#/components/schemas/JiraCredential'
        url:
          type: string
          description: >-
            URL for the Jira API. This should be the base URL for the API,
            without any path components and must be HTTPS. For example,
            "https://tenant.atlassian.net".
      required:
        - credential
        - url
    Notifications_Mock:
      title: Notifications Test
      type: object
      description: >-
        Configuration for the Mock in-memory notification handler. This provider
        is for testing purposes only.
      properties:
        channel:
          type: string
          nullable: true
          description: The channel to send notifications to.
    Notifications_Slack:
      title: Slack
      type: object
      description: Configuration for the Slack Notification Provider
      properties:
        channel:
          type: string
          description: >-
            The channel to send notifications to. Should be the ID of the
            desired channel.
        credential:
          $ref: '#/components/schemas/SlackCredential'
        url:
          type: string
          nullable: true
          description: >-
            Optional URL override for the Slack API. This should include the
            full path to the API endpoint.
          default: https://slack.com/api/chat.postMessage
      required:
        - channel
        - credential
    Notifications_Teams:
      title: Microsoft Teams
      type: object
      description: >-
        Configuration for sending messages to Microsoft Teams. This provider can
        be configured as a public webhook or with OAuth.
      properties:
        channel_id:
          type: string
          description: The ID of the channel to send messages to.
        credential:
          $ref: '#/components/schemas/TeamsCredential'
        endpoint:
          type: string
          nullable: true
          description: >-
            The URL of the endpoint to send messages to. Only specified here if
            OAuth. For public, please refer to TeamsCredential.
        team_id:
          type: string
          description: The ID of the team to send messages to.
        tenant_id:
          type: string
          nullable: true
          description: Azure Directory (tenant) ID. Only if OAuth is used.
      required:
        - channel_id
        - credential
        - team_id
    NozomiVantageCredential:
      title: NozomiVantageCredential
      oneOf:
        - type: object
          allOf:
            - type: object
              properties:
                type:
                  type: string
                  enum:
                    - basic
            - $ref: '#/components/schemas/BasicCredential'
          required:
            - type
        - type: object
          properties:
            type:
              type: string
              enum:
                - basic_id
            value:
              $ref: '#/components/schemas/BasicCredentialId'
          required:
            - type
    NucleusCredential:
      title: NucleusCredential
      oneOf:
        - type: object
          allOf:
            - type: object
              properties:
                type:
                  type: string
                  enum:
                    - token
            - $ref: '#/components/schemas/TokenCredential'
          required:
            - type
        - type: object
          properties:
            type:
              type: string
              enum:
                - token_id
            value:
              $ref: '#/components/schemas/TokenCredentialId'
          required:
            - type
      description: Supported credential types for Nucleus
    OktaCredential:
      title: OktaCredential
      oneOf:
        - type: object
          allOf:
            - type: object
              properties:
                type:
                  type: string
                  enum:
                    - o_auth_client
            - $ref: '#/components/schemas/OAuthClientCredential'
          required:
            - type
        - type: object
          properties:
            type:
              type: string
              enum:
                - o_auth_client_id
            value:
              $ref: '#/components/schemas/OAuthClientCredentialId'
          required:
            - type
        - type: object
          allOf:
            - type: object
              properties:
                type:
                  type: string
                  enum:
                    - token
            - $ref: '#/components/schemas/TokenCredential'
          required:
            - type
        - type: object
          properties:
            type:
              type: string
              enum:
                - token_id
            value:
              $ref: '#/components/schemas/TokenCredentialId'
          required:
            - type
    PagerDutyCredential:
      title: PagerDutyCredential
      oneOf:
        - type: object
          allOf:
            - type: object
              properties:
                type:
                  type: string
                  enum:
                    - token
            - $ref: '#/components/schemas/TokenCredential'
          required:
            - type
        - type: object
          properties:
            type:
              type: string
              enum:
                - token_id
            value:
              $ref: '#/components/schemas/TokenCredentialId'
          required:
            - type
    PingOneCredential:
      title: PingOneCredential
      oneOf:
        - type: object
          allOf:
            - type: object
              properties:
                type:
                  type: string
                  enum:
                    - token
            - $ref: '#/components/schemas/TokenCredential'
          required:
            - type
        - type: object
          properties:
            type:
              type: string
              enum:
                - token_id
            value:
              $ref: '#/components/schemas/TokenCredentialId'
          required:
            - type
    ProviderConfig:
      title: ProviderConfig
      oneOf:
        - type: object
          allOf:
            - type: object
              properties:
                type:
                  type: string
                  enum:
                    - assets_armis_centrix
            - $ref: '#/components/schemas/Assets_ArmisCentrix'
          required:
            - type
        - type: object
          allOf:
            - type: object
              properties:
                type:
                  type: string
                  enum:
                    - assets_nozomi_vantage
            - $ref: '#/components/schemas/Assets_NozomiVantage'
          required:
            - type
        - type: object
          allOf:
            - type: object
              properties:
                type:
                  type: string
                  enum:
                    - assets_servicenow
            - $ref: '#/components/schemas/Assets_ServiceNow'
          required:
            - type
        - type: object
          allOf:
            - type: object
              properties:
                type:
                  type: string
                  enum:
                    - assets_servicenow_mock
            - $ref: '#/components/schemas/Assets_ServiceNow_Mock'
          required:
            - type
        - type: object
          allOf:
            - type: object
              properties:
                type:
                  type: string
                  enum:
                    - edr_crowdstrike
            - $ref: '#/components/schemas/Edr_CrowdStrike'
          required:
            - type
        - type: object
          allOf:
            - type: object
              properties:
                type:
                  type: string
                  enum:
                    - edr_defender
            - $ref: '#/components/schemas/Edr_Defender'
          required:
            - type
        - type: object
          allOf:
            - type: object
              properties:
                type:
                  type: string
                  enum:
                    - edr_malwarebytes
            - $ref: '#/components/schemas/Edr_Malwarebytes'
          required:
            - type
        - type: object
          allOf:
            - type: object
              properties:
                type:
                  type: string
                  enum:
                    - edr_sentinelone
            - $ref: '#/components/schemas/Edr_SentinelOne'
          required:
            - type
        - type: object
          allOf:
            - type: object
              properties:
                type:
                  type: string
                  enum:
                    - edr_sophos
            - $ref: '#/components/schemas/Edr_Sophos'
          required:
            - type
        - type: object
          allOf:
            - type: object
              properties:
                type:
                  type: string
                  enum:
                    - identity_entra_id
            - $ref: '#/components/schemas/Identity_EntraId'
          required:
            - type
        - type: object
          allOf:
            - type: object
              properties:
                type:
                  type: string
                  enum:
                    - identity_google
            - $ref: '#/components/schemas/Identity_Google'
          required:
            - type
        - type: object
          allOf:
            - type: object
              properties:
                type:
                  type: string
                  enum:
                    - identity_okta
            - $ref: '#/components/schemas/Identity_Okta'
          required:
            - type
        - type: object
          allOf:
            - type: object
              properties:
                type:
                  type: string
                  enum:
                    - identity_pingone
            - $ref: '#/components/schemas/Identity_PingOne'
          required:
            - type
        - type: object
          allOf:
            - type: object
              properties:
                type:
                  type: string
                  enum:
                    - notifications_jira
            - $ref: '#/components/schemas/Notifications_Jira'
          required:
            - type
        - type: object
          allOf:
            - type: object
              properties:
                type:
                  type: string
                  enum:
                    - notifications_mock_notifications
            - $ref: '#/components/schemas/Notifications_Mock'
          required:
            - type
        - type: object
          allOf:
            - type: object
              properties:
                type:
                  type: string
                  enum:
                    - notifications_slack
            - $ref: '#/components/schemas/Notifications_Slack'
          required:
            - type
        - type: object
          allOf:
            - type: object
              properties:
                type:
                  type: string
                  enum:
                    - notifications_teams
            - $ref: '#/components/schemas/Notifications_Teams'
          required:
            - type
        - type: object
          allOf:
            - type: object
              properties:
                type:
                  type: string
                  enum:
                    - siem_elasticsearch
            - $ref: '#/components/schemas/SIEM_Elasticsearch'
          required:
            - type
        - type: object
          allOf:
            - type: object
              properties:
                type:
                  type: string
                  enum:
                    - siem_google_chronicle
            - $ref: '#/components/schemas/SIEM_GoogleChronicle'
          required:
            - type
        - type: object
          allOf:
            - type: object
              properties:
                type:
                  type: string
                  enum:
                    - siem_mock_siem
            - $ref: '#/components/schemas/SIEM_Mock'
          required:
            - type
        - type: object
          allOf:
            - type: object
              properties:
                type:
                  type: string
                  enum:
                    - siem_q_radar
            - $ref: '#/components/schemas/SIEM_QRadar'
          required:
            - type
        - type: object
          allOf:
            - type: object
              properties:
                type:
                  type: string
                  enum:
                    - siem_rapid7_insightidr
            - $ref: '#/components/schemas/SIEM_Rapid7InsightIDR'
          required:
            - type
        - type: object
          allOf:
            - type: object
              properties:
                type:
                  type: string
                  enum:
                    - siem_sentinel
            - $ref: '#/components/schemas/SIEM_Sentinel'
          required:
            - type
        - type: object
          allOf:
            - type: object
              properties:
                type:
                  type: string
                  enum:
                    - siem_splunk
            - $ref: '#/components/schemas/SIEM_Splunk'
          required:
            - type
        - type: object
          allOf:
            - type: object
              properties:
                type:
                  type: string
                  enum:
                    - siem_sumo_logic
            - $ref: '#/components/schemas/SIEM_SumoLogic'
          required:
            - type
        - type: object
          allOf:
            - type: object
              properties:
                type:
                  type: string
                  enum:
                    - sink_aws_security_lake
            - $ref: '#/components/schemas/Sink_AwsSecurityLake'
          required:
            - type
        - type: object
          allOf:
            - type: object
              properties:
                type:
                  type: string
                  enum:
                    - sink_aws_sqs
            - $ref: '#/components/schemas/Sink_AwsSQS'
          required:
            - type
        - type: object
          allOf:
            - type: object
              properties:
                type:
                  type: string
                  enum:
                    - sink_azure_monitor_logs
            - $ref: '#/components/schemas/Sink_AzureMonitorLogs'
          required:
            - type
        - type: object
          allOf:
            - type: object
              properties:
                type:
                  type: string
                  enum:
                    - sink_crowdstrike_hec
            - $ref: '#/components/schemas/Sink_CrowdstrikeHEC'
          required:
            - type
        - type: object
          allOf:
            - type: object
              properties:
                type:
                  type: string
                  enum:
                    - sink_elasticsearch
            - $ref: '#/components/schemas/Sink_Elasticsearch'
          required:
            - type
        - type: object
          allOf:
            - type: object
              properties:
                type:
                  type: string
                  enum:
                    - sink_mock_sink
            - $ref: '#/components/schemas/Sink_Mock'
          required:
            - type
        - type: object
          allOf:
            - type: object
              properties:
                type:
                  type: string
                  enum:
                    - sink_splunk
            - $ref: '#/components/schemas/Sink_Splunk'
          required:
            - type
        - type: object
          allOf:
            - type: object
              properties:
                type:
                  type: string
                  enum:
                    - storage_aws_s3
            - $ref: '#/components/schemas/Storage_AwsS3'
          required:
            - type
        - type: object
          allOf:
            - type: object
              properties:
                type:
                  type: string
                  enum:
                    - storage_azure_blob
            - $ref: '#/components/schemas/Storage_AzureBlob'
          required:
            - type
        - type: object
          allOf:
            - type: object
              properties:
                type:
                  type: string
                  enum:
                    - storage_gcs
            - $ref: '#/components/schemas/Storage_GCS'
          required:
            - type
        - type: object
          allOf:
            - type: object
              properties:
                type:
                  type: string
                  enum:
                    - storage_mock_storage
            - $ref: '#/components/schemas/Storage_Mock'
          required:
            - type
        - type: object
          allOf:
            - type: object
              properties:
                type:
                  type: string
                  enum:
                    - ticketing_autotask
            - $ref: '#/components/schemas/Ticketing_Autotask'
          required:
            - type
        - type: object
          allOf:
            - type: object
              properties:
                type:
                  type: string
                  enum:
                    - ticketing_jira
            - $ref: '#/components/schemas/Ticketing_Jira'
          required:
            - type
        - type: object
          allOf:
            - type: object
              properties:
                type:
                  type: string
                  enum:
                    - ticketing_mock_ticketing
            - $ref: '#/components/schemas/Ticketing_Mock'
          required:
            - type
        - type: object
          allOf:
            - type: object
              properties:
                type:
                  type: string
                  enum:
                    - ticketing_pagerduty
            - $ref: '#/components/schemas/Ticketing_PagerDuty'
          required:
            - type
        - type: object
          allOf:
            - type: object
              properties:
                type:
                  type: string
                  enum:
                    - ticketing_servicenow
            - $ref: '#/components/schemas/Ticketing_ServiceNow'
          required:
            - type
        - type: object
          allOf:
            - type: object
              properties:
                type:
                  type: string
                  enum:
                    - ticketing_servicenow_sir
            - $ref: '#/components/schemas/Ticketing_ServiceNowSIR'
          required:
            - type
        - type: object
          allOf:
            - type: object
              properties:
                type:
                  type: string
                  enum:
                    - ticketing_torq
            - $ref: '#/components/schemas/Ticketing_Torq'
          required:
            - type
        - type: object
          allOf:
            - type: object
              properties:
                type:
                  type: string
                  enum:
                    - vulnerabilities_crowdstrike
            - $ref: '#/components/schemas/Vulnerabilities_CrowdStrike'
          required:
            - type
        - type: object
          allOf:
            - type: object
              properties:
                type:
                  type: string
                  enum:
                    - vulnerabilities_nucleus
            - $ref: '#/components/schemas/Vulnerabilities_Nucleus'
          required:
            - type
        - type: object
          allOf:
            - type: object
              properties:
                type:
                  type: string
                  enum:
                    - vulnerabilities_qualys_cloud
            - $ref: '#/components/schemas/Vulnerabilities_QualysCloud'
          required:
            - type
        - type: object
          allOf:
            - type: object
              properties:
                type:
                  type: string
                  enum:
                    - vulnerabilities_rapid7_insight_cloud
            - $ref: '#/components/schemas/Vulnerabilities_Rapid7InsightCloud'
          required:
            - type
        - type: object
          allOf:
            - type: object
              properties:
                type:
                  type: string
                  enum:
                    - vulnerabilities_tanium_cloud
            - $ref: '#/components/schemas/Vulnerabilities_TaniumCloud'
          required:
            - type
        - type: object
          allOf:
            - type: object
              properties:
                type:
                  type: string
                  enum:
                    - vulnerabilities_tenable_cloud
            - $ref: '#/components/schemas/Vulnerabilities_TenableCloud'
          required:
            - type
    ProviderConfigId:
      title: ProviderConfigId
      type: string
      enum:
        - assets_armis_centrix
        - assets_nozomi_vantage
        - assets_servicenow
        - assets_servicenow_mock
        - edr_crowdstrike
        - edr_defender
        - edr_malwarebytes
        - edr_sentinelone
        - edr_sophos
        - identity_entra_id
        - identity_google
        - identity_okta
        - identity_pingone
        - notifications_jira
        - notifications_mock_notifications
        - notifications_slack
        - notifications_teams
        - siem_elasticsearch
        - siem_google_chronicle
        - siem_mock_siem
        - siem_q_radar
        - siem_rapid7_insightidr
        - siem_sentinel
        - siem_splunk
        - siem_sumo_logic
        - sink_aws_security_lake
        - sink_aws_sqs
        - sink_azure_monitor_logs
        - sink_crowdstrike_hec
        - sink_elasticsearch
        - sink_mock_sink
        - sink_splunk
        - storage_aws_s3
        - storage_azure_blob
        - storage_gcs
        - storage_mock_storage
        - ticketing_autotask
        - ticketing_jira
        - ticketing_mock_ticketing
        - ticketing_pagerduty
        - ticketing_servicenow
        - ticketing_servicenow_sir
        - ticketing_torq
        - vulnerabilities_crowdstrike
        - vulnerabilities_nucleus
        - vulnerabilities_qualys_cloud
        - vulnerabilities_rapid7_insight_cloud
        - vulnerabilities_tanium_cloud
        - vulnerabilities_tenable_cloud
        - '*'
      description: List of supported providers.
    QRadarCredential:
      title: QRadarCredential
      oneOf:
        - type: object
          allOf:
            - type: object
              properties:
                type:
                  type: string
                  enum:
                    - token
            - $ref: '#/components/schemas/TokenCredential'
          required:
            - type
        - type: object
          properties:
            type:
              type: string
              enum:
                - token_id
            value:
              $ref: '#/components/schemas/TokenCredentialId'
          required:
            - type
    QualysCloudCredential:
      title: QualysCloudCredential
      oneOf:
        - type: object
          allOf:
            - type: object
              properties:
                type:
                  type: string
                  enum:
                    - basic
            - $ref: '#/components/schemas/BasicCredential'
          required:
            - type
        - type: object
          properties:
            type:
              type: string
              enum:
                - basic_id
            value:
              $ref: '#/components/schemas/BasicCredentialId'
          required:
            - type
    Rapid7InsightCloudCredential:
      title: Rapid7InsightCloudCredential
      oneOf:
        - type: object
          allOf:
            - type: object
              properties:
                type:
                  type: string
                  enum:
                    - token
            - $ref: '#/components/schemas/TokenCredential'
          required:
            - type
        - type: object
          properties:
            type:
              type: string
              enum:
                - token_id
            value:
              $ref: '#/components/schemas/TokenCredentialId'
          required:
            - type
    SIEM_Elasticsearch:
      title: Elasticsearch
      type: object
      description: >-
        Configuration for Elasticsearch search and analytics engine. Supports
        both managed and self-hosted Elasticsearch deployments
      properties:
        auth_options:
          $ref: '#/components/schemas/ElasticsearchAuthOptions'
          nullable: true
        create_index:
          type: string
          nullable: true
          description: >-
            Optional. The index or data stream to use when writing events.
            Defaults to the 'index' setting if not set.
        credential:
          $ref: '#/components/schemas/ElasticsearchCredential'
        index:
          type: string
          nullable: true
          description: >-
            Optional. The index, data stream, or index alias to read events
            from.
          default: _all
        skip_tls_verify:
          type: boolean
          nullable: true
          description: >-
            If true, skips verification of the Elasticsearch server's TLS
            certificate.
          default: false
        url:
          type: string
          description: >-
            URL for the Elasticsearch API. This should be the base URL for the
            API, without any path components and must be HTTPS. For example,
            "https://tenant.elastic.com".
      required:
        - credential
        - url
    SIEM_GoogleChronicle:
      title: Google Chronicle
      type: object
      description: Configuration for Google Chronicle as a SIEM Provider.
      properties:
        ingestion_credential:
          $ref: '#/components/schemas/GoogleChronicleCredential'
          nullable: true
          description: >-
            Optional ingestion credential. Without this credential the provider
            will not be able to ingest events.
        ingestion_url:
          type: string
          nullable: true
          description: >-
            (Optional) Ingestion URL for the Google Chronicle instance. This
            should be the base event ingestion URL, without any path components.
            Default "https://malachiteingestion-pa.googleapis.com"
          pattern: ^https://.*$
          title: Ingestion API URL
        search_credential:
          $ref: '#/components/schemas/GoogleChronicleCredential'
        search_url:
          type: string
          nullable: true
          description: >-
            Search URL for the Google Chronicle instance. This should be the
            base event search URL, without any path components. Default
            "https://backstory.googleapis.com".
          pattern: ^https://.*$
          title: Search API URL
      required:
        - search_credential
    SIEM_Mock:
      title: SIEM Test
      type: object
      description: >-
        Configuration for the Synqly mock in-memory SIEM handler. This provider
        is for testing purposes only and does not retain events pushed to it.
      properties:
        index:
          type: string
          nullable: true
          description: Name of the index where events are stored.
    SIEM_QRadar:
      title: IBM QRadar
      type: object
      description: Configuration for IBM QRadar as a SIEM Provider.
      properties:
        collection_port:
          type: integer
          description: >-
            The QRadar HTTP Receiver URL, stored as a secret. This URL has a
            special port in QRadar and is stored in a credential to protect that
            information. See https://www.youtube.com/watch?v=UEBLVVNpyfg for a
            demonstration of setting up and mapping and HTTP Receiver in QRadar.
          title: Collection Port
        credential:
          $ref: '#/components/schemas/QRadarCredential'
        skip_tls_verify:
          type: boolean
          nullable: true
          description: If true, skips verification of the QRadar server's TLS certificate.
          default: false
        url:
          type: string
          description: >-
            URL for the QRadar instance. This should be the base URL instance,
            without any path components and must be HTTPS. For example,
            "https://qradar.westus2.cloudapp.azure.com".
          pattern: ^https://.*$
          title: API URL
      required:
        - collection_port
        - credential
        - url
    SIEM_Rapid7InsightIDR:
      title: Rapid7 InsightIDR
      type: object
      description: Configuration for Rapid7 InsightIDR as a SIEM Provider.
      properties:
        credential:
          $ref: '#/components/schemas/Rapid7InsightCloudCredential'
        url:
          type: string
          description: >-
            URL for the Rapid7 API. This should be the base URL for the API,
            without any path components and must be HTTPS. For example,
            "https://us2.api.insight.rapid7.com".
          pattern: ^https://.*$
          title: API URL
      required:
        - credential
        - url
    SIEM_Sentinel:
      title: Microsoft Sentinel
      type: object
      description: Configuration for Microsoft Sentinel SIEM Product.
      properties:
        credential:
          $ref: '#/components/schemas/SentinelCredential'
        default_tables:
          type: array
          items:
            type: string
          nullable: true
          description: >-
            The default tables to use for queries. Supply this value if you
            would like to a subset of the default tables or non-ASIM data tables
            with Sentinel/Log Analytics queries. If more than one table is
            specified, a union operator will join them to query all of the
            tables at once. Supply a single value with "_" if you would like to
            query all tables without the normalizing ASIM transformations.
            **Note** that a single "_" entry will map to a 'union \*' query.
            Relying heavily on these queries is generally discouraged by
            Sentinel because they are slower and more resource intensive.
          default:
            - _Im_AuditEvent
            - _Im_Authentication
            - _Im_DhcpEvent
            - _Im_Dns
            - _Im_DnsBuiltIn
            - _Im_FileEvent
            - _Im_NetworkSession
            - _Im_Process_EmptyV01
            - _Im_ProcessCreate
            - _Im_ProcessEvent
            - _Im_ProcessTerminate
            - _Im_RegistryEvent
            - _Im_UserManagement
            - _Im_WebSession
        logs_url:
          type: string
          nullable: true
          description: >-
            The root URL for the Microsoft Azure Monitor Logs API. This is
            optional and should only be supplied if using an alternate Microsoft
            cloud, such as GovCloud.
          default: https://api.loganalytics.azure.com
        management_url:
          type: string
          nullable: true
          description: >-
            The root URL for the Microsoft Azure Management API. This is
            optional and should only be supplied if using an alternate Microsoft
            cloud, such as GovCloud.
          default: https://management.azure.com
        resource_group:
          type: string
          description: >-
            The Azure resource group name that contains the Microsoft Sentinel
            workspace.
        subscription_id:
          type: string
          description: >-
            The Azure subscription ID that contains the Microsoft Sentinel
            workspace.
        tenant_id:
          type: string
          description: >-
            The Azure Active Directory tenant ID that contains the Microsoft
            Sentinel workspace.
        workspace_id:
          type: string
          description: The ID of the Microsoft Sentinel Log Analytics workspace.
        workspace_name:
          type: string
          description: The name of the Microsoft Sentinel Log Analytics workspace.
      required:
        - credential
        - resource_group
        - subscription_id
        - tenant_id
        - workspace_id
        - workspace_name
    SIEM_Splunk:
      title: Splunk
      type: object
      description: >-
        Configuration for Splunk as a SIEM Provider. This integration allows
        sending data to Splunk using an HTTP Event Collector (HEC).
        Additionally, it can be used to query Splunk using the Splunk Search
        Service.
      properties:
        hec_credential:
          $ref: '#/components/schemas/SplunkHECToken'
        hec_url:
          type: string
          description: >-
            URL for the Splunk HEC endpoint. This must include the full path to
            the HEC endpoint. For example,
            "https://tenant.cloud.splunk.com:8088/services_collector_event".
        index:
          type: string
          nullable: true
          description: >-
            Splunk index to send events to. If not provided, will use the
            default index for the Splunk collector.
        search_service_credential:
          $ref: '#/components/schemas/SplunkSearchCredential'
          nullable: true
          description: >-
            Optional id of a credential used for connecting to the Splunk search
            service. If not provided, querying is disabled.
        search_service_url:
          type: string
          nullable: true
          description: >-
            Optional URL used for connecting to the Splunk search service. If
            not provided, querying is disabled.
        skip_tls_verify:
          type: boolean
          nullable: true
          description: If true, skips verification of the Splunk server's TLS certificate.
          default: false
        source:
          type: string
          nullable: true
          description: >-
            Splunk source to send events to. If not provided, will use the
            default source for the Splunk collector.
        source_type:
          type: string
          nullable: true
          description: >-
            Splunk source type to send events to. If not provided, will use the
            default source type for the Splunk collector.
      required:
        - hec_credential
        - hec_url
    SIEM_SumoLogic:
      title: Sumo Logic Cloud SIEM
      type: object
      description: Configuration for Sumo Logic Cloud SIEM.
      properties:
        auto_parse_logs:
          type: boolean
          nullable: true
          description: >-
            Automatically parse logs as JSON when running log queries against
            Sumo Logic.
          default: true
          title: Auto Parse Logs
        collection_url:
          $ref: '#/components/schemas/SumoLogicCollectionUrl'
          nullable: true
          description: Required if you need to send Sumo Logic events from the Synqly API.
        credential:
          $ref: '#/components/schemas/SumoLogicCredential'
        siem_logs_only:
          type: boolean
          nullable: true
          description: >-
            Only query for logs that have been processed into the Sumo Logic
            Cloud SIEM app.
          default: false
          title: SIEM Logs Only
        url:
          type: string
          description: >-
            Your Sumo Logic API endpoint. See
            https://help.sumologic.com/docs/api/getting-started/#sumo-logic-endpoints-by-deployment-and-firewall-security
            for help determining which base URL to use.
          pattern: ^https://.*$
          title: API URL
      required:
        - credential
        - url
    SentinelCredential:
      title: SentinelCredential
      oneOf:
        - type: object
          allOf:
            - type: object
              properties:
                type:
                  type: string
                  enum:
                    - o_auth_client
            - $ref: '#/components/schemas/OAuthClientCredential'
          required:
            - type
        - type: object
          properties:
            type:
              type: string
              enum:
                - o_auth_client_id
            value:
              $ref: '#/components/schemas/OAuthClientCredentialId'
          required:
            - type
    SentinelOneCredential:
      title: SentinelOneCredential
      oneOf:
        - type: object
          allOf:
            - type: object
              properties:
                type:
                  type: string
                  enum:
                    - token
            - $ref: '#/components/schemas/TokenCredential'
          required:
            - type
        - type: object
          properties:
            type:
              type: string
              enum:
                - token_id
            value:
              $ref: '#/components/schemas/TokenCredentialId'
          required:
            - type
    ServiceNowCredential:
      title: ServiceNowCredential
      oneOf:
        - type: object
          allOf:
            - type: object
              properties:
                type:
                  type: string
                  enum:
                    - basic
            - $ref: '#/components/schemas/BasicCredential'
          required:
            - type
        - type: object
          properties:
            type:
              type: string
              enum:
                - basic_id
            value:
              $ref: '#/components/schemas/BasicCredentialId'
          required:
            - type
        - type: object
          allOf:
            - type: object
              properties:
                type:
                  type: string
                  enum:
                    - token
            - $ref: '#/components/schemas/TokenCredential'
          required:
            - type
        - type: object
          properties:
            type:
              type: string
              enum:
                - token_id
            value:
              $ref: '#/components/schemas/TokenCredentialId'
          required:
            - type
    Sink_AwsSQS:
      title: AWS SQS
      type: object
      description: Configuration for AWS Simple Queue Service (SQS) as a Sink Provider.
      properties:
        credential:
          $ref: '#/components/schemas/AwsSQSCredential'
          description: >-
            Credential ID that stores AWS authentication key and secret. This
            token pair must have write access to the configured SQS queue
        region:
          type: string
          nullable: true
          description: >-
            Override the default AWS region for this integration. If not
            present, the region will be inferred from the URL.
        url:
          type: string
          description: >-
            URL of the SQS queue where events are sent. Must be in the format
            `https://sqs.{region}.amazonaws.com_{account_id}/{queue_name}`.
      required:
        - credential
        - url
    Sink_AwsSecurityLake:
      title: AWS Security Lake
      type: object
      description: >-
        Configuration for AWS Security Lake provider. Events are written
        directly to an AWS S3 bucket in Apache Parquet format.
      properties:
        credential:
          $ref: '#/components/schemas/AwsSecurityLakeCredential'
        region:
          type: string
          nullable: true
          description: >-
            Override the default AWS region for this integration. If not
            present, the region will be inferred from the URL.
        url:
          type: string
          description: URL of the S3 bucket where the AWS Security Lake events are stored.
      required:
        - credential
        - url
    Sink_AzureMonitorLogs:
      title: Azure Monitor Logs
      type: object
      description: >-
        Configuration for Azure Monitor Logs as a Sink Provider. Azure Monitor
        Logs is a feature of Azure Monitor that collects and organizes log and
        performance data from monitored resources.
      properties:
        client_id:
          type: string
          description: Azure Client (Application) ID.
        credential:
          $ref: '#/components/schemas/AzureMonitorLogsCredential'
        rule_id:
          type: string
          description: Data collection rule immutable ID.
        stream_name:
          type: string
          description: Name of the Data collection rule stream.
        tenant_id:
          type: string
          description: Azure Directory (tenant) ID.
        url:
          type: string
          description: URL of the Azure data collection endpoint.
      required:
        - client_id
        - credential
        - rule_id
        - stream_name
        - tenant_id
        - url
    Sink_CrowdstrikeHEC:
      title: Crowdstrike HEC
      type: object
      description: Configuration for Crowdstrike HEC as a Sink Provider
      properties:
        credential:
          $ref: '#/components/schemas/CrowdstrikeHECCredential'
        url:
          type: string
          description: >-
            API URL for the CrowdStrike HEC API. This must be an HTTPS URL, for
            example
            "https://<some-guid>.ingest.us-2.crowdstrike.com/services/collector".
          pattern: ^https://.*$
          title: Crowdstrike HEC API URL
      required:
        - credential
        - url
    Sink_Elasticsearch:
      title: Elasticsearch
      type: object
      description: >-
        Configuration for Elasticsearch search and analytics engine. Supports
        both managed and self-hosted Elasticsearch deployments
      properties:
        auth_options:
          $ref: '#/components/schemas/ElasticsearchAuthOptions'
          nullable: true
        create_index:
          type: string
          description: The index or data stream to use when writing events.
        credential:
          $ref: '#/components/schemas/ElasticsearchCredential'
        skip_tls_verify:
          type: boolean
          nullable: true
          description: >-
            If true, skips verification of the Elasticsearch server's TLS
            certificate.
          default: false
        url:
          type: string
          description: >-
            URL for the Elasticsearch API. This should be the base URL for the
            API, without any path components and must be HTTPS. For example,
            "https://tenant.elastic.com".
      required:
        - create_index
        - credential
        - url
    Sink_Mock:
      title: Sink Test
      type: object
      description: >-
        Configuration for the Synqly mock in-memory sink handler. This provider
        is for testing purposes only and does not retain events pushed to it.
      properties:
        destination:
          type: string
          nullable: true
          description: >-
            Name of the destination where events are stored. This property is
            unused.
    Sink_Splunk:
      title: Splunk
      type: object
      description: >-
        Configuration for Splunk as a Sink provider. This integration allows
        sending data to Splunk using an HTTP Event Collector (HEC).
      properties:
        hec_credential:
          $ref: '#/components/schemas/SplunkHECToken'
        hec_url:
          type: string
          description: >-
            URL for the Splunk HEC endpoint. This must include the full path to
            the HEC endpoint. For example,
            "https://tenant.cloud.splunk.com:8088/services_collector_event".
        index:
          type: string
          nullable: true
          description: >-
            Splunk index to send events to. If not provided, will use the
            default index for the Splunk collector.
        skip_tls_verify:
          type: boolean
          nullable: true
          description: If true, skips verification of the Splunk server's TLS certificate.
          default: false
        source:
          type: string
          nullable: true
          description: >-
            Splunk source to send events to. If not provided, will use the
            default source for the Splunk collector.
        source_type:
          type: string
          nullable: true
          description: >-
            Splunk source type to send events to. If not provided, will use the
            default source type for the Splunk collector.
      required:
        - hec_credential
        - hec_url
    SlackCredential:
      title: SlackCredential
      oneOf:
        - type: object
          allOf:
            - type: object
              properties:
                type:
                  type: string
                  enum:
                    - token
            - $ref: '#/components/schemas/TokenCredential'
          required:
            - type
        - type: object
          properties:
            type:
              type: string
              enum:
                - token_id
            value:
              $ref: '#/components/schemas/TokenCredentialId'
          required:
            - type
    SophosCredential:
      title: SophosCredential
      oneOf:
        - type: object
          allOf:
            - type: object
              properties:
                type:
                  type: string
                  enum:
                    - o_auth_client
            - $ref: '#/components/schemas/OAuthClientCredential'
          required:
            - type
        - type: object
          properties:
            type:
              type: string
              enum:
                - o_auth_client_id
            value:
              $ref: '#/components/schemas/OAuthClientCredentialId'
          required:
            - type
    SplunkBridgeHECToken:
      title: SplunkBridgeHECToken
      oneOf:
        - type: object
          allOf:
            - type: object
              properties:
                type:
                  type: string
                  enum:
                    - bridge_token
            - $ref: '#/components/schemas/BridgeTokenCredential'
          required:
            - type
        - type: object
          properties:
            type:
              type: string
              enum:
                - bridge_token_id
            value:
              $ref: '#/components/schemas/BridgeTokenCredentialId'
          required:
            - type
    SplunkBridgeSearchCredential:
      title: SplunkBridgeSearchCredential
      oneOf:
        - type: object
          allOf:
            - type: object
              properties:
                type:
                  type: string
                  enum:
                    - bridge_token
            - $ref: '#/components/schemas/BridgeTokenCredential'
          required:
            - type
        - type: object
          properties:
            type:
              type: string
              enum:
                - bridge_token_id
            value:
              $ref: '#/components/schemas/BridgeTokenCredentialId'
          required:
            - type
    SplunkHECToken:
      title: SplunkHECToken
      oneOf:
        - type: object
          properties:
            type:
              type: string
              enum:
                - bridge
            value:
              $ref: '#/components/schemas/SplunkBridgeHECToken'
          required:
            - type
        - type: object
          allOf:
            - type: object
              properties:
                type:
                  type: string
                  enum:
                    - token
            - $ref: '#/components/schemas/TokenCredential'
          required:
            - type
        - type: object
          properties:
            type:
              type: string
              enum:
                - token_id
            value:
              $ref: '#/components/schemas/TokenCredentialId'
          required:
            - type
    SplunkSearchCredential:
      title: SplunkSearchCredential
      oneOf:
        - type: object
          properties:
            type:
              type: string
              enum:
                - bridge
            value:
              $ref: '#/components/schemas/SplunkBridgeSearchCredential'
          required:
            - type
        - type: object
          allOf:
            - type: object
              properties:
                type:
                  type: string
                  enum:
                    - token
            - $ref: '#/components/schemas/TokenCredential'
          required:
            - type
        - type: object
          properties:
            type:
              type: string
              enum:
                - token_id
            value:
              $ref: '#/components/schemas/TokenCredentialId'
          required:
            - type
    Storage_AwsS3:
      title: AWS S3
      type: object
      description: Configuration for AWS S3 as a Storage Provider
      properties:
        bucket:
          type: string
          description: Name of the AWS S3 bucket where files are stored.
        credential:
          $ref: '#/components/schemas/AwsS3Credential'
        endpoint:
          type: string
          nullable: true
          description: >-
            Endpoint used for connecting to the external service. If not
            provided, will connect to the default endpoint for the Provider.
        region:
          type: string
          description: AWS region where the S3 bucket is located.
        transforms:
          type: array
          items:
            $ref: '#/components/schemas/TransformId'
          nullable: true
          description: >-
            Optional list of transformations used to modify requests before they
            are sent to the external service.
      required:
        - bucket
        - credential
        - region
    Storage_AzureBlob:
      title: Azure Blob Storage
      type: object
      description: Configuration for Azure Blob Storage as a Storage Provider
      properties:
        bucket:
          type: string
          description: Name of the blob container where files are stored.
        credential:
          $ref: '#/components/schemas/AzureBlobCredential'
        transforms:
          type: array
          items:
            $ref: '#/components/schemas/TransformId'
          nullable: true
          description: >-
            Optional list of transformations used to modify requests before they
            are sent to the external service.
      required:
        - bucket
        - credential
    Storage_GCS:
      title: Google Cloud Storage
      type: object
      description: Configuration for Google Cloud Storage for storing unstructured data
      properties:
        bucket:
          type: string
          description: Name of the bucket where files are stored.
        credential:
          $ref: '#/components/schemas/GCSCredential'
        region:
          type: string
          description: Google Cloud region where the bucket is located.
        transforms:
          type: array
          items:
            $ref: '#/components/schemas/TransformId'
          nullable: true
          description: >-
            Optional list of transformations used to modify requests before they
            are sent to the external service.
      required:
        - bucket
        - credential
        - region
    Storage_Mock:
      title: Storage Test
      type: object
      description: >-
        Configuration for the Synqly mock in-memory storage handler. This
        provider is for testing purposes only and does not retain files pushed
        to it.
      properties:
        bucket:
          type: string
          description: Name of the bucket where files are stored.
      required:
        - bucket
    SumoLogicCollectionUrl:
      title: SumoLogicCollectionUrl
      oneOf:
        - type: object
          allOf:
            - type: object
              properties:
                type:
                  type: string
                  enum:
                    - secret
            - $ref: '#/components/schemas/SecretCredential'
          required:
            - type
        - type: object
          properties:
            type:
              type: string
              enum:
                - secret_id
            value:
              $ref: '#/components/schemas/SecretCredentialId'
          required:
            - type
    SumoLogicCredential:
      title: SumoLogicCredential
      oneOf:
        - type: object
          allOf:
            - type: object
              properties:
                type:
                  type: string
                  enum:
                    - basic
            - $ref: '#/components/schemas/BasicCredential'
          required:
            - type
        - type: object
          properties:
            type:
              type: string
              enum:
                - basic_id
            value:
              $ref: '#/components/schemas/BasicCredentialId'
          required:
            - type
    TaniumCloudCredential:
      title: TaniumCloudCredential
      oneOf:
        - type: object
          allOf:
            - type: object
              properties:
                type:
                  type: string
                  enum:
                    - token
            - $ref: '#/components/schemas/TokenCredential'
          required:
            - type
        - type: object
          properties:
            type:
              type: string
              enum:
                - token_id
            value:
              $ref: '#/components/schemas/TokenCredentialId'
          required:
            - type
      description: Supported credential types for Tanium Cloud
    TeamsCredential:
      title: TeamsCredential
      oneOf:
        - type: object
          allOf:
            - type: object
              properties:
                type:
                  type: string
                  enum:
                    - o_auth_client
            - $ref: '#/components/schemas/OAuthClientCredential'
          required:
            - type
        - type: object
          properties:
            type:
              type: string
              enum:
                - o_auth_client_id
            value:
              $ref: '#/components/schemas/OAuthClientCredentialId'
          required:
            - type
        - type: object
          allOf:
            - type: object
              properties:
                type:
                  type: string
                  enum:
                    - webhook_url
            - $ref: '#/components/schemas/SecretCredential'
          required:
            - type
        - type: object
          properties:
            type:
              type: string
              enum:
                - webhook_url_id
            value:
              $ref: '#/components/schemas/SecretCredentialId'
          required:
            - type
    TenableCloudCredential:
      title: TenableCloudCredential
      oneOf:
        - type: object
          allOf:
            - type: object
              properties:
                type:
                  type: string
                  enum:
                    - token
            - $ref: '#/components/schemas/TokenCredential'
          required:
            - type
        - type: object
          properties:
            type:
              type: string
              enum:
                - token_id
            value:
              $ref: '#/components/schemas/TokenCredentialId'
          required:
            - type
      description: Supported credential types for Tenable Cloud
    Ticketing_Autotask:
      title: Autotask
      type: object
      description: Configuration for Autotask as a Ticketing Provider
      properties:
        api_integration_code_credential:
          $ref: '#/components/schemas/AutotaskApiIntegrationCodeCredential'
        secret_credential:
          $ref: '#/components/schemas/AutotaskSecretCredential'
        user_name:
          type: string
          description: User name for the Autotask API.
        zone_path:
          type: string
          description: Zone path for the Autotask API.
      required:
        - api_integration_code_credential
        - secret_credential
        - user_name
        - zone_path
    Ticketing_Jira:
      title: Jira
      type: object
      description: Configuration for Jira as a Ticketing Provider
      properties:
        credential:
          $ref: '#/components/schemas/JiraCredential'
        custom_field_mappings:
          type: array
          items:
            $ref: '#/components/schemas/CustomFieldMapping'
          nullable: true
          description: Custom field mappings for this provider.
        default_project:
          type: string
          nullable: true
          description: Default Project for the integration.
        url:
          type: string
          description: >-
            URL for the Jira API. This should be the base URL for the API,
            without any path components and must be HTTPS. For example,
            "https://tenant.atlassian.net".
      required:
        - credential
        - url
    Ticketing_Mock:
      title: Ticketing Test
      type: object
      description: >-
        Configuration for the Synqly mock in-memory ticketing handler. This
        provider is for testing purposes only. It retains tickets for a limited
        time and does not persist them for long-term usage.
      properties:
        custom_field_mappings:
          type: array
          items:
            $ref: '#/components/schemas/CustomFieldMapping'
          nullable: true
          description: Custom field mappings for this provider.
        name:
          type: string
          nullable: true
          description: Optional name of the mock provider. This value is unused.
    Ticketing_PagerDuty:
      title: PagerDuty
      type: object
      description: Configuration for PagerDuty as a Ticketing Provider
      properties:
        credential:
          $ref: '#/components/schemas/PagerDutyCredential'
        url:
          type: string
          description: >-
            URL for the PagerDuty API. This should be the base URL for the API,
            without any path components and must be HTTPS. For example,
            "https://api.pagerduty.com".
      required:
        - credential
        - url
    Ticketing_ServiceNow:
      title: ServiceNow ITSM
      type: object
      description: Configuration for ServiceNow as a Ticketing Provider
      properties:
        credential:
          $ref: '#/components/schemas/ServiceNowCredential'
        custom_field_mappings:
          type: array
          items:
            $ref: '#/components/schemas/CustomFieldMapping'
          nullable: true
          description: Custom field mappings for this provider.
        default_project:
          type: string
          nullable: true
          description: >-
            Default Project for the integration. This maps to the custom table
            for tickets. This table should be derived from Incident table. If
            not provided, defaults to the incident table.
        url:
          type: string
          description: >-
            URL for the ServiceNow API. This should be the base URL for the API,
            without any path components and must be HTTPS. For example,
            "https://tenant.service-now.com".
      required:
        - credential
        - url
    Ticketing_ServiceNowSIR:
      title: ServiceNow SIR
      type: object
      description: >-
        Configuration for ServiceNow Security Incident Response as a Ticketing
        Provider
      properties:
        credential:
          $ref: '#/components/schemas/ServiceNowCredential'
        url:
          type: string
          description: >-
            URL for the ServiceNow API. This should be the base URL for the API,
            without any path components and must be HTTPS. For example,
            "https://tenant.service-now.com".
      required:
        - credential
        - url
    Ticketing_Torq:
      title: Torq
      type: object
      description: Configuration for Torq as a Ticketing Provider
      properties:
        credential:
          $ref: '#/components/schemas/TorqCredential'
        custom_field_mappings:
          type: array
          items:
            $ref: '#/components/schemas/CustomFieldMapping'
          nullable: true
          description: Custom field mappings for this provider.
      required:
        - credential
    TorqCredential:
      title: TorqCredential
      oneOf:
        - type: object
          allOf:
            - type: object
              properties:
                type:
                  type: string
                  enum:
                    - o_auth_client
            - $ref: '#/components/schemas/OAuthClientCredential'
          required:
            - type
        - type: object
          properties:
            type:
              type: string
              enum:
                - o_auth_client_id
            value:
              $ref: '#/components/schemas/OAuthClientCredentialId'
          required:
            - type
    Vulnerabilities_CrowdStrike:
      title: CrowdStrike Spotlight
      type: object
      description: Configuration for CrowdStrike Falcon as a Vulnerabilities Provider
      properties:
        credential:
          $ref: '#/components/schemas/CrowdStrikeCredential'
        url:
          type: string
          nullable: true
          description: The root domain where your CrowdStrike Falcon tenant is located.
          default: https://api.crowdstrike.com
      required:
        - credential
    Vulnerabilities_Nucleus:
      title: Nucleus Vulnerability Management
      type: object
      description: Configuration for Nucleus as a Vulnerabilities Provider
      properties:
        credential:
          $ref: '#/components/schemas/NucleusCredential'
        project_id:
          type: string
          description: >-
            The **project_id** is a string representing a numeric ID (e.g.,
            "12345") and can be found in the Nucleus UI by selecting **Global
            Dashboard** from the left-hand menu, then choosing **All Projects**
            at the top, where the **Projects** widget lists all projects with
            their IDs.
          pattern: ^\d+$
          title: Project ID
        url:
          type: string
          description: >-
            URL for the Nucleus API. This should be the base URL for the API,
            without any path components and must be HTTPS, e.g.
            "https://{sandbox}.nucleussec.com" .
          pattern: ^https://.*$
          title: Nucleus API URL
      required:
        - credential
        - project_id
        - url
    Vulnerabilities_QualysCloud:
      title: Qualys VMDR
      type: object
      description: Configuration for Qualys Cloud Platform as a Vulnerabilities Provider
      properties:
        credential:
          $ref: '#/components/schemas/QualysCloudCredential'
        url:
          type: string
          description: >-
            URL for the Qualys Cloud API. This should be the base URL for the
            API, without any path components and must be HTTPS. For example,
            "https://qualysguard.qg4.apps.qualys.com".
      required:
        - credential
        - url
    Vulnerabilities_Rapid7InsightCloud:
      title: Rapid7 InsightVM Cloud
      type: object
      description: Configuration for Rapid7 Insight Cloud as a Vulnerabilities Provider
      properties:
        credential:
          $ref: '#/components/schemas/Rapid7InsightCloudCredential'
        url:
          type: string
          description: >-
            URL for the Rapid7 API. This should be the base URL for the API,
            without any path components and must be HTTPS. For example,
            "https://us2.api.insight.rapid7.com".
      required:
        - credential
        - url
    Vulnerabilities_TaniumCloud:
      title: Tanium Vulnerability Management
      type: object
      description: Configuration for Tanium Cloud as a Vulnerabilities Provider
      properties:
        credential:
          $ref: '#/components/schemas/TaniumCloudCredential'
        url:
          type: string
          description: >-
            URL for the Tanium Cloud API. This should be the base URL for the
            API, without any path components and must be HTTPS, e.g.
            "https://<customername>-api.cloud.tanium.com" or
            "https://<customername>-api.titankube.com".
          pattern: ^https://.*$
          title: Tanium Cloud API URL
      required:
        - credential
        - url
    Vulnerabilities_TenableCloud:
      title: Tenable Vulnerability Management
      type: object
      description: Configuration for Tenable Cloud as a Vulnerabilities Provider
      properties:
        credential:
          $ref: '#/components/schemas/TenableCloudCredential'
        url:
          type: string
          nullable: true
          description: >-
            URL for the Tenable Cloud API. This should be the base URL for the
            API, without any path components and must be HTTPS. If not provided,
            defaults to "https://cloud.tenable.com".
          default: https://cloud.tenable.com
          pattern: ^https://.*$
          title: Tenable Cloud API URL
      required:
        - credential
    RoleId:
      title: RoleId
      $ref: '#/components/schemas/Id'
      description: Unique identifier for this Role
    RoleName:
      title: RoleName
      type: string
      description: Unique identifier for this Role
    AdhocRole:
      title: AdhocRole
      type: object
      properties:
        resources:
          $ref: '#/components/schemas/Resources'
        permission_set:
          $ref: '#/components/schemas/Permissions'
      required:
        - resources
        - permission_set
    RoleAccounts:
      title: RoleAccounts
      type: object
      properties:
        ids:
          type: array
          items:
            $ref: '#/components/schemas/AccountId'
          description: >-
            List of account ids that this role definition grants access to. Use
            "\*" to grant access to all account ids.
        labels:
          type: array
          items:
            type: string
          nullable: true
          description: >-
            List of account labels this role definition grants access to. If
            both labels and environments are specified both must pass
        environments:
          type: array
          items:
            $ref: '#/components/schemas/Environment'
          nullable: true
          description: >-
            Account environments this role definition grants access to. If both
            labels and environments are specified both must pass
      required:
        - ids
    RoleIntegrations:
      title: RoleIntegrations
      type: object
      properties:
        categories:
          type: array
          items:
            $ref: '#/components/schemas/CategoryId'
          description: >-
            List of categories ids that this role definition grants access to.
            Use "\*" to grant access to all category ids.
      required:
        - categories
    RoleOrganizations:
      title: RoleOrganizations
      type: object
      properties:
        ids:
          type: array
          items:
            $ref: '#/components/schemas/OrganizationId'
          description: >-
            List of organization ids that this role definition grants access to.
            Use "\*" to grant access to all organization ids.
        labels:
          type: array
          items:
            type: string
          nullable: true
          description: List of organization labels this role definition grants access to.
      required:
        - ids
    Resources:
      title: Resources
      type: object
      properties:
        organizations:
          $ref: '#/components/schemas/RoleOrganizations'
          nullable: true
        accounts:
          $ref: '#/components/schemas/RoleAccounts'
          nullable: true
        integrations:
          $ref: '#/components/schemas/RoleIntegrations'
          nullable: true
    BuiltinRoles:
      title: BuiltinRoles
      type: string
      enum:
        - root_administrator
        - administrator
        - viewer
        - member
    RoleDefinition:
      title: RoleDefinition
      type: object
      properties:
        id:
          $ref: '#/components/schemas/RoleId'
        fullname:
          type: string
          description: Full name of role
        description:
          type: string
          nullable: true
          description: >-
            Description of the resources included in the role and permissions
            granted on those resources. Includes details of when to use this
            role along with the intended personas.
        resources:
          $ref: '#/components/schemas/Resources'
          nullable: true
          description: Selects the resources the permission set applies to.
        permission_set:
          $ref: '#/components/schemas/Permissions'
          description: Permission set for this role.
      required:
        - id
        - fullname
        - permission_set
      allOf:
        - $ref: '#/components/schemas/Base'
    ListRolesResponse:
      title: ListRolesResponse
      type: object
      properties:
        result:
          type: array
          items:
            $ref: '#/components/schemas/RoleDefinition'
      required:
        - result
    GetRoleResponse:
      title: GetRoleResponse
      type: object
      properties:
        result:
          $ref: '#/components/schemas/RoleDefinition'
      required:
        - result
    CreateRoleRequest:
      title: CreateRoleRequest
      type: object
      properties:
        name:
          type: string
          nullable: true
          description: >-
            Unique short name for this Role (lowercase [a-z0-9_-], can be used
            in URLs). Also used for case insensitive duplicate name detection
            and default sort order. Defaults to RoleId if both name and fullname
            are not specified.
        fullname:
          type: string
          nullable: true
          description: >-
            Human friendly display name for this Role, will auto-generate 'name'
            field (if 'name' is not specified). Defaults to the same value as
            the 'name' field if not specified.
        description:
          type: string
          nullable: true
          description: >-
            Description of the resources included in the role and permissions
            granted on those resources. Includes details of when to use this
            role along with the intended personas.
        resources:
          $ref: '#/components/schemas/Resources'
          nullable: true
          description: Selects the resources the permission set applies to.
        permission_set:
          $ref: '#/components/schemas/Permissions'
          description: Permission set for this role.
      required:
        - permission_set
    CreateRoleResponse:
      title: CreateRoleResponse
      type: object
      properties:
        result:
          $ref: '#/components/schemas/RoleDefinition'
      required:
        - result
    UpdateRoleRequest:
      title: UpdateRoleRequest
      $ref: '#/components/schemas/RoleDefinition'
    UpdateRoleResponse:
      title: UpdateRoleResponse
      type: object
      properties:
        result:
          $ref: '#/components/schemas/RoleDefinition'
      required:
        - result
    PatchRoleResponse:
      title: PatchRoleResponse
      type: object
      properties:
        result:
          $ref: '#/components/schemas/RoleDefinition'
      required:
        - result
    ListStatusOptions:
      title: ListStatusOptions
      type: string
      enum:
        - account
        - accounts
        - integration
        - integrations
        - all
    TimeseriesOptions:
      title: TimeseriesOptions
      type: string
      enum:
        - hour
    Status:
      title: Status
      type: object
      description: Status object
      properties:
        created_at:
          type: string
          format: date-time
          description: Time object was originally created
        updated_at:
          type: string
          format: date-time
          description: Last time object was updated
        account_id:
          $ref: '#/components/schemas/AccountId'
          description: >-
            Account associated with this status. Use the expand=accounts
            parameter with the List API to expand the Account to the full object
        account:
          $ref: '#/components/schemas/Account'
          nullable: true
          description: >-
            When using the expand option on the List API, the full account
            object is included in the response
        integration_id:
          $ref: '#/components/schemas/IntegrationId'
          description: >-
            Integration associated with this status. Use the expand=integrations
            parameter with the List API to expand the Integration to the full
            object
        integration:
          $ref: '#/components/schemas/Integration'
          nullable: true
          description: >-
            When using the expand option on the List API, the full integration
            object is included in the response
        status:
          type: string
          description: The current status of the notification.
        requests:
          type: integer
          format: int64
          description: Request count
        failed:
          type: integer
          format: int64
          description: Failed count
        cpu_time:
          type: integer
          format: int64
          description: Cpu time in microseconds
        db_ops:
          type: integer
          format: int64
          description: Database operations count
        api_ops:
          type: integer
          format: int64
          description: API operations count
        in_bytes:
          type: integer
          format: int64
          description: API input byte count
        out_bytes:
          type: integer
          format: int64
          description: API output byte count
      required:
        - created_at
        - updated_at
        - account_id
        - integration_id
        - status
        - requests
        - failed
        - cpu_time
        - db_ops
        - api_ops
        - in_bytes
        - out_bytes
    ListStatusResponse:
      title: ListStatusResponse
      type: object
      properties:
        result:
          type: array
          items:
            $ref: '#/components/schemas/Status'
      required:
        - result
    GetStatusResponse:
      title: GetStatusResponse
      type: object
      properties:
        result:
          $ref: '#/components/schemas/Status'
      required:
        - result
    StatusEvent:
      title: StatusEvent
      type: object
      description: Status event object
      properties:
        account_id:
          $ref: '#/components/schemas/AccountId'
          description: Account owner
        integration_id:
          $ref: '#/components/schemas/IntegrationId'
          description: Integration object
        created_at:
          type: string
          format: date-time
          description: Time created
        status:
          type: string
          description: The current status of the notification.
        error:
          type: string
          nullable: true
          description: Error message
        request:
          type: integer
          format: int64
          description: Request number
      required:
        - account_id
        - integration_id
        - created_at
        - status
        - request
    ListStatusEventsResponse:
      title: ListStatusEventsResponse
      type: object
      properties:
        result:
          type: array
          items:
            $ref: '#/components/schemas/StatusEvent'
      required:
        - result
    TimeseriesResult:
      title: TimeseriesResult
      type: object
      description: Status timeseries object
      properties:
        created_at:
          type: string
          format: date-time
          description: Interval time
        succeeded:
          type: integer
          format: int64
          description: Succeeded count
        failed:
          type: integer
          format: int64
          description: Failed count
        cpu_time:
          type: integer
          format: int64
          description: Cpu time in microseconds
        in_bytes:
          type: integer
          format: int64
          description: API input byte count
        out_bytes:
          type: integer
          format: int64
          description: API output byte count
      required:
        - created_at
        - succeeded
        - failed
        - cpu_time
        - in_bytes
        - out_bytes
    GetStatusTimeseriesResult:
      title: GetStatusTimeseriesResult
      type: object
      description: Status timeseries object
      properties:
        start_time:
          type: string
          format: date-time
          description: start time
        end_time:
          type: string
          format: date-time
          description: end time
        interval:
          type: string
          description: interval duration
        series:
          type: array
          items:
            $ref: '#/components/schemas/TimeseriesResult'
      required:
        - start_time
        - end_time
        - interval
        - series
    GetStatusTimeseries:
      title: GetStatusTimeseries
      type: object
      description: Get status last hour timeseries
      properties:
        result:
          $ref: '#/components/schemas/GetStatusTimeseriesResult'
      required:
        - result
    GetIntegrationTimeseriesResult:
      title: GetIntegrationTimeseriesResult
      $ref: '#/components/schemas/GetStatusTimeseriesResult'
    GetIntegrationTimeseries:
      title: GetIntegrationTimeseries
      type: object
      description: Get integration timeseries
      properties:
        result:
          $ref: '#/components/schemas/GetIntegrationTimeseriesResult'
      required:
        - result
    TokenId:
      title: TokenId
      $ref: '#/components/schemas/Id'
      description: Unique identifier for this Token
    TokenPair:
      title: TokenPair
      type: object
      properties:
        access:
          $ref: '#/components/schemas/Token'
          description: Access token contains the bearer secret
        refresh:
          $ref: '#/components/schemas/Token'
          description: Refresh token used for RefreshToken API
      required:
        - access
        - refresh
    Token:
      title: Token
      type: object
      properties:
        secret:
          type: string
          description: >-
            Secret value for the token; used for authentication when making
            requests.
        expires:
          type: string
          format: date-time
          description: Time when this token expires and can no longer be used again.
        permissions:
          $ref: '#/components/schemas/Permission'
          description: Permissions granted to this token.
      required:
        - secret
        - expires
        - permissions
    TokenOwnerType:
      title: TokenOwnerType
      type: string
      enum:
        - organization
        - integration
    RefreshToken:
      title: RefreshToken
      type: object
      properties:
        id:
          $ref: '#/components/schemas/TokenId'
        member_id:
          $ref: '#/components/schemas/Id'
          nullable: true
          description: Member Id
        owner_id:
          $ref: '#/components/schemas/Id'
          description: ID of the entity that owns this token
        owner_type:
          $ref: '#/components/schemas/TokenOwnerType'
          description: Type of the entity that owns this token
        expires:
          type: string
          format: date-time
          description: Time when this token expires and can no longer be used again.
        token_ttl:
          type: string
          description: Token time-to-live
        primary:
          $ref: '#/components/schemas/TokenPair'
          description: Primary running access and refresh tokens
        secondary:
          $ref: '#/components/schemas/TokenPair'
          nullable: true
          description: Temporary secondary TokenPair created after a RefreshToken operation
      required:
        - id
        - owner_id
        - owner_type
        - expires
        - token_ttl
        - primary
      allOf:
        - $ref: '#/components/schemas/Base'
    CreateTokenRequest:
      title: CreateTokenRequest
      type: object
      properties:
        name:
          type: string
          nullable: true
          description: >-
            Unique name token. If not provided, defaults to generated newly
            created refresh token id.
        resources:
          $ref: '#/components/schemas/Resources'
          description: Limit access to supplied resources
        permission_set:
          $ref: '#/components/schemas/Permissions'
          description: Limit access to supplied permissions
        token_ttl:
          type: string
          nullable: true
          description: >-
            Token time-to-live. If not provided, defaults to the TTL of the
            token used to call this API. Use the format "1h", "1m", "1s" for
            hours, minutes, and seconds respectively.
      required:
        - resources
        - permission_set
    CreateTokenResponse:
      title: CreateTokenResponse
      type: object
      properties:
        result:
          $ref: '#/components/schemas/RefreshToken'
      required:
        - result
    CreateIntegrationTokenRequest:
      title: CreateIntegrationTokenRequest
      type: object
      properties:
        name:
          type: string
          nullable: true
          description: >-
            Unique name token. If not provided, defaults to generated newly
            created refresh token id.
        token_ttl:
          type: string
          nullable: true
          description: >-
            Token time-to-live. If not provided, defaults to the TTL of the
            token used to call this API. Use the format "1h", "1m", "1s" for
            hours, minutes, and seconds respectively.
    CreateIntegrationTokenResponse:
      title: CreateIntegrationTokenResponse
      type: object
      properties:
        result:
          $ref: '#/components/schemas/Token'
      required:
        - result
    ListTokensResponse:
      title: ListTokensResponse
      type: object
      properties:
        result:
          type: array
          items:
            $ref: '#/components/schemas/RefreshToken'
      required:
        - result
    GetTokenResponse:
      title: GetTokenResponse
      type: object
      properties:
        result:
          $ref: '#/components/schemas/RefreshToken'
      required:
        - result
    ResetTokenResponse:
      title: ResetTokenResponse
      type: object
      properties:
        result:
          $ref: '#/components/schemas/RefreshToken'
      required:
        - result
    RefreshTokenResponse:
      title: RefreshTokenResponse
      type: object
      properties:
        result:
          $ref: '#/components/schemas/RefreshToken'
      required:
        - result
    TransformId:
      title: TransformId
      $ref: '#/components/schemas/Id'
      description: Unique identifier for this Transform
    Transform:
      title: Transform
      type: object
      description: Transforms data collected before it is sent to the target Integration.
      properties:
        id:
          $ref: '#/components/schemas/TransformId'
        account_id:
          $ref: '#/components/schemas/AccountId'
          description: Account that manages this Transform.
        fullname:
          type: string
          description: Human friendly display name for this Transform.
        patch:
          type: string
          format: byte
          description: JSON Patch transform to apply (rfc6902).
      required:
        - id
        - account_id
        - fullname
        - patch
      allOf:
        - $ref: '#/components/schemas/Base'
    ListTransformsResponse:
      title: ListTransformsResponse
      type: object
      properties:
        result:
          type: array
          items:
            $ref: '#/components/schemas/Transform'
      required:
        - result
    GetTransformResponse:
      title: GetTransformResponse
      type: object
      properties:
        result:
          $ref: '#/components/schemas/Transform'
      required:
        - result
    CreateTransformRequest:
      title: CreateTransformRequest
      type: object
      properties:
        name:
          type: string
          nullable: true
          description: >-
            Unique short name for this Transform (lowercase [a-z0-9_-], can be
            used in URLs). Also used for case insensitive duplicate name
            detection and default sort order. Defaults to TransformId if both
            name and fullname are not specified.
        fullname:
          type: string
          nullable: true
          description: >-
            Human friendly display name for this Transform, will auto-generate
            'name' field (if 'name' is not specified). Defaults to the same
            value as the 'name' field if not specified.
        patch:
          type: string
          format: byte
          description: JSON Patch transform to apply (rfc6902).
      required:
        - patch
    CreateTransformResponse:
      title: CreateTransformResponse
      type: object
      properties:
        result:
          $ref: '#/components/schemas/Transform'
      required:
        - result
    UpdateTransformRequest:
      title: UpdateTransformRequest
      $ref: '#/components/schemas/Transform'
    UpdateTransformResponse:
      title: UpdateTransformResponse
      type: object
      properties:
        result:
          $ref: '#/components/schemas/Transform'
      required:
        - result
    PatchTransformResponse:
      title: PatchTransformResponse
      type: object
      properties:
        result:
          $ref: '#/components/schemas/Transform'
      required:
        - result
    Usage:
      title: Usage
      type: object
      properties:
        integration_id:
          $ref: '#/components/schemas/Id'
        requests_count:
          type: number
          format: double
        cpu_time_seconds:
          type: number
          format: double
        db_operations_count:
          type: number
          format: double
        int_ops_count:
          type: number
          format: double
      required:
        - integration_id
        - requests_count
        - cpu_time_seconds
        - db_operations_count
        - int_ops_count
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
servers:
  - url: https://api.synqly.com
    description: Synqly
x-readme:
  explorer-enabled: false
  samples-languages:
    - shell
    - go
tags:
  - name: Accounts
    x-displayName: Accounts
    description: >
      Accounts under your Organization are used to manage Integrations,
      Credentials, and other account specific resources. Accounts are secure
      containers and may be used to represent tenants in your system. Data is
      never shared across accounts.


      For more information on Accounts, see the [Synqly
      Overview](/guides/getting-started/overview).
    x-synqly-availability:
      status: generally-available
  - name: Audit
    x-displayName: Audit
  - name: Auth
    x-displayName: Auth
  - name: Bridges
    x-displayName: Bridges
  - name: Capabilities
    x-displayName: Capabilities
  - name: Credentials
    x-displayName: Credentials
  - name: IntegrationPoints
    x-displayName: Integration Points
    description: >
      An Integration Point describes a class of Integrations, and lets you
      describe names, allowed providers and other configuration that should
      apply to integrations associated with the Integration Point.


      While an Integration can be created without associating it with an
      Integration Point, some Synqly features require the use of Integration
      Points, such as:


      * [Connect UI](https://synqly.com/synqly-connector-ui/)

      * Validating allowed providers

      * Custom data mapping (coming soon)


      Integration Points belong to the Organization, and can be associated with
      Integrations belonging to different Accounts.


      For more information on Integration Points, see the [Synqly
      Overview](/guides/getting-started/overview).
    x-synqly-availability:
      status: generally-available
  - name: Integrations
    x-displayName: Integrations
    description: >
      An Integration represents the connection to a specific Provider. Once
      configured, an Integration enables interaction with the target Provider
      via our unified and normalized [Connector
      APIs](/api-reference/connectors).


      Each Integration belongs to an
      [Account](/api-reference/management/accounts) and may be associated with
      an [Integration Point](/api-reference/management/integrationpoints) to
      provide additional features and configuration.


      For more information on Integrations, see the [Synqly
      Overview](/guides/getting-started/overview).
    x-synqly-availability:
      status: generally-available
  - name: Members
    x-displayName: Members
  - name: Meta
    x-displayName: Meta
  - name: Operations
    x-displayName: Operations (In Development)
    description: |
      {% admonition type="warning" name="In Development" %}
      This feature is actively being developed. Breaking changes should be
      expected.

      Please contact us before using this feature.
      {% /admonition %}
    x-synqly-availability:
      status: in-development
  - name: OrganizationWebhooks
    x-displayName: Organization Webhooks
  - name: Organization
    x-displayName: Organization
  - name: Permissionset
    x-displayName: Permissionset
  - name: Roles
    x-displayName: Roles
  - name: Status
    x-displayName: Status
  - name: SubOrgs
    x-displayName: Sub Orgs
  - name: Tokens
    x-displayName: Tokens
    description: ''
    x-synqly-availability:
      status: generally-available
      operations:
        tokens_create_synqly_integrations_token: in-development
  - name: Transforms
    x-displayName: Transforms
