openapi: 3.2.0
info:
  title: Jans Config API - SCIM SCIM - Config Management API
  contact:
    name: Gluu Support
    url: https://support.gluu.org
    email: xxx@gluu.org
  license:
    name: Apache 2.0
    url: https://github.com/JanssenProject/jans/blob/main/LICENSE
  version: 1.0.0
servers:
- url: https://jans.io/
  description: The Jans server
tags:
- name: SCIM - Config Management
paths:
  /scim/scim-config:
    get:
      tags:
      - SCIM - Config Management
      summary: Retrieves SCIM App configuration
      operationId: get-scim-config
      responses:
        '200':
          description: Ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AppConfiguration'
        '401':
          description: Unauthorized
        '500':
          description: InternalServerError
      security:
      - oauth2:
        - https://jans.io/scim/config.readonly
      - oauth2:
        - https://jans.io/scim/config.write
      - oauth2:
        - https://jans.io/oauth/config/scim.admin
      - oauth2:
        - https://jans.io/oauth/config/read-all
      - oauth2:
        - https://jans.io/oauth/config/write-all
    patch:
      tags:
      - SCIM - Config Management
      summary: Patch SCIM App configuration
      operationId: patch-scim-config
      requestBody:
        description: String representing patch-document.
        content:
          application/json-patch+json:
            schema:
              type: array
              items:
                $ref: '#/components/schemas/JsonPatch'
            example: '[ {op:replace, path: loggingLevel, value: DEBUG } ]'
      responses:
        '200':
          description: Ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AppConfiguration'
        '401':
          description: Unauthorized
        '500':
          description: InternalServerError
      security:
      - oauth2:
        - https://jans.io/scim/config.write
      - oauth2:
        - https://jans.io/oauth/config/scim.admin
      - oauth2:
        - https://jans.io/oauth/config/write-all
components:
  schemas:
    JsonPatch:
      type: object
    AppConfiguration:
      type: object
      properties:
        baseDN:
          type: string
        applicationUrl:
          type: string
        baseEndpoint:
          type: string
        personCustomObjectClass:
          type: string
        oxAuthIssuer:
          type: string
        protectionMode:
          type: string
          enum:
          - OAUTH
          - BYPASS
        maxCount:
          type: integer
          format: int32
        bulkMaxOperations:
          type: integer
          format: int32
        bulkMaxPayloadSize:
          type: integer
          format: int64
        userExtensionSchemaURI:
          type: string
        loggingLevel:
          type: string
        loggingLayout:
          type: string
        externalLoggerConfiguration:
          type: string
        metricReporterInterval:
          type: integer
          format: int32
        metricReporterKeepDataDays:
          type: integer
          format: int32
        metricReporterEnabled:
          type: boolean
        disableJdkLogger:
          type: boolean
        disableExternalLoggerConfiguration:
          type: boolean
        disableLoggerTimer:
          type: boolean
        useLocalCache:
          type: boolean
        skipDefinedPasswordValidation:
          type: boolean
  securitySchemes:
    oauth2:
      type: oauth2
      flows:
        clientCredentials:
          tokenUrl: https://{op-hostname}/.../token
          scopes:
            https://jans.io/scim/config.readonly: View SCIM configuration related information
            https://jans.io/scim/config.write: Manage SCIM configuration related information
            https://jans.io/oauth/config/scim.admin: Admin to manage SCIM configuration related information
            https://jans.io/oauth/config/read-all: Super admin for viewing application resource information
            https://jans.io/oauth/config/write-all: Super admin for updating application resource information
            https://jans.io/oauth/config/delete-all: Super admin for deleting application resource information