Update Add a Member to User Attributes

PATCH {{apiPath}}/scim/v2/Users/{{id}}

This PATCH /scim/v2/Users/{{id}} sample adds a member to the complex multivalued emails attribute without explicitly setting a path.

The User resource and its attributes are defined in RFC 7643, Section 4.1.

Headers

Authorization Bearer {{accessToken}}

Content-Type application/scim+json

Accept application/scim+json

Body

raw ( application/scim+json )

{
    "Operations": [
        {
            "op": "add",
            "value": {
                "emails": [
                    {
                        "type": "home",
                        "value": "pat@gmail.com"
                    }
                ]
            }
        }
    ],
    "schemas": [
        "urn:ietf:params:scim:api:messages:2.0:PatchOp"
    ]
}

Example Request

curl --location --globoff --request PATCH '{{apiPath}}/scim/v2/Users/{{id}}' \
--header 'Content-Type: application/scim+json' \
--header 'Accept: application/scim+json' \
--header 'Authorization: Bearer {{accessToken}}' \
--data-raw '{
    "Operations": [
        {
            "op": "add",
            "value": {
                "emails": [
                    {
                        "type": "home",
                        "value": "pat@gmail.com"
                    }
                ]
            }
        }
    ],
    "schemas": [
        "urn:ietf:params:scim:api:messages:2.0:PatchOp"
    ]
}'

var options = new RestClientOptions("{{apiPath}}/scim/v2/Users/{{id}}")
{
  MaxTimeout = -1,
};
var client = new RestClient(options);
var request = new RestRequest("", Method.Patch);
request.AddHeader("Content-Type", "application/scim+json");
request.AddHeader("Accept", "application/scim+json");
request.AddHeader("Authorization", "Bearer {{accessToken}}");
var body = @"{" + "\n" +
@"    ""Operations"": [" + "\n" +
@"        {" + "\n" +
@"            ""op"": ""add""," + "\n" +
@"            ""value"": {" + "\n" +
@"                ""emails"": [" + "\n" +
@"                    {" + "\n" +
@"                        ""type"": ""home""," + "\n" +
@"                        ""value"": ""pat@gmail.com""" + "\n" +
@"                    }" + "\n" +
@"                ]" + "\n" +
@"            }" + "\n" +
@"        }" + "\n" +
@"    ]," + "\n" +
@"    ""schemas"": [" + "\n" +
@"        ""urn:ietf:params:scim:api:messages:2.0:PatchOp""" + "\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 := "{{apiPath}}/scim/v2/Users/{{id}}"
  method := "PATCH"

  payload := strings.NewReader(`{
    "Operations": [
        {
            "op": "add",
            "value": {
                "emails": [
                    {
                        "type": "home",
                        "value": "pat@gmail.com"
                    }
                ]
            }
        }
    ],
    "schemas": [
        "urn:ietf:params:scim:api:messages:2.0:PatchOp"
    ]
}`)

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

  if err != nil {
    fmt.Println(err)
    return
  }
  req.Header.Add("Content-Type", "application/scim+json")
  req.Header.Add("Accept", "application/scim+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 /scim/v2/Users/{{id}} HTTP/1.1
Host: {{apiPath}}
Content-Type: application/scim+json
Accept: application/scim+json
Authorization: Bearer {{accessToken}}

{
    "Operations": [
        {
            "op": "add",
            "value": {
                "emails": [
                    {
                        "type": "home",
                        "value": "pat@gmail.com"
                    }
                ]
            }
        }
    ],
    "schemas": [
        "urn:ietf:params:scim:api:messages:2.0:PatchOp"
    ]
}

OkHttpClient client = new OkHttpClient().newBuilder()
  .build();
MediaType mediaType = MediaType.parse("application/scim+json");
RequestBody body = RequestBody.create(mediaType, "{\n    \"Operations\": [\n        {\n            \"op\": \"add\",\n            \"value\": {\n                \"emails\": [\n                    {\n                        \"type\": \"home\",\n                        \"value\": \"pat@gmail.com\"\n                    }\n                ]\n            }\n        }\n    ],\n    \"schemas\": [\n        \"urn:ietf:params:scim:api:messages:2.0:PatchOp\"\n    ]\n}");
Request request = new Request.Builder()
  .url("{{apiPath}}/scim/v2/Users/{{id}}")
  .method("PATCH", body)
  .addHeader("Content-Type", "application/scim+json")
  .addHeader("Accept", "application/scim+json")
  .addHeader("Authorization", "Bearer {{accessToken}}")
  .build();
Response response = client.newCall(request).execute();

var settings = {
  "url": "{{apiPath}}/scim/v2/Users/{{id}}",
  "method": "PATCH",
  "timeout": 0,
  "headers": {
    "Content-Type": "application/scim+json",
    "Accept": "application/scim+json",
    "Authorization": "Bearer {{accessToken}}"
  },
  "data": JSON.stringify({
    "Operations": [
      {
        "op": "add",
        "value": {
          "emails": [
            {
              "type": "home",
              "value": "pat@gmail.com"
            }
          ]
        }
      }
    ],
    "schemas": [
      "urn:ietf:params:scim:api:messages:2.0:PatchOp"
    ]
  }),
};

$.ajax(settings).done(function (response) {
  console.log(response);
});

var request = require('request');
var options = {
  'method': 'PATCH',
  'url': '{{apiPath}}/scim/v2/Users/{{id}}',
  'headers': {
    'Content-Type': 'application/scim+json',
    'Accept': 'application/scim+json',
    'Authorization': 'Bearer {{accessToken}}'
  },
  body: JSON.stringify({
    "Operations": [
      {
        "op": "add",
        "value": {
          "emails": [
            {
              "type": "home",
              "value": "pat@gmail.com"
            }
          ]
        }
      }
    ],
    "schemas": [
      "urn:ietf:params:scim:api:messages:2.0:PatchOp"
    ]
  })

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

import requests
import json

url = "{{apiPath}}/scim/v2/Users/{{id}}"

payload = json.dumps({
  "Operations": [
    {
      "op": "add",
      "value": {
        "emails": [
          {
            "type": "home",
            "value": "pat@gmail.com"
          }
        ]
      }
    }
  ],
  "schemas": [
    "urn:ietf:params:scim:api:messages:2.0:PatchOp"
  ]
})
headers = {
  'Content-Type': 'application/scim+json',
  'Accept': 'application/scim+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('{{apiPath}}/scim/v2/Users/{{id}}');
$request->setMethod('PATCH');
$request->setConfig(array(
  'follow_redirects' => TRUE
));
$request->setHeader(array(
  'Content-Type' => 'application/scim+json',
  'Accept' => 'application/scim+json',
  'Authorization' => 'Bearer {{accessToken}}'
));
$request->setBody('{\n    "Operations": [\n        {\n            "op": "add",\n            "value": {\n                "emails": [\n                    {\n                        "type": "home",\n                        "value": "pat@gmail.com"\n                    }\n                ]\n            }\n        }\n    ],\n    "schemas": [\n        "urn:ietf:params:scim:api:messages:2.0:PatchOp"\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("{{apiPath}}/scim/v2/Users/{{id}}")

http = Net::HTTP.new(url.host, url.port);
request = Net::HTTP::Patch.new(url)
request["Content-Type"] = "application/scim+json"
request["Accept"] = "application/scim+json"
request["Authorization"] = "Bearer {{accessToken}}"
request.body = JSON.dump({
  "Operations": [
    {
      "op": "add",
      "value": {
        "emails": [
          {
            "type": "home",
            "value": "pat@gmail.com"
          }
        ]
      }
    }
  ],
  "schemas": [
    "urn:ietf:params:scim:api:messages:2.0:PatchOp"
  ]
})

response = http.request(request)
puts response.read_body

let parameters = "{\n    \"Operations\": [\n        {\n            \"op\": \"add\",\n            \"value\": {\n                \"emails\": [\n                    {\n                        \"type\": \"home\",\n                        \"value\": \"pat@gmail.com\"\n                    }\n                ]\n            }\n        }\n    ],\n    \"schemas\": [\n        \"urn:ietf:params:scim:api:messages:2.0:PatchOp\"\n    ]\n}"
let postData = parameters.data(using: .utf8)

var request = URLRequest(url: URL(string: "{{apiPath}}/scim/v2/Users/{{id}}")!,timeoutInterval: Double.infinity)
request.addValue("application/scim+json", forHTTPHeaderField: "Content-Type")
request.addValue("application/scim+json", forHTTPHeaderField: "Accept")
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

{
    "emails": [
        {
            "primary": true,
            "type": "work",
            "value": "pat.conley@runciter.com"
        },
        {
            "type": "home",
            "value": "pat@gmail.com"
        }
    ],
    "id": "76b4c133-87a7-4b2f-8058-4716e78b0fd4",
    "meta": {
        "created": "2016-07-30T00:05:29.968Z",
        "lastModified": "2016-07-30T00:08:38.583Z",
        "location": "https://example.com:443/scim/v2/Users/76b4c133-87a7-4b2f-8058-4716e78b0fd4",
        "resourceType": "Users"
    },
    "name": {
        "familyName": "Conley",
        "formatted": "Pat Conley",
        "givenName": "Pat"
    },
    "schemas": [
        "urn:pingidentity:schemas:sample:profile:1.0",
        "urn:pingidentity:schemas:User:1.0"
    ],
    "urn:pingidentity:schemas:sample:profile:1.0": {
        "birthDate": "1948-07-13"
    },
    "userName": "pconley"
}

PingDirectory API Reference

Update Add a Member to User Attributes

Headers

Body

Example Request

Example Response