PingOne Platform APIs

Patch SCIM User

 

PATCH {{scimPath}}/environments/{{envID}}/v2/Users/{{userID}}

The PATCH {{scimPath}}/environments/{{envID}}/v2/Users/{{userID}} operation replaces some information about the specified SCIM user in the specified environment. Only those atributes specified in the body are changed.

Prerequisites

Request Model

Refer to the SCIM user data model for full property descriptions.

Property Type Required

addresses

Object

Optional

addresses.country

String

Optional

addresses.formatted

String

Optional

addresses.locality

String

Optional

addresses.postalCode

String

Optional

addresses.region

String

Optional

addresses.streetAddress

String

Optional

emails

String

Optional

externalId

String

Optional

locale

String

Optional

name.familyName

String

Optional

name.formatted

String

Optional

name.givenName

String

Optional

name.honorificPrefix

String

Optional

name.honorificSuffix

String

Optional

name.middleName

String

Optional

name

Object

Optional

nickName

String

Optional

password

String

Required

phoneNumbers

String

Optional

photos

Object

Optional

preferredLanguage

String

Optional

timezone

DateTime

Optional

title

String

Optional

urn:pingidentity:
schemas:extension:2.0:
PingOneUser.population.id

String

Optional

userName

String

Required

The SCIM PATCH operation differs from a traditional JSON PATCH. The request body must provide a list of operations to apply sequentially to the user resource. The PATCH operation is considered atomic, and no updates will be applied if any of the provided operations fail. It is similar to an ldapmodify operation on LDAP directory servers.

Headers

Authorization      Bearer {{accessToken}}

Content-Type      application/json

Body

raw ( application/json )

{
    "schemas": [
        "urn:ietf:params:scim:api:messages:2.0:PatchOp"
    ],
    "Operations": [
        {
            "op": "replace",
            "path": "userName",
            "value": "Isabella_Patched"
        },
        {
            "op": "remove",
            "path": "nickName"
        },
        {
            "op": "add",
            "path": "name.middleName",
            "value": "midN"
        }
    ]
}

Example Request

  • cURL

  • C#

  • Go

  • HTTP

  • Java

  • jQuery

  • NodeJS

  • Python

  • PHP

  • Ruby

  • Swift

curl --location --globoff --request PATCH '{{scimPath}}/environments/{{envID}}/v2/Users/{{userID}}' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {{accessToken}}' \
--data '{
    "schemas": [
        "urn:ietf:params:scim:api:messages:2.0:PatchOp"
    ],
    "Operations": [
        {
            "op": "replace",
            "path": "userName",
            "value": "Isabella_Patched"
        },
        {
            "op": "remove",
            "path": "nickName"
        },
        {
            "op": "add",
            "path": "name.middleName",
            "value": "midN"
        }
    ]
}'
var options = new RestClientOptions("{{scimPath}}/environments/{{envID}}/v2/Users/{{userID}}")
{
  MaxTimeout = -1,
};
var client = new RestClient(options);
var request = new RestRequest("", Method.Patch);
request.AddHeader("Content-Type", "application/json");
request.AddHeader("Authorization", "Bearer {{accessToken}}");
var body = @"{" + "\n" +
@"    ""schemas"": [" + "\n" +
@"        ""urn:ietf:params:scim:api:messages:2.0:PatchOp""" + "\n" +
@"    ]," + "\n" +
@"    ""Operations"": [" + "\n" +
@"        {" + "\n" +
@"            ""op"": ""replace""," + "\n" +
@"            ""path"": ""userName""," + "\n" +
@"            ""value"": ""Isabella_Patched""" + "\n" +
@"        }," + "\n" +
@"        {" + "\n" +
@"            ""op"": ""remove""," + "\n" +
@"            ""path"": ""nickName""" + "\n" +
@"        }," + "\n" +
@"        {" + "\n" +
@"            ""op"": ""add""," + "\n" +
@"            ""path"": ""name.middleName""," + "\n" +
@"            ""value"": ""midN""" + "\n" +
@"        }" + "\n" +
@"    ]" + "\n" +
@"}";
request.AddStringBody(body, DataFormat.Json);
RestResponse response = await client.ExecuteAsync(request);
Console.WriteLine(response.Content);
package main

import (
  "fmt"
  "strings"
  "net/http"
  "io"
)

func main() {

  url := "{{scimPath}}/environments/{{envID}}/v2/Users/{{userID}}"
  method := "PATCH"

  payload := strings.NewReader(`{
    "schemas": [
        "urn:ietf:params:scim:api:messages:2.0:PatchOp"
    ],
    "Operations": [
        {
            "op": "replace",
            "path": "userName",
            "value": "Isabella_Patched"
        },
        {
            "op": "remove",
            "path": "nickName"
        },
        {
            "op": "add",
            "path": "name.middleName",
            "value": "midN"
        }
    ]
}`)

  client := &http.Client {
  }
  req, err := http.NewRequest(method, url, payload)

  if err != nil {
    fmt.Println(err)
    return
  }
  req.Header.Add("Content-Type", "application/json")
  req.Header.Add("Authorization", "Bearer {{accessToken}}")

  res, err := client.Do(req)
  if err != nil {
    fmt.Println(err)
    return
  }
  defer res.Body.Close()

  body, err := io.ReadAll(res.Body)
  if err != nil {
    fmt.Println(err)
    return
  }
  fmt.Println(string(body))
}
PATCH /environments/{{envID}}/v2/Users/{{userID}} HTTP/1.1
Host: {{scimPath}}
Content-Type: application/json
Authorization: Bearer {{accessToken}}

{
    "schemas": [
        "urn:ietf:params:scim:api:messages:2.0:PatchOp"
    ],
    "Operations": [
        {
            "op": "replace",
            "path": "userName",
            "value": "Isabella_Patched"
        },
        {
            "op": "remove",
            "path": "nickName"
        },
        {
            "op": "add",
            "path": "name.middleName",
            "value": "midN"
        }
    ]
}
OkHttpClient client = new OkHttpClient().newBuilder()
  .build();
MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{\n    \"schemas\": [\n        \"urn:ietf:params:scim:api:messages:2.0:PatchOp\"\n    ],\n    \"Operations\": [\n        {\n            \"op\": \"replace\",\n            \"path\": \"userName\",\n            \"value\": \"Isabella_Patched\"\n        },\n        {\n            \"op\": \"remove\",\n            \"path\": \"nickName\"\n        },\n        {\n            \"op\": \"add\",\n            \"path\": \"name.middleName\",\n            \"value\": \"midN\"\n        }\n    ]\n}");
Request request = new Request.Builder()
  .url("{{scimPath}}/environments/{{envID}}/v2/Users/{{userID}}")
  .method("PATCH", body)
  .addHeader("Content-Type", "application/json")
  .addHeader("Authorization", "Bearer {{accessToken}}")
  .build();
Response response = client.newCall(request).execute();
var settings = {
  "url": "{{scimPath}}/environments/{{envID}}/v2/Users/{{userID}}",
  "method": "PATCH",
  "timeout": 0,
  "headers": {
    "Content-Type": "application/json",
    "Authorization": "Bearer {{accessToken}}"
  },
  "data": JSON.stringify({
    "schemas": [
      "urn:ietf:params:scim:api:messages:2.0:PatchOp"
    ],
    "Operations": [
      {
        "op": "replace",
        "path": "userName",
        "value": "Isabella_Patched"
      },
      {
        "op": "remove",
        "path": "nickName"
      },
      {
        "op": "add",
        "path": "name.middleName",
        "value": "midN"
      }
    ]
  }),
};

$.ajax(settings).done(function (response) {
  console.log(response);
});
var request = require('request');
var options = {
  'method': 'PATCH',
  'url': '{{scimPath}}/environments/{{envID}}/v2/Users/{{userID}}',
  'headers': {
    'Content-Type': 'application/json',
    'Authorization': 'Bearer {{accessToken}}'
  },
  body: JSON.stringify({
    "schemas": [
      "urn:ietf:params:scim:api:messages:2.0:PatchOp"
    ],
    "Operations": [
      {
        "op": "replace",
        "path": "userName",
        "value": "Isabella_Patched"
      },
      {
        "op": "remove",
        "path": "nickName"
      },
      {
        "op": "add",
        "path": "name.middleName",
        "value": "midN"
      }
    ]
  })

};
request(options, function (error, response) {
  if (error) throw new Error(error);
  console.log(response.body);
});
import requests
import json

url = "{{scimPath}}/environments/{{envID}}/v2/Users/{{userID}}"

payload = json.dumps({
  "schemas": [
    "urn:ietf:params:scim:api:messages:2.0:PatchOp"
  ],
  "Operations": [
    {
      "op": "replace",
      "path": "userName",
      "value": "Isabella_Patched"
    },
    {
      "op": "remove",
      "path": "nickName"
    },
    {
      "op": "add",
      "path": "name.middleName",
      "value": "midN"
    }
  ]
})
headers = {
  'Content-Type': 'application/json',
  'Authorization': 'Bearer {{accessToken}}'
}

response = requests.request("PATCH", url, headers=headers, data=payload)

print(response.text)
<?php
require_once 'HTTP/Request2.php';
$request = new HTTP_Request2();
$request->setUrl('{{scimPath}}/environments/{{envID}}/v2/Users/{{userID}}');
$request->setMethod('PATCH');
$request->setConfig(array(
  'follow_redirects' => TRUE
));
$request->setHeader(array(
  'Content-Type' => 'application/json',
  'Authorization' => 'Bearer {{accessToken}}'
));
$request->setBody('{\n    "schemas": [\n        "urn:ietf:params:scim:api:messages:2.0:PatchOp"\n    ],\n    "Operations": [\n        {\n            "op": "replace",\n            "path": "userName",\n            "value": "Isabella_Patched"\n        },\n        {\n            "op": "remove",\n            "path": "nickName"\n        },\n        {\n            "op": "add",\n            "path": "name.middleName",\n            "value": "midN"\n        }\n    ]\n}');
try {
  $response = $request->send();
  if ($response->getStatus() == 200) {
    echo $response->getBody();
  }
  else {
    echo 'Unexpected HTTP status: ' . $response->getStatus() . ' ' .
    $response->getReasonPhrase();
  }
}
catch(HTTP_Request2_Exception $e) {
  echo 'Error: ' . $e->getMessage();
}
require "uri"
require "json"
require "net/http"

url = URI("{{scimPath}}/environments/{{envID}}/v2/Users/{{userID}}")

http = Net::HTTP.new(url.host, url.port);
request = Net::HTTP::Patch.new(url)
request["Content-Type"] = "application/json"
request["Authorization"] = "Bearer {{accessToken}}"
request.body = JSON.dump({
  "schemas": [
    "urn:ietf:params:scim:api:messages:2.0:PatchOp"
  ],
  "Operations": [
    {
      "op": "replace",
      "path": "userName",
      "value": "Isabella_Patched"
    },
    {
      "op": "remove",
      "path": "nickName"
    },
    {
      "op": "add",
      "path": "name.middleName",
      "value": "midN"
    }
  ]
})

response = http.request(request)
puts response.read_body
let parameters = "{\n    \"schemas\": [\n        \"urn:ietf:params:scim:api:messages:2.0:PatchOp\"\n    ],\n    \"Operations\": [\n        {\n            \"op\": \"replace\",\n            \"path\": \"userName\",\n            \"value\": \"Isabella_Patched\"\n        },\n        {\n            \"op\": \"remove\",\n            \"path\": \"nickName\"\n        },\n        {\n            \"op\": \"add\",\n            \"path\": \"name.middleName\",\n            \"value\": \"midN\"\n        }\n    ]\n}"
let postData = parameters.data(using: .utf8)

var request = URLRequest(url: URL(string: "{{scimPath}}/environments/{{envID}}/v2/Users/{{userID}}")!,timeoutInterval: Double.infinity)
request.addValue("application/json", forHTTPHeaderField: "Content-Type")
request.addValue("Bearer {{accessToken}}", forHTTPHeaderField: "Authorization")

request.httpMethod = "PATCH"
request.httpBody = postData

let task = URLSession.shared.dataTask(with: request) { data, response, error in
  guard let data = data else {
    print(String(describing: error))
    return
  }
  print(String(data: data, encoding: .utf8)!)
}

task.resume()

Example Response

200 OK

{
    "schemas": [
        "urn:ietf:params:scim:schemas:core:2.0:User",
        "urn:pingidentity:schemas:extension:2.0:PingOneUser"
    ],
    "id": "239e1067-b688-4b5d-a226-f1c0a272eadc",
    "meta": {
        "resourceType": "User",
        "created": "2022-11-08T13:44:23.077Z",
        "lastModified": "2023-03-07T19:31:50.807Z",
        "location": "https://scim-api.pingone.com/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/v2/Users/239e1067-b688-4b5d-a226-f1c0a272eadc"
    },
    "userName": "Isabella_Patched",
    "name": {
        "middleName": "midN"
    },
    "active": true,
    "emails": [
        {
            "value": "IsabellaOfCastile@example.com",
            "primary": true
        }
    ],
    "urn:pingidentity:schemas:extension:2.0:PingOneUser": {
        "population": {
            "id": "d230df13-2ab9-4aeb-ba7d-188ad97a2163"
        }
    }
}