openapi: 3.2.0
info:
  title: Folio Idp Migration API
  version: v1
  description: 'Operations tagged idp-migration across 2 of this provider''s published API definitions: folio-mod-users-keycloak-openapi.json, folio-mod-users-keycloak-openapi.yml. Each path carries the servers of the definition it was published in.'
servers:
- url: http://localhost:8081
  description: Locally deployed server
tags:
- name: idp-migration
paths:
  /users-keycloak/idp-migrations:
    post:
      operationId: linkUserIdpMigration
      description: Link users to an identity provider migration operation
      tags:
      - idp-migration
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/usersIdp'
      responses:
        '204':
          description: Link users to an identity provider migration operation
          content:
            text/plain:
              schema:
                type: string
      summary: Link user idp migration
      x-summary-source: derived
    delete:
      operationId: unlinkUserIdpMigration
      description: Unlink users from an identity provider migration operation
      tags:
      - idp-migration
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/usersIdp'
      responses:
        '204':
          description: Unlink users from an identity provider migration operation
          content:
            text/plain:
              schema:
                type: string
      summary: Unlink user idp migration
      x-summary-source: derived
    servers:
    - url: http://localhost:8081
      description: Locally deployed server
components:
  schemas:
    usersIdp:
      $schema: http://json-schema.org/draft-04/schema#
      title: Users IDP Linking Schema
      description: Users scheduled for IDP linking
      type: object
      properties:
        centralTenantId:
          description: Central tenant id that will be used for linking the shadow users
          type: string
        userIds:
          description: A list of user UUIDs that are to be scheduled for IDP linking in central tenant
          type: array
          uniqueItems: true
          items:
            type: string
            format: uuid
      required:
      - centralTenantId
      - userIds
      additionalProperties: true
x-refined-from:
- folio-mod-users-keycloak-openapi.json
- folio-mod-users-keycloak-openapi.yml