OpenMetadata

OpenMetadata SCIM API

SCIM 2.0 compliant user and group provisioning endpoints.

GitHub OpenAPI

Operations 15

GET /v1/scim/Groups List SCIM groups #
POST /v1/scim/Groups Create SCIM group #
GET /v1/scim/Users List SCIM users #
POST /v1/scim/Users Create SCIM user #
GET /v1/scim/Groups/{id} Get SCIM group by ID #
PUT /v1/scim/Groups/{id} Update SCIM group #
DELETE /v1/scim/Groups/{id} Delete SCIM group #
PATCH /v1/scim/Groups/{id} Patch SCIM group #
GET /v1/scim/Users/{id} Get SCIM user by ID #
PUT /v1/scim/Users/{id} Update SCIM user #
DELETE /v1/scim/Users/{id} Delete SCIM user #
PATCH /v1/scim/Users/{id} Patch SCIM user #
GET /v1/scim/Schemas Get SCIM schemas #
GET /v1/scim Get SCIM Service Provider Config #
GET /v1/scim/ServiceProviderConfig Alias endpoint for SCIM Service Provider Config #

Documentation

📖
Documentation
https://docs.open-metadata.org/latest/main-concepts/metadata-standard/apis
📖
Authentication
https://docs.open-metadata.org/latest/main-concepts/metadata-standard/apis

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/openmetadata/refs/heads/main/openapi/openmetadata-scim-api-openapi.yml

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/openmetadata-scim-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

openmetadata-scim-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: OpenMetadata APIs Agent Executions SCIM API
  description: Common types and API definition for OpenMetadata
  contact:
    name: OpenMetadata
    url: https://open-metadata.org
    email: openmetadata-dev@googlegroups.com
  license:
    name: Apache 2.0
    url: https://www.apache.org/licenses/LICENSE-2.0
  version: '1.13'
servers:
- url: /api
  description: Current Host
- url: http://localhost:8585/api
  description: Endpoint URL
security:
- BearerAuth: []
tags:
- name: SCIM
  description: SCIM 2.0 compliant user and group provisioning endpoints.
paths:
  /v1/scim/Groups:
    get:
      tags:
      - SCIM
      summary: List SCIM groups
      description: Lists SCIM groups based on optional filters.
      operationId: listScimGroups
      responses:
        '200':
          description: List of SCIM Groups
    post:
      tags:
      - SCIM
      summary: Create SCIM group
      description: Creates a new SCIM group.
      operationId: createScimGroup
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ScimGroup'
          application/scim+json:
            schema:
              $ref: '#/components/schemas/ScimGroup'
      responses:
        '201':
          description: Group created
        '400':
          description: Invalid group input
  /v1/scim/Users:
    get:
      tags:
      - SCIM
      summary: List SCIM users
      description: Lists SCIM users based on optional filters.
      operationId: listScimUsers
      responses:
        '200':
          description: List of SCIM Users
    post:
      tags:
      - SCIM
      summary: Create SCIM user
      description: Creates a new SCIM user.
      operationId: createScimUser
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ScimUser'
          application/scim+json:
            schema:
              $ref: '#/components/schemas/ScimUser'
      responses:
        '201':
          description: User created
        '400':
          description: Invalid user input
  /v1/scim/Groups/{id}:
    get:
      tags:
      - SCIM
      summary: Get SCIM group by ID
      description: Retrieves a SCIM group identified by ID.
      operationId: getScimGroup
      parameters:
      - name: id
        in: path
        description: SCIM Group ID
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Group found
        '404':
          description: Group not found
    put:
      tags:
      - SCIM
      summary: Update SCIM group
      description: Updates a SCIM group identified by ID.
      operationId: updateScimGroup
      parameters:
      - name: id
        in: path
        description: SCIM Group ID
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ScimGroup'
          application/scim+json:
            schema:
              $ref: '#/components/schemas/ScimGroup'
      responses:
        '200':
          description: Group updated
        '404':
          description: Group not found
    delete:
      tags:
      - SCIM
      summary: Delete SCIM group
      description: Deletes a SCIM group identified by ID.
      operationId: deleteScimGroup
      parameters:
      - name: id
        in: path
        description: SCIM Group ID
        required: true
        schema:
          type: string
      responses:
        '204':
          description: Group deleted
        '404':
          description: Group not found
    patch:
      tags:
      - SCIM
      summary: Patch SCIM group
      description: Patch updates to a SCIM group identified by ID.
      operationId: patchScimGroup
      parameters:
      - name: id
        in: path
        description: SCIM Group ID
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ScimPatchOp'
          application/scim+json:
            schema:
              $ref: '#/components/schemas/ScimPatchOp'
      responses:
        '204':
          description: Group patched
        '404':
          description: Group not found
  /v1/scim/Users/{id}:
    get:
      tags:
      - SCIM
      summary: Get SCIM user by ID
      description: Retrieves a SCIM user identified by ID.
      operationId: getScimUser
      parameters:
      - name: id
        in: path
        description: SCIM User ID
        required: true
        schema:
          type: string
      responses:
        '200':
          description: User found
        '404':
          description: User not found
    put:
      tags:
      - SCIM
      summary: Update SCIM user
      description: Updates a SCIM user identified by ID.
      operationId: updateScimUser
      parameters:
      - name: id
        in: path
        description: SCIM User ID
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ScimUser'
          application/scim+json:
            schema:
              $ref: '#/components/schemas/ScimUser'
      responses:
        '200':
          description: User updated
        '404':
          description: User not found
    delete:
      tags:
      - SCIM
      summary: Delete SCIM user
      description: Deletes a SCIM user identified by ID.
      operationId: deleteScimUser
      parameters:
      - name: id
        in: path
        description: SCIM User ID
        required: true
        schema:
          type: string
      responses:
        '204':
          description: User deleted
        '404':
          description: User not found
    patch:
      tags:
      - SCIM
      summary: Patch SCIM user
      description: Patch updates to a SCIM user identified by ID.
      operationId: patchScimUser
      parameters:
      - name: id
        in: path
        description: SCIM User ID
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ScimPatchOp'
          application/scim+json:
            schema:
              $ref: '#/components/schemas/ScimPatchOp'
      responses:
        '200':
          description: User patched
        '404':
          description: User not found
  /v1/scim/Schemas:
    get:
      tags:
      - SCIM
      summary: Get SCIM schemas
      description: Returns supported SCIM schemas.
      operationId: getScimSchemas
      responses:
        '200':
          description: SCIM schemas
  /v1/scim:
    get:
      tags:
      - SCIM
      summary: Get SCIM Service Provider Config
      description: Returns the SCIM service provider configuration.
      operationId: getServiceProviderConfig
      responses:
        '200':
          description: SCIM Service Provider Configuration
  /v1/scim/ServiceProviderConfig:
    get:
      tags:
      - SCIM
      summary: Alias endpoint for SCIM Service Provider Config
      description: Alias endpoint for service provider configuration.
      operationId: getServiceProviderConfigAlias
      responses:
        '200':
          description: SCIM Service Provider Configuration
components:
  schemas:
    ScimPatchOp:
      required:
      - Operations
      - schemas
      type: object
      properties:
        schemas:
          type: array
          items:
            type: string
        Operations:
          type: array
          items:
            $ref: '#/components/schemas/Operation'
    UrnIetfParamsScimSchemasExtensionEnterprise20User:
      type: object
      properties:
        employeeId:
          type: string
        department:
          type: string
        manager:
          $ref: '#/components/schemas/Manager'
    Meta__1:
      type: object
      properties:
        resourceType:
          type: string
        created:
          type: string
          format: date-time
        lastModified:
          type: string
          format: date-time
        location:
          type: string
    ScimUser:
      type: object
      properties:
        schemas:
          type: array
          items:
            type: string
        id:
          type: string
        externalId:
          type: string
        userName:
          type: string
        displayName:
          type: string
        active:
          type: boolean
        title:
          type: string
        preferredLanguage:
          type: string
        emails:
          type: array
          items:
            $ref: '#/components/schemas/Email'
        phoneNumbers:
          type: array
          items:
            $ref: '#/components/schemas/PhoneNumber'
        addresses:
          type: array
          items:
            $ref: '#/components/schemas/Address'
        name:
          $ref: '#/components/schemas/Name'
        meta:
          $ref: '#/components/schemas/Meta__1'
        urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:
          $ref: '#/components/schemas/UrnIetfParamsScimSchemasExtensionEnterprise20User'
    PhoneNumber:
      type: object
      properties:
        value:
          type: string
        type:
          type: string
    Meta:
      type: object
      properties:
        resourceType:
          type: string
        created:
          type: string
          format: date-time
        lastModified:
          type: string
          format: date-time
        location:
          type: string
    Operation:
      required:
      - op
      type: object
      properties:
        op:
          type: string
        path:
          type: string
        value:
          type: object
    Manager:
      type: object
      properties:
        value:
          type: string
        displayName:
          type: string
    ScimGroup:
      required:
      - displayName
      - schemas
      type: object
      properties:
        schemas:
          type: array
          items:
            type: string
        id:
          type: string
        displayName:
          type: string
        externalId:
          type: string
        active:
          type: boolean
        members:
          type: array
          items:
            $ref: '#/components/schemas/Member'
        meta:
          $ref: '#/components/schemas/Meta'
    Member:
      required:
      - value
      type: object
      properties:
        value:
          type: string
        display:
          type: string
        type:
          type: string
    Address:
      type: object
      properties:
        type:
          type: string
        formatted:
          type: string
        streetAddress:
          type: string
        locality:
          type: string
        region:
          type: string
        postalCode:
          type: string
        country:
          type: string
    Name:
      type: object
      properties:
        givenName:
          type: string
        familyName:
          type: string
        formatted:
          type: string
    Email:
      type: object
      properties:
        value:
          type: string
        type:
          type: string
        primary:
          type: boolean
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT