Update User
curl --request PUT \
--url https://{controlPlaneURL}/api/svc/v1/scim/v2/{tenantName}/{ssoId}/Users/{id} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"schemas": [
"<string>"
],
"userName": "<string>",
"id": "<string>",
"externalId": "<string>",
"name": {
"formatted": "<string>",
"familyName": "<string>",
"givenName": "<string>",
"middleName": "<string>"
},
"displayName": "<string>",
"emails": [
{
"value": "<string>",
"type": "<string>",
"primary": true
}
],
"active": true,
"meta": {
"resourceType": "<string>",
"created": "<string>",
"lastModified": "<string>",
"location": "<string>",
"version": "<string>"
}
}
'import requests
url = "https://{controlPlaneURL}/api/svc/v1/scim/v2/{tenantName}/{ssoId}/Users/{id}"
payload = {
"schemas": ["<string>"],
"userName": "<string>",
"id": "<string>",
"externalId": "<string>",
"name": {
"formatted": "<string>",
"familyName": "<string>",
"givenName": "<string>",
"middleName": "<string>"
},
"displayName": "<string>",
"emails": [
{
"value": "<string>",
"type": "<string>",
"primary": True
}
],
"active": True,
"meta": {
"resourceType": "<string>",
"created": "<string>",
"lastModified": "<string>",
"location": "<string>",
"version": "<string>"
}
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
schemas: ['<string>'],
userName: '<string>',
id: '<string>',
externalId: '<string>',
name: {
formatted: '<string>',
familyName: '<string>',
givenName: '<string>',
middleName: '<string>'
},
displayName: '<string>',
emails: [{value: '<string>', type: '<string>', primary: true}],
active: true,
meta: {
resourceType: '<string>',
created: '<string>',
lastModified: '<string>',
location: '<string>',
version: '<string>'
}
})
};
fetch('https://{controlPlaneURL}/api/svc/v1/scim/v2/{tenantName}/{ssoId}/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://{controlPlaneURL}/api/svc/v1/scim/v2/{tenantName}/{ssoId}/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' => [
'<string>'
],
'userName' => '<string>',
'id' => '<string>',
'externalId' => '<string>',
'name' => [
'formatted' => '<string>',
'familyName' => '<string>',
'givenName' => '<string>',
'middleName' => '<string>'
],
'displayName' => '<string>',
'emails' => [
[
'value' => '<string>',
'type' => '<string>',
'primary' => true
]
],
'active' => true,
'meta' => [
'resourceType' => '<string>',
'created' => '<string>',
'lastModified' => '<string>',
'location' => '<string>',
'version' => '<string>'
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/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://{controlPlaneURL}/api/svc/v1/scim/v2/{tenantName}/{ssoId}/Users/{id}"
payload := strings.NewReader("{\n \"schemas\": [\n \"<string>\"\n ],\n \"userName\": \"<string>\",\n \"id\": \"<string>\",\n \"externalId\": \"<string>\",\n \"name\": {\n \"formatted\": \"<string>\",\n \"familyName\": \"<string>\",\n \"givenName\": \"<string>\",\n \"middleName\": \"<string>\"\n },\n \"displayName\": \"<string>\",\n \"emails\": [\n {\n \"value\": \"<string>\",\n \"type\": \"<string>\",\n \"primary\": true\n }\n ],\n \"active\": true,\n \"meta\": {\n \"resourceType\": \"<string>\",\n \"created\": \"<string>\",\n \"lastModified\": \"<string>\",\n \"location\": \"<string>\",\n \"version\": \"<string>\"\n }\n}")
req, _ := http.NewRequest("PUT", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/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://{controlPlaneURL}/api/svc/v1/scim/v2/{tenantName}/{ssoId}/Users/{id}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"schemas\": [\n \"<string>\"\n ],\n \"userName\": \"<string>\",\n \"id\": \"<string>\",\n \"externalId\": \"<string>\",\n \"name\": {\n \"formatted\": \"<string>\",\n \"familyName\": \"<string>\",\n \"givenName\": \"<string>\",\n \"middleName\": \"<string>\"\n },\n \"displayName\": \"<string>\",\n \"emails\": [\n {\n \"value\": \"<string>\",\n \"type\": \"<string>\",\n \"primary\": true\n }\n ],\n \"active\": true,\n \"meta\": {\n \"resourceType\": \"<string>\",\n \"created\": \"<string>\",\n \"lastModified\": \"<string>\",\n \"location\": \"<string>\",\n \"version\": \"<string>\"\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://{controlPlaneURL}/api/svc/v1/scim/v2/{tenantName}/{ssoId}/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/json'
request.body = "{\n \"schemas\": [\n \"<string>\"\n ],\n \"userName\": \"<string>\",\n \"id\": \"<string>\",\n \"externalId\": \"<string>\",\n \"name\": {\n \"formatted\": \"<string>\",\n \"familyName\": \"<string>\",\n \"givenName\": \"<string>\",\n \"middleName\": \"<string>\"\n },\n \"displayName\": \"<string>\",\n \"emails\": [\n {\n \"value\": \"<string>\",\n \"type\": \"<string>\",\n \"primary\": true\n }\n ],\n \"active\": true,\n \"meta\": {\n \"resourceType\": \"<string>\",\n \"created\": \"<string>\",\n \"lastModified\": \"<string>\",\n \"location\": \"<string>\",\n \"version\": \"<string>\"\n }\n}"
response = http.request(request)
puts response.read_bodySCIM v2
Update User
PUT
/
api
/
svc
/
v1
/
scim
/
v2
/
{tenantName}
/
{ssoId}
/
Users
/
{id}
Update User
curl --request PUT \
--url https://{controlPlaneURL}/api/svc/v1/scim/v2/{tenantName}/{ssoId}/Users/{id} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"schemas": [
"<string>"
],
"userName": "<string>",
"id": "<string>",
"externalId": "<string>",
"name": {
"formatted": "<string>",
"familyName": "<string>",
"givenName": "<string>",
"middleName": "<string>"
},
"displayName": "<string>",
"emails": [
{
"value": "<string>",
"type": "<string>",
"primary": true
}
],
"active": true,
"meta": {
"resourceType": "<string>",
"created": "<string>",
"lastModified": "<string>",
"location": "<string>",
"version": "<string>"
}
}
'import requests
url = "https://{controlPlaneURL}/api/svc/v1/scim/v2/{tenantName}/{ssoId}/Users/{id}"
payload = {
"schemas": ["<string>"],
"userName": "<string>",
"id": "<string>",
"externalId": "<string>",
"name": {
"formatted": "<string>",
"familyName": "<string>",
"givenName": "<string>",
"middleName": "<string>"
},
"displayName": "<string>",
"emails": [
{
"value": "<string>",
"type": "<string>",
"primary": True
}
],
"active": True,
"meta": {
"resourceType": "<string>",
"created": "<string>",
"lastModified": "<string>",
"location": "<string>",
"version": "<string>"
}
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
schemas: ['<string>'],
userName: '<string>',
id: '<string>',
externalId: '<string>',
name: {
formatted: '<string>',
familyName: '<string>',
givenName: '<string>',
middleName: '<string>'
},
displayName: '<string>',
emails: [{value: '<string>', type: '<string>', primary: true}],
active: true,
meta: {
resourceType: '<string>',
created: '<string>',
lastModified: '<string>',
location: '<string>',
version: '<string>'
}
})
};
fetch('https://{controlPlaneURL}/api/svc/v1/scim/v2/{tenantName}/{ssoId}/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://{controlPlaneURL}/api/svc/v1/scim/v2/{tenantName}/{ssoId}/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' => [
'<string>'
],
'userName' => '<string>',
'id' => '<string>',
'externalId' => '<string>',
'name' => [
'formatted' => '<string>',
'familyName' => '<string>',
'givenName' => '<string>',
'middleName' => '<string>'
],
'displayName' => '<string>',
'emails' => [
[
'value' => '<string>',
'type' => '<string>',
'primary' => true
]
],
'active' => true,
'meta' => [
'resourceType' => '<string>',
'created' => '<string>',
'lastModified' => '<string>',
'location' => '<string>',
'version' => '<string>'
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/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://{controlPlaneURL}/api/svc/v1/scim/v2/{tenantName}/{ssoId}/Users/{id}"
payload := strings.NewReader("{\n \"schemas\": [\n \"<string>\"\n ],\n \"userName\": \"<string>\",\n \"id\": \"<string>\",\n \"externalId\": \"<string>\",\n \"name\": {\n \"formatted\": \"<string>\",\n \"familyName\": \"<string>\",\n \"givenName\": \"<string>\",\n \"middleName\": \"<string>\"\n },\n \"displayName\": \"<string>\",\n \"emails\": [\n {\n \"value\": \"<string>\",\n \"type\": \"<string>\",\n \"primary\": true\n }\n ],\n \"active\": true,\n \"meta\": {\n \"resourceType\": \"<string>\",\n \"created\": \"<string>\",\n \"lastModified\": \"<string>\",\n \"location\": \"<string>\",\n \"version\": \"<string>\"\n }\n}")
req, _ := http.NewRequest("PUT", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/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://{controlPlaneURL}/api/svc/v1/scim/v2/{tenantName}/{ssoId}/Users/{id}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"schemas\": [\n \"<string>\"\n ],\n \"userName\": \"<string>\",\n \"id\": \"<string>\",\n \"externalId\": \"<string>\",\n \"name\": {\n \"formatted\": \"<string>\",\n \"familyName\": \"<string>\",\n \"givenName\": \"<string>\",\n \"middleName\": \"<string>\"\n },\n \"displayName\": \"<string>\",\n \"emails\": [\n {\n \"value\": \"<string>\",\n \"type\": \"<string>\",\n \"primary\": true\n }\n ],\n \"active\": true,\n \"meta\": {\n \"resourceType\": \"<string>\",\n \"created\": \"<string>\",\n \"lastModified\": \"<string>\",\n \"location\": \"<string>\",\n \"version\": \"<string>\"\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://{controlPlaneURL}/api/svc/v1/scim/v2/{tenantName}/{ssoId}/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/json'
request.body = "{\n \"schemas\": [\n \"<string>\"\n ],\n \"userName\": \"<string>\",\n \"id\": \"<string>\",\n \"externalId\": \"<string>\",\n \"name\": {\n \"formatted\": \"<string>\",\n \"familyName\": \"<string>\",\n \"givenName\": \"<string>\",\n \"middleName\": \"<string>\"\n },\n \"displayName\": \"<string>\",\n \"emails\": [\n {\n \"value\": \"<string>\",\n \"type\": \"<string>\",\n \"primary\": true\n }\n ],\n \"active\": true,\n \"meta\": {\n \"resourceType\": \"<string>\",\n \"created\": \"<string>\",\n \"lastModified\": \"<string>\",\n \"location\": \"<string>\",\n \"version\": \"<string>\"\n }\n}"
response = http.request(request)
puts response.read_bodyAuthorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Path Parameters
Tenant name
SSO configuration ID
Resource ID
Body
application/json
Response
User updated
Was this page helpful?
⌘I