scim

Create a SCIM user

Changed on

Provisions a new Ringover user (RFC 7644 §3.3).

Behavior & limitations:

  • This is a real onboarding: an invitation is sent and a license and phone number are consumed from your team.
  • A valid email is required: provide a primary emails value or an email-formatted userName, otherwise 400 invalidValue is returned.
  • roles[].value must be the numeric profile id (see GET /profiles); a non-numeric value is silently ignored.
  • externalId is echoed back but not persisted.
post/scim/v2/Users

Request

  • Base URL
    https://public-api.ringover.com/v2
  • URL
    https://public-api.ringover.com/v2/scim/v2/Users
  • Auth
    API key in header Authorization

Request body

schemasstring[] required
idstring
externalIdstring

Client-defined identifier. Echoed on create only; not persisted, never returned on reads.

userNamestring required
displayNamestring

Read-only, derived from the name.

titlestring
activeboolean

Example request

{
  "schemas": [
    "urn:ietf:params:scim:schemas:core:2.0:User"
  ],
  "id": "42",
  "userName": "ada@example.com",
  "name": {
    "givenName": "Ada",
    "familyName": "Lovelace"
  },
  "title": "CTO",
  "emails": [
    {
      "value": "ada@example.com",
      "type": "work",
      "primary": true
    }
  ],
  "roles": [
    {
      "value": "12",
      "display": "MyProfile",
      "type": "profile",
      "primary": true
    }
  ],
  "active": true,
  "meta": {
    "resourceType": "User",
    "location": "/scim/v2/Users/42",
    "version": "W/\"3e8a1c\""
  }
}

Response

User created

Changes