Ringover · Schema

scim_user

CommunicationsCloudVoIPCollaborationArtificial Intelligence

Properties

Name Type Description
schemas array
id string
externalId string Client-defined identifier. Echoed on create only; not persisted, never returned on reads.
userName string
name object
displayName string Read-only, derived from the name.
title string
emails array
roles array
active boolean
meta object
View JSON Schema on GitHub

JSON Schema

ringover-scim-user-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/ringover/json-schema/ringover-scim-user-schema.json",
  "title": "scim_user",
  "x-generated": "2026-11-10",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/ringover-scim-api-openapi.yml#/components/schemas/scim_user",
  "type": "object",
  "required": [
    "schemas",
    "userName"
  ],
  "properties": {
    "schemas": {
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "id": {
      "type": "string"
    },
    "externalId": {
      "type": "string",
      "description": "Client-defined identifier. Echoed on create only; not persisted, never returned on reads."
    },
    "userName": {
      "type": "string"
    },
    "name": {
      "$ref": "#/$defs/scim_name"
    },
    "displayName": {
      "type": "string",
      "description": "Read-only, derived from the name."
    },
    "title": {
      "type": "string"
    },
    "emails": {
      "type": "array",
      "items": {
        "$ref": "#/$defs/scim_email"
      }
    },
    "roles": {
      "type": "array",
      "items": {
        "$ref": "#/$defs/scim_role"
      }
    },
    "active": {
      "type": "boolean"
    },
    "meta": {
      "$ref": "#/$defs/scim_meta"
    }
  },
  "$defs": {
    "scim_email": {
      "type": "object",
      "properties": {
        "value": {
          "type": "string"
        },
        "type": {
          "type": "string"
        },
        "primary": {
          "type": "boolean"
        }
      }
    },
    "scim_meta": {
      "type": "object",
      "properties": {
        "resourceType": {
          "type": "string"
        },
        "created": {
          "type": "string",
          "format": "date-time",
          "description": "Time the resource was created (xsd:dateTime). Currently omitted until available upstream."
        },
        "lastModified": {
          "type": "string",
          "format": "date-time",
          "description": "Time the resource was last modified. Currently omitted until available upstream."
        },
        "location": {
          "type": "string"
        },
        "version": {
          "type": "string",
          "description": "Weak entity-tag, usable as an If-Match precondition."
        }
      }
    },
    "scim_name": {
      "type": "object",
      "properties": {
        "formatted": {
          "type": "string"
        },
        "givenName": {
          "type": "string"
        },
        "familyName": {
          "type": "string"
        }
      }
    },
    "scim_role": {
      "type": "object",
      "properties": {
        "value": {
          "type": "string",
          "description": "On input, the numeric Ringover profile id (discover it via GET /profiles)."
        },
        "display": {
          "type": "string",
          "description": "Profile name (read-only, returned by the server)."
        },
        "type": {
          "type": "string"
        },
        "primary": {
          "type": "boolean"
        }
      }
    }
  }
}

Work with this as data

Every JSON Schema 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 schemas

4 MCP tools reach this
  • find_json_schemasBrowse and filter every JSON Schema in the catalog.
  • 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 JSON Schema
curl "https://apis.io/api/v1/json-schemas/ringover-scim-user"
All schemas
curl "https://apis.io/api/v1/json-schemas?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

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. By signing up you are subscribing to the APIs.io and API Evangelist newsletters — you can unsubscribe from any issue. See our Privacy Policy and Terms.

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