Ringover · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Ringover Public SCIM API

18 actions 18 updates phrasing extends openapi/ringover-scim-api-openapi.yml
Generated by API Evangelist Written by API Evangelist tooling for Ringover's API. It is a proposal applied on top of the contract, not a document Ringover publishes.
View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 18 · first 16 shown; the file carries all of them

$.info
$.paths['/scim/v2/Users'].get
$.paths['/scim/v2/Users'].post
$.paths['/scim/v2/Users/.search'].post
$.paths['/scim/v2/Users/{id}'].get
$.paths['/scim/v2/Users/{id}'].put
$.paths['/scim/v2/Users/{id}'].delete
$.paths['/scim/v2/Users/{id}'].patch
$.paths['/scim/v2/Groups'].get
$.paths['/scim/v2/Groups'].post
$.paths['/scim/v2/Groups/.search'].post
$.paths['/scim/v2/Groups/{id}'].get
$.paths['/scim/v2/Groups/{id}'].put
$.paths['/scim/v2/Groups/{id}'].delete
$.paths['/scim/v2/Groups/{id}'].patch
$.paths['/scim/v2/ServiceProviderConfig'].get

OpenAPI Overlay

Raw ↑
# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Ringover Public SCIM API
  version: 1.0.0
extends: openapi/ringover-scim-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-11-20'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 17
- target: $.paths['/scim/v2/Users'].get
  update:
    x-apievangelist-phrasing:
      intent: List SCIM users
      effect: read
      questions:
      - Which team members are provisioned in Ringover?
      - Can I filter SCIM users by email address?
      instructions:
      - text: List SCIM users matching {filter}.
        slots:
          filter: query.filter
      - text: Show {count} SCIM users starting at {startIndex}.
        slots:
          count: query.count
          startIndex: query.startIndex
      method: generated
      generated: '2026-11-20'
- target: $.paths['/scim/v2/Users'].post
  update:
    x-apievangelist-phrasing:
      intent: Provision a new SCIM user
      effect: write
      questions:
      - How do I onboard a new Ringover user over SCIM?
      - Does provisioning a SCIM user consume a license and phone number?
      instructions:
      - text: Provision SCIM user {userName} with roles {roles}.
        slots:
          userName: requestBody.userName
          roles: requestBody.roles
      - text: Create a new Ringover user {userName} and send them an invitation.
        slots:
          userName: requestBody.userName
      method: generated
      generated: '2026-11-20'
- target: $.paths['/scim/v2/Users/.search'].post
  update:
    x-apievangelist-phrasing:
      intent: Search SCIM users with a body filter
      effect: read
      questions:
      - Can I search SCIM users using a filter in the request body?
      - What's the body-search alternative to filtering SCIM users with query parameters?
      instructions:
      - text: Search SCIM users with body filter {filter}.
        slots:
          filter: requestBody.filter
      - text: Run a body-based SCIM user search returning {count} results.
        slots:
          count: requestBody.count
      method: generated
      generated: '2026-11-20'
- target: $.paths['/scim/v2/Users/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a SCIM user
      effect: read
      questions:
      - How do I look up one SCIM user by id?
      - Can I get only certain attributes of a SCIM user?
      instructions:
      - text: Get SCIM user {id}.
        slots:
          id: path.id
      - text: Show SCIM user {id} with attributes {attributes}.
        slots:
          id: path.id
          attributes: query.attributes
      method: generated
      generated: '2026-11-20'
- target: $.paths['/scim/v2/Users/{id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Replace a SCIM user's attributes
      effect: write
      questions:
      - Can I rename a SCIM user's email address?
      - What happens if I set a SCIM user's active flag to false?
      instructions:
      - text: Replace SCIM user {id} with {userName} and roles {roles}.
        slots:
          id: path.id
          userName: requestBody.userName
          roles: requestBody.roles
      - text: Deactivate SCIM user {id} by setting active to {active}.
        slots:
          id: path.id
          active: requestBody.active
      method: generated
      generated: '2026-11-20'
- target: $.paths['/scim/v2/Users/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a SCIM user
      effect: destructive
      questions:
      - How do I deprovision a SCIM user?
      - Is deleting a SCIM user the same as setting active to false?
      instructions:
      - text: Delete SCIM user {id}.
        slots:
          id: path.id
      - text: Deprovision SCIM user {id} permanently.
        slots:
          id: path.id
      method: generated
      generated: '2026-11-20'
- target: $.paths['/scim/v2/Users/{id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Patch a SCIM user
      effect: write
      questions:
      - Can I change a SCIM user's roles without replacing them?
      - Which SCIM user attributes can I patch?
      instructions:
      - text: Patch SCIM user {id} with operations {Operations}.
        slots:
          id: path.id
          Operations: requestBody.Operations
      - text: Change the roles of SCIM user {id} to {Operations}.
        slots:
          id: path.id
          Operations: requestBody.Operations
      method: generated
      generated: '2026-11-20'
- target: $.paths['/scim/v2/Groups'].get
  update:
    x-apievangelist-phrasing:
      intent: List SCIM groups
      effect: read
      questions:
      - Which ring groups exist in my team?
      - Can I filter SCIM groups by name?
      instructions:
      - text: List SCIM groups matching {filter}.
        slots:
          filter: query.filter
      - text: Show {count} SCIM groups starting at {startIndex}.
        slots:
          count: query.count
          startIndex: query.startIndex
      method: generated
      generated: '2026-11-20'
- target: $.paths['/scim/v2/Groups'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a SCIM ring group
      effect: write
      questions:
      - How do I create a new ring group over SCIM?
      - Can I add members to a SCIM group when I create it?
      instructions:
      - text: Create SCIM group {displayName}.
        slots:
          displayName: requestBody.displayName
      - text: Create ring group {displayName} with members {members}.
        slots:
          displayName: requestBody.displayName
          members: requestBody.members
      method: generated
      generated: '2026-11-20'
- target: $.paths['/scim/v2/Groups/.search'].post
  update:
    x-apievangelist-phrasing:
      intent: Search SCIM groups with a body filter
      effect: read
      questions:
      - Can I search SCIM groups using a body filter?
      - What does the body-search for groups return?
      instructions:
      - text: Search SCIM groups with body filter {filter}.
        slots:
          filter: requestBody.filter
      - text: Run a body-based SCIM group search returning {count} results.
        slots:
          count: requestBody.count
      method: generated
      generated: '2026-11-20'
- target: $.paths['/scim/v2/Groups/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a SCIM group with its members
      effect: read
      questions:
      - How do I look up a SCIM group and see who is in it?
      - Can I get only certain attributes of a SCIM group?
      instructions:
      - text: Get SCIM group {id} with its members.
        slots:
          id: path.id
      - text: Show SCIM group {id} with attributes {attributes}.
        slots:
          id: path.id
          attributes: query.attributes
      method: generated
      generated: '2026-11-20'
- target: $.paths['/scim/v2/Groups/{id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Replace a SCIM group's membership
      effect: write
      questions:
      - Can I overwrite a SCIM group's membership in one call?
      - Does renaming a SCIM group work when I replace it?
      instructions:
      - text: Replace SCIM group {id} with members {members}.
        slots:
          id: path.id
          members: requestBody.members
      - text: Set the membership of SCIM group {id} to {members}.
        slots:
          id: path.id
          members: requestBody.members
      method: generated
      generated: '2026-11-20'
- target: $.paths['/scim/v2/Groups/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a SCIM group
      effect: destructive
      questions:
      - How do I delete a SCIM group?
      - Why can't I delete a group that's still attached to an IVR?
      instructions:
      - text: Delete SCIM group {id}.
        slots:
          id: path.id
      - text: Remove ring group {id} from the team.
        slots:
          id: path.id
      method: generated
      generated: '2026-11-20'
- target: $.paths['/scim/v2/Groups/{id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Patch a SCIM group's membership
      effect: write
      questions:
      - Can I add or remove members from a SCIM group?
      - How do I reconcile a group's membership with a patch?
      instructions:
      - text: Patch SCIM group {id} with operations {Operations}.
        slots:
          id: path.id
          Operations: requestBody.Operations
      - text: Add and remove members from SCIM group {id} using {Operations}.
        slots:
          id: path.id
          Operations: requestBody.Operations
      method: generated
      generated: '2026-11-20'
- target: $.paths['/scim/v2/ServiceProviderConfig'].get
  update:
    x-apievangelist-phrasing:
      intent: Get SCIM service provider config
      effect: read
      questions:
      - What SCIM features does the service provider support?
      - Which SCIM capabilities are enabled on this server?
      instructions:
      - text: Get the SCIM service provider configuration.
      - text: Show which SCIM features this server supports.
      method: generated
      generated: '2026-11-20'
- target: $.paths['/scim/v2/ResourceTypes'].get
  update:
    x-apievangelist-phrasing:
      intent: List SCIM resource types
      effect: read
      questions:
      - Which resource types does the SCIM server expose?
      - What resource types are available, like User and Group?
      instructions:
      - text: List the SCIM resource types.
      - text: Show the resource types exposed by this SCIM server.
      method: generated
      generated: '2026-11-20'
- target: $.paths['/scim/v2/Schemas'].get
  update:
    x-apievangelist-phrasing:
      intent: List SCIM schema definitions
      effect: read
      questions:
      - What schema definitions does the SCIM server publish?
      - Which attribute schemas are available for users and groups?
      instructions:
      - text: List the SCIM schema definitions.
      - text: Show the attribute schemas available to SCIM users and groups.
      method: generated
      generated: '2026-11-20'

Work with this as data

Every overlay 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 openapi overlays

4 MCP tools reach this
  • find_overlaysBrowse and filter every overlay 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 overlay
curl "https://apis.io/api/v1/overlays/ringover-scim-api-phrasing-overlay"
All openapi overlays
curl "https://apis.io/api/v1/overlays?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.