--- title: Update SCIM User description: The PUT {{scimPath}}/environments/{{envID}}/v2/Users/{{userID}} operation updates all information about the specified SCIM user in the specified environment. All user attributes specified in the request body are replaced. component: pingone-api page_id: pingone-api:platform:scim/scim-users/update-scim-user canonical_url: https://developer.pingidentity.com/pingone-api/platform/scim/scim-users/update-scim-user.html section_ids: prerequisites: Prerequisites headers: Headers body: Body example-request: Example Request example-response: Example Response --- # Update SCIM User ## ```none PUT {{scimPath}}/environments/{{envID}}/v2/Users/{{userID}} ``` The `PUT {{scimPath}}/environments/{{envID}}/v2/Users/{{userID}}` operation updates all information about the specified SCIM user in the specified environment. All user attributes specified in the request body are replaced. | | | | - | ------------------------------------ | | | If specified, `password` is ignored. | ### Prerequisites * Refer to [SCIM](../../scim.html) and [SCIM Users](../scim-users.html) for important overview information. > **Collapse: Request Model** > > Refer to the [SCIM user data model](../scim-users.html#scim-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 | > | `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 | ### Headers Authorization      Bearer {{accessToken}} Content-Type      application/json ### Body raw ( application/json ) ```json { "schemas": [ "urn:ietf:params:scim:schemas:core:2.0:User", "urn:pingidentity:schemas:extension:2.0:PingOneUser" ], "userName": "tmp-Isabella-Updated", "emails": [ { "value": "IsabellaOfCastile@example.com", "primary": true } ] } ``` ## ### Example Request * cURL * C# * Go * HTTP * Java * jQuery * NodeJS * Python * PHP * Ruby * Swift ```shell curl --location --globoff --request PUT '{{scimPath}}/environments/{{envID}}/v2/Users/{{userID}}' \ --header 'Content-Type: application/json' \ --header 'Authorization: Bearer {{accessToken}}' \ --data-raw '{ "schemas": [ "urn:ietf:params:scim:schemas:core:2.0:User", "urn:pingidentity:schemas:extension:2.0:PingOneUser" ], "userName": "tmp-Isabella-Updated", "emails": [ { "value": "IsabellaOfCastile@example.com", "primary": true } ] }' ``` ```csharp var options = new RestClientOptions("{{scimPath}}/environments/{{envID}}/v2/Users/{{userID}}") { MaxTimeout = -1, }; var client = new RestClient(options); var request = new RestRequest("", Method.Put); request.AddHeader("Content-Type", "application/json"); request.AddHeader("Authorization", "Bearer {{accessToken}}"); var body = @"{" + "\n" + @" ""schemas"": [" + "\n" + @" ""urn:ietf:params:scim:schemas:core:2.0:User""," + "\n" + @" ""urn:pingidentity:schemas:extension:2.0:PingOneUser""" + "\n" + @" ]," + "\n" + @" ""userName"": ""tmp-Isabella-Updated""," + "\n" + @" ""emails"": [" + "\n" + @" {" + "\n" + @" ""value"": ""IsabellaOfCastile@example.com""," + "\n" + @" ""primary"": true" + "\n" + @" }" + "\n" + @" ]" + "\n" + @"}"; request.AddStringBody(body, DataFormat.Json); RestResponse response = await client.ExecuteAsync(request); Console.WriteLine(response.Content); ``` ```golang package main import ( "fmt" "strings" "net/http" "io" ) func main() { url := "{{scimPath}}/environments/{{envID}}/v2/Users/{{userID}}" method := "PUT" payload := strings.NewReader(`{ "schemas": [ "urn:ietf:params:scim:schemas:core:2.0:User", "urn:pingidentity:schemas:extension:2.0:PingOneUser" ], "userName": "tmp-Isabella-Updated", "emails": [ { "value": "IsabellaOfCastile@example.com", "primary": true } ] }`) 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)) } ``` ```http PUT /environments/{{envID}}/v2/Users/{{userID}} HTTP/1.1 Host: {{scimPath}} Content-Type: application/json Authorization: Bearer {{accessToken}} { "schemas": [ "urn:ietf:params:scim:schemas:core:2.0:User", "urn:pingidentity:schemas:extension:2.0:PingOneUser" ], "userName": "tmp-Isabella-Updated", "emails": [ { "value": "IsabellaOfCastile@example.com", "primary": true } ] } ``` ```java OkHttpClient client = new OkHttpClient().newBuilder() .build(); MediaType mediaType = MediaType.parse("application/json"); RequestBody body = RequestBody.create(mediaType, "{\n \"schemas\": [\n \"urn:ietf:params:scim:schemas:core:2.0:User\",\n \"urn:pingidentity:schemas:extension:2.0:PingOneUser\"\n ],\n \"userName\": \"tmp-Isabella-Updated\",\n \"emails\": [\n {\n \"value\": \"IsabellaOfCastile@example.com\",\n \"primary\": true\n }\n ]\n}"); Request request = new Request.Builder() .url("{{scimPath}}/environments/{{envID}}/v2/Users/{{userID}}") .method("PUT", body) .addHeader("Content-Type", "application/json") .addHeader("Authorization", "Bearer {{accessToken}}") .build(); Response response = client.newCall(request).execute(); ``` ```javascript var settings = { "url": "{{scimPath}}/environments/{{envID}}/v2/Users/{{userID}}", "method": "PUT", "timeout": 0, "headers": { "Content-Type": "application/json", "Authorization": "Bearer {{accessToken}}" }, "data": JSON.stringify({ "schemas": [ "urn:ietf:params:scim:schemas:core:2.0:User", "urn:pingidentity:schemas:extension:2.0:PingOneUser" ], "userName": "tmp-Isabella-Updated", "emails": [ { "value": "IsabellaOfCastile@example.com", "primary": true } ] }), }; $.ajax(settings).done(function (response) { console.log(response); }); ``` ```javascript var request = require('request'); var options = { 'method': 'PUT', 'url': '{{scimPath}}/environments/{{envID}}/v2/Users/{{userID}}', 'headers': { 'Content-Type': 'application/json', 'Authorization': 'Bearer {{accessToken}}' }, body: JSON.stringify({ "schemas": [ "urn:ietf:params:scim:schemas:core:2.0:User", "urn:pingidentity:schemas:extension:2.0:PingOneUser" ], "userName": "tmp-Isabella-Updated", "emails": [ { "value": "IsabellaOfCastile@example.com", "primary": true } ] }) }; request(options, function (error, response) { if (error) throw new Error(error); console.log(response.body); }); ``` ```python import requests import json url = "{{scimPath}}/environments/{{envID}}/v2/Users/{{userID}}" payload = json.dumps({ "schemas": [ "urn:ietf:params:scim:schemas:core:2.0:User", "urn:pingidentity:schemas:extension:2.0:PingOneUser" ], "userName": "tmp-Isabella-Updated", "emails": [ { "value": "IsabellaOfCastile@example.com", "primary": True } ] }) headers = { 'Content-Type': 'application/json', 'Authorization': 'Bearer {{accessToken}}' } response = requests.request("PUT", url, headers=headers, data=payload) print(response.text) ``` ```php setUrl('{{scimPath}}/environments/{{envID}}/v2/Users/{{userID}}'); $request->setMethod(HTTP_Request2::METHOD_PUT); $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:schemas:core:2.0:User",\n "urn:pingidentity:schemas:extension:2.0:PingOneUser"\n ],\n "userName": "tmp-Isabella-Updated",\n "emails": [\n {\n "value": "IsabellaOfCastile@example.com",\n "primary": true\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(); } ``` ```ruby 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::Put.new(url) request["Content-Type"] = "application/json" request["Authorization"] = "Bearer {{accessToken}}" request.body = JSON.dump({ "schemas": [ "urn:ietf:params:scim:schemas:core:2.0:User", "urn:pingidentity:schemas:extension:2.0:PingOneUser" ], "userName": "tmp-Isabella-Updated", "emails": [ { "value": "IsabellaOfCastile@example.com", "primary": true } ] }) response = http.request(request) puts response.read_body ``` ```swift let parameters = "{\n \"schemas\": [\n \"urn:ietf:params:scim:schemas:core:2.0:User\",\n \"urn:pingidentity:schemas:extension:2.0:PingOneUser\"\n ],\n \"userName\": \"tmp-Isabella-Updated\",\n \"emails\": [\n {\n \"value\": \"IsabellaOfCastile@example.com\",\n \"primary\": true\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 = "PUT" 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 ```json { "schemas": [ "urn:ietf:params:scim:schemas:core:2.0:User", "urn:pingidentity:schemas:extension:2.0:PingOneUser" ], "id": "2163c528-8ceb-42ce-8cbc-3d0faf05a790", "meta": { "resourceType": "User", "created": "2023-03-28T12:12:24.125Z", "lastModified": "2023-03-28T12:32:25.186Z", "location": "https://scim-api.pingone.com/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/v2/Users/2163c528-8ceb-42ce-8cbc-3d0faf05a790" }, "userName": "tmp-Isabella-Updated", "active": true, "emails": [ { "value": "IsabellaOfCastile@example.com", "primary": true } ], "urn:pingidentity:schemas:extension:2.0:PingOneUser": { "population": { "id": "cb3ef0a0-0ff5-4f60-ae82-4ae65d9d0e3a" } } } ```