scim

Replace a SCIM user

Changed on

Replaces the mutable attributes of a user (RFC 7644 §3.5.1).

Behavior & limitations:

  • emails and displayName are not mutable and are ignored.
  • active: false deletes the user; active: true is a no-op.
  • Multi-attribute updates are not atomic.
  • Supply If-Match for optimistic concurrency; a stale value returns 412.
put/scim/v2/Users/{id}

Request

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

Path parameters

idstring required

Headers

If-Matchstring

Entity-tag precondition (RFC 7644 §3.14).

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

Successful operation

Changes