Frontegg SCIM Configurations API

openapi: 3.0.0
info:
  title: Multi-Apps Overview Account Invitations SCIM Configurations API
  description: Frontegg’s Multi-Apps feature simplifies and streamlines application management, delivering a seamless user experience. This section includes all necessary endpoints for managing applications and copying application settings across environments. All endpoints are categorized as **Management Endpoints**, requiring environment-level authorization and providing full control over entitlement resources.
  version: '1.0'
  x-metadata:
    note: Trigger publish artifacts job, remove this x-metadata after publishing
servers:
- url: https://api.frontegg.com/applications
  description: EU Region
- url: https://api.us.frontegg.com/applications
  description: US Region
- url: https://api.ca.frontegg.com/applications
  description: CA Region
- url: https://api.au.frontegg.com/applications
  description: AU Region
- url: https://{domain}.frontegg.com/applications
  description: Frontegg sub-domain for use with user tokens
  variables:
    domain:
      default: app-xxx
tags:
- name: SCIM Configurations
  x-displayName: SCIM configurations
paths:
  /resources/v1/configurations/scim2:
    servers:
    - url: https://api.frontegg.com/directory
      description: EU Region
    - url: https://api.us.frontegg.com/directory
      description: US Region
    - url: https://api.ca.frontegg.com/directory
      description: CA Region
    - url: https://api.au.frontegg.com/directory
      description: AU Region
    - url: https://{domain}.frontegg.com/directory
      description: Frontegg sub-domain for use with user tokens
      variables:
        domain:
          default: app-xxx
    post:
      operationId: Scim2ConnectionConfigController_create
      summary: Create a SCIM Configuration
      description: Create a provisioning (SCIM) configuration for an account (tenant).
      parameters:
      - name: frontegg-tenant-id
        in: header
        description: The account (tenant) ID identifier
        required: false
        schema:
          type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Scim2CreateConnectionConfigRequest'
      responses:
        '201':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Scim2CreateConnectionConfigResponse'
      tags:
      - SCIM Configurations
  /resources/v1/configurations/scim2/{id}:
    servers:
    - url: https://api.frontegg.com/directory
      description: EU Region
    - url: https://api.us.frontegg.com/directory
      description: US Region
    - url: https://api.ca.frontegg.com/directory
      description: CA Region
    - url: https://api.au.frontegg.com/directory
      description: AU Region
    - url: https://{domain}.frontegg.com/directory
      description: Frontegg sub-domain for use with user tokens
      variables:
        domain:
          default: app-xxx
    get:
      operationId: Scim2ConnectionConfigController_fetchById
      summary: Get a SCIM Configuration by ID
      description: Get a provisioning (SCIM) configuration by its ID.
      parameters:
      - name: id
        required: true
        in: path
        schema:
          type: string
      - name: frontegg-tenant-id
        in: header
        description: The account (tenant) ID identifier
        required: false
        schema:
          type: string
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Scim2ConnectionConfigResponse'
      tags:
      - SCIM Configurations
    patch:
      operationId: Scim2ConnectionConfigController_partialUpdate
      summary: Update a SCIM Configuration
      description: Create a provisioning (SCIM) configuration for an account (tenant).
      parameters:
      - name: id
        required: true
        in: path
        schema:
          type: string
      - name: frontegg-tenant-id
        in: header
        description: The account (tenant) ID identifier
        required: false
        schema:
          type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Scim2PatchConnectionConfigRequest'
      responses:
        '204':
          description: ''
      tags:
      - SCIM Configurations
    delete:
      operationId: Scim2ConnectionConfigController_deleteById
      summary: Delete a SCIM Configuration
      description: Create a provisioning (SCIM) configuration for an account (tenant).
      parameters:
      - name: id
        required: true
        in: path
        schema:
          type: string
      - name: frontegg-tenant-id
        in: header
        description: The account (tenant) ID identifier
        required: false
        schema:
          type: string
      responses:
        '204':
          description: ''
      tags:
      - SCIM Configurations
components:
  schemas:
    Scim2CreateConnectionConfigResponse:
      type: object
      properties:
        id:
          type: string
        connectionName:
          type: string
        token:
          type: string
      required:
      - id
      - connectionName
      - token
    Scim2CreateConnectionConfigRequest:
      type: object
      properties:
        source:
          type: string
          enum:
          - frontegg
          - okta
          - azure-ad
          - other
        connectionName:
          type: string
        syncToUserManagement:
          type: boolean
      required:
      - source
    Scim2ConnectionConfigResponse:
      type: object
      properties:
        id:
          type: string
        tenantId:
          type: string
        connectionName:
          type: string
        source:
          type: string
        syncToUserManagement:
          type: boolean
        lastSync:
          format: date-time
          type: string
          nullable: true
        createdAt:
          format: date-time
          type: string
      required:
      - id
      - tenantId
      - connectionName
      - source
      - syncToUserManagement
      - lastSync
      - createdAt
    Scim2PatchConnectionConfigRequest:
      type: object
      properties:
        syncToUserManagement:
          type: boolean
      required:
      - syncToUserManagement
  securitySchemes:
    bearer:
      scheme: bearer
      bearerFormat: JWT
      type: http
x-tagGroups:
- name: Management
  tags:
  - Applications settings