Replace a SCIM user
curl --request PUT \
--url https://api.orbit.devotel.io/scim/v2/{orgSlug}/Users/{id} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/scim+json' \
--data '
{
"schemas": [
"urn:ietf:params:scim:schemas:core:2.0:User"
],
"userName": "ada@example.com",
"name": {
"givenName": "Ada",
"familyName": "Lovelace"
},
"emails": [
{
"value": "ada@example.com",
"primary": true,
"type": "work"
}
],
"displayName": "Ada Lovelace",
"active": true
}
'import requests
url = "https://api.orbit.devotel.io/scim/v2/{orgSlug}/Users/{id}"
payload = {
"schemas": ["urn:ietf:params:scim:schemas:core:2.0:User"],
"userName": "ada@example.com",
"name": {
"givenName": "Ada",
"familyName": "Lovelace"
},
"emails": [
{
"value": "ada@example.com",
"primary": True,
"type": "work"
}
],
"displayName": "Ada Lovelace",
"active": True
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/scim+json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/scim+json'},
body: JSON.stringify({
schemas: ['urn:ietf:params:scim:schemas:core:2.0:User'],
userName: 'ada@example.com',
name: {givenName: 'Ada', familyName: 'Lovelace'},
emails: [{value: 'ada@example.com', primary: true, type: 'work'}],
displayName: 'Ada Lovelace',
active: true
})
};
fetch('https://api.orbit.devotel.io/scim/v2/{orgSlug}/Users/{id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.orbit.devotel.io/scim/v2/{orgSlug}/Users/{id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'schemas' => [
'urn:ietf:params:scim:schemas:core:2.0:User'
],
'userName' => 'ada@example.com',
'name' => [
'givenName' => 'Ada',
'familyName' => 'Lovelace'
],
'emails' => [
[
'value' => 'ada@example.com',
'primary' => true,
'type' => 'work'
]
],
'displayName' => 'Ada Lovelace',
'active' => true
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/scim+json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.orbit.devotel.io/scim/v2/{orgSlug}/Users/{id}"
payload := strings.NewReader("{\n \"schemas\": [\n \"urn:ietf:params:scim:schemas:core:2.0:User\"\n ],\n \"userName\": \"ada@example.com\",\n \"name\": {\n \"givenName\": \"Ada\",\n \"familyName\": \"Lovelace\"\n },\n \"emails\": [\n {\n \"value\": \"ada@example.com\",\n \"primary\": true,\n \"type\": \"work\"\n }\n ],\n \"displayName\": \"Ada Lovelace\",\n \"active\": true\n}")
req, _ := http.NewRequest("PUT", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/scim+json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.put("https://api.orbit.devotel.io/scim/v2/{orgSlug}/Users/{id}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/scim+json")
.body("{\n \"schemas\": [\n \"urn:ietf:params:scim:schemas:core:2.0:User\"\n ],\n \"userName\": \"ada@example.com\",\n \"name\": {\n \"givenName\": \"Ada\",\n \"familyName\": \"Lovelace\"\n },\n \"emails\": [\n {\n \"value\": \"ada@example.com\",\n \"primary\": true,\n \"type\": \"work\"\n }\n ],\n \"displayName\": \"Ada Lovelace\",\n \"active\": true\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.orbit.devotel.io/scim/v2/{orgSlug}/Users/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/scim+json'
request.body = "{\n \"schemas\": [\n \"urn:ietf:params:scim:schemas:core:2.0:User\"\n ],\n \"userName\": \"ada@example.com\",\n \"name\": {\n \"givenName\": \"Ada\",\n \"familyName\": \"Lovelace\"\n },\n \"emails\": [\n {\n \"value\": \"ada@example.com\",\n \"primary\": true,\n \"type\": \"work\"\n }\n ],\n \"displayName\": \"Ada Lovelace\",\n \"active\": true\n}"
response = http.request(request)
puts response.read_body{
"schemas": [
"urn:ietf:params:scim:schemas:core:2.0:User"
],
"id": "user_2a3b4c5d",
"userName": "ada@example.com",
"name": {
"givenName": "Ada",
"familyName": "Lovelace",
"formatted": "Ada Lovelace"
},
"emails": [
{
"value": "ada@example.com",
"primary": true,
"type": "work"
}
],
"displayName": "Ada Lovelace",
"active": true,
"meta": {
"resourceType": "User",
"location": "https://api.orbit.devotel.io/scim/v2/Users/user_2a3b4c5d"
}
}API Reference
Replace a SCIM user
SCIM 2.0 endpoint that replaces a user’s attributes wholesale (RFC 7644 §3.5.1). An identity provider sends the full User resource; Orbit updates the matching Orbit user and returns the updated resource. Use PATCH instead for partial changes. Authenticated with the organization’s SCIM bearer token.
PUT
/
scim
/
v2
/
{orgSlug}
/
Users
/
{id}
Replace a SCIM user
curl --request PUT \
--url https://api.orbit.devotel.io/scim/v2/{orgSlug}/Users/{id} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/scim+json' \
--data '
{
"schemas": [
"urn:ietf:params:scim:schemas:core:2.0:User"
],
"userName": "ada@example.com",
"name": {
"givenName": "Ada",
"familyName": "Lovelace"
},
"emails": [
{
"value": "ada@example.com",
"primary": true,
"type": "work"
}
],
"displayName": "Ada Lovelace",
"active": true
}
'import requests
url = "https://api.orbit.devotel.io/scim/v2/{orgSlug}/Users/{id}"
payload = {
"schemas": ["urn:ietf:params:scim:schemas:core:2.0:User"],
"userName": "ada@example.com",
"name": {
"givenName": "Ada",
"familyName": "Lovelace"
},
"emails": [
{
"value": "ada@example.com",
"primary": True,
"type": "work"
}
],
"displayName": "Ada Lovelace",
"active": True
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/scim+json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/scim+json'},
body: JSON.stringify({
schemas: ['urn:ietf:params:scim:schemas:core:2.0:User'],
userName: 'ada@example.com',
name: {givenName: 'Ada', familyName: 'Lovelace'},
emails: [{value: 'ada@example.com', primary: true, type: 'work'}],
displayName: 'Ada Lovelace',
active: true
})
};
fetch('https://api.orbit.devotel.io/scim/v2/{orgSlug}/Users/{id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.orbit.devotel.io/scim/v2/{orgSlug}/Users/{id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'schemas' => [
'urn:ietf:params:scim:schemas:core:2.0:User'
],
'userName' => 'ada@example.com',
'name' => [
'givenName' => 'Ada',
'familyName' => 'Lovelace'
],
'emails' => [
[
'value' => 'ada@example.com',
'primary' => true,
'type' => 'work'
]
],
'displayName' => 'Ada Lovelace',
'active' => true
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/scim+json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.orbit.devotel.io/scim/v2/{orgSlug}/Users/{id}"
payload := strings.NewReader("{\n \"schemas\": [\n \"urn:ietf:params:scim:schemas:core:2.0:User\"\n ],\n \"userName\": \"ada@example.com\",\n \"name\": {\n \"givenName\": \"Ada\",\n \"familyName\": \"Lovelace\"\n },\n \"emails\": [\n {\n \"value\": \"ada@example.com\",\n \"primary\": true,\n \"type\": \"work\"\n }\n ],\n \"displayName\": \"Ada Lovelace\",\n \"active\": true\n}")
req, _ := http.NewRequest("PUT", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/scim+json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.put("https://api.orbit.devotel.io/scim/v2/{orgSlug}/Users/{id}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/scim+json")
.body("{\n \"schemas\": [\n \"urn:ietf:params:scim:schemas:core:2.0:User\"\n ],\n \"userName\": \"ada@example.com\",\n \"name\": {\n \"givenName\": \"Ada\",\n \"familyName\": \"Lovelace\"\n },\n \"emails\": [\n {\n \"value\": \"ada@example.com\",\n \"primary\": true,\n \"type\": \"work\"\n }\n ],\n \"displayName\": \"Ada Lovelace\",\n \"active\": true\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.orbit.devotel.io/scim/v2/{orgSlug}/Users/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/scim+json'
request.body = "{\n \"schemas\": [\n \"urn:ietf:params:scim:schemas:core:2.0:User\"\n ],\n \"userName\": \"ada@example.com\",\n \"name\": {\n \"givenName\": \"Ada\",\n \"familyName\": \"Lovelace\"\n },\n \"emails\": [\n {\n \"value\": \"ada@example.com\",\n \"primary\": true,\n \"type\": \"work\"\n }\n ],\n \"displayName\": \"Ada Lovelace\",\n \"active\": true\n}"
response = http.request(request)
puts response.read_body{
"schemas": [
"urn:ietf:params:scim:schemas:core:2.0:User"
],
"id": "user_2a3b4c5d",
"userName": "ada@example.com",
"name": {
"givenName": "Ada",
"familyName": "Lovelace",
"formatted": "Ada Lovelace"
},
"emails": [
{
"value": "ada@example.com",
"primary": true,
"type": "work"
}
],
"displayName": "Ada Lovelace",
"active": true,
"meta": {
"resourceType": "User",
"location": "https://api.orbit.devotel.io/scim/v2/Users/user_2a3b4c5d"
}
}Authorizations
BearerApiKey
Dashboard JWT token from Clerk
Path Parameters
The organization slug that scopes the SCIM tenant.
The Orbit user id of the SCIM User resource.
Body
application/scim+json
⌘I