openapi: 3.2.0
info:
  title: Boomi Data Integration Accounts API
  description: '# Boomi Data Integration API documentation


    Welcome to the Boomi Data Integration API Documentation.'
  contact:
    name: Boomi Data Integration Documentation
    url: https://community.boomi.com/s/support
    email: support@boomi.com
  version: 1.0.0
  x-logo:
    url: https://rivery.io/wp-content/uploads/2021/08/logo.png
servers:
- url: https://api.rivery.io
  description: US
- url: https://api.eu-west-1.rivery.io
  description: EU
tags:
- name: Accounts
  description: Listing accounts
paths:
  /v1/accounts/{account_id}/scim_provisioning:
    put:
      tags:
      - Accounts
      summary: Add Or Update Scim Provisioning
      description: '**Authorization scope:** `account:write`


        **Add or update SCIM provisioning.**

        **This endpoint returns the connection string used to communicate with your SCIM app and the authentication token**'
      operationId: create_or_update_scim_provisioning
      security:
      - HTTPBearer: []
      parameters:
      - name: account_id
        in: path
        required: true
        schema:
          type: string
          title: Account Id
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateOrUpdateScimTokenResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
    delete:
      tags:
      - Accounts
      summary: Delete Scim Provisioning
      description: '**Authorization scope:** `account:write`


        **Deletes the scim provisioning. This endpoint won''t delete any existing resource that were already sync by the SCIM.**'
      operationId: delete_scim_provisioning
      security:
      - HTTPBearer: []
      parameters:
      - name: account_id
        in: path
        required: true
        schema:
          type: string
          title: Account Id
      responses:
        '204':
          description: Successful Response
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
    get:
      tags:
      - Accounts
      summary: Get Scim Provisioning Status
      description: '**Authorization scope:** `account:write`


        **Get SCIM provisioning status**'
      operationId: get_scim_provisioning_status
      security:
      - HTTPBearer: []
      parameters:
      - name: account_id
        in: path
        required: true
        schema:
          type: string
          title: Account Id
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetScimTokenStatusResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
components:
  schemas:
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
            - type: string
            - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
      type: object
      required:
      - loc
      - msg
      - type
      title: ValidationError
    GetScimTokenStatusResponse:
      properties:
        account_id:
          type: string
          title: Account Id
          description: The account id
          examples:
          - 65c2465a76ba59de1a868a4e
        is_enabled:
          type: boolean
          title: Is Enabled
          description: A flag that indicates whether SCIM provisioning is enabled
          examples:
          - true
        scim_service_url:
          type: string
          title: Scim Service Url
          description: The connection string (URL) used to communicate with your SCIM app
          examples:
          - https://rivery-scim.rivery.io
      type: object
      required:
      - account_id
      - is_enabled
      - scim_service_url
      title: GetScimTokenStatusResponse
      description: SCIM token get status
    CreateOrUpdateScimTokenResponse:
      properties:
        account_id:
          type: string
          title: Account Id
          description: The account id
          examples:
          - 65c2465a76ba59de1a868a4e
        scim_service_url:
          type: string
          title: Scim Service Url
          description: The connection string (URL) used to communicate with your SCIM app
          examples:
          - https://rivery-scim.rivery.io
        token:
          type: string
          title: Token
          description: The SCIM authentication token. Keep the token somewhere safe. The token will be shown only once.
          examples:
          - '1234'
      type: object
      required:
      - account_id
      - scim_service_url
      - token
      title: CreateOrUpdateScimTokenResponse
      description: SCIM Token create or update response.
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
  securitySchemes:
    HTTPBearer:
      type: http
      scheme: bearer
externalDocs:
  description: Find out more about Data Integration
  url: https://help.boomi.com/docs/Atomsphere/Data_Integration/Data_Integration_Overview