PingDirectory API Reference

Update an Entry (LDAP Modify)

PATCH {{apiPath}}/directory/v1/{{dn}}

The PATCH /directory/v1/{{dn}} endpoint functions just like an LDAP ldapmodify operation. Similar to the PUT update operation, the PATCH operation does not allow partial changes to a JSON object.

The request body requires the modificationType property, which supports the following four types of modifications:

  • add

    Adds the attribute value (or values) specified in the values property.

  • remove

    Removes the attribute value (or values) specified in the values property.

  • set

    Replaces all the values in the specified attribute with the value (or values) specified in the values property.

  • increment

    Changes the integer value of the attribute by the amount specified in the values property. The request values should contain a single number, and the attribute must be a single-value or a multiple value integer type. If the attribute is a multiple values integer type, the increment gets applied to all the values. For example, if the attribute had [1, 2] before the increment and the increment had values of 5, then after the increment, the attribute would have [6,7].

If the values property is null or an empty array, the update depends on the modification type: set removes the attribute entirely; remove and increment return an error; add is an LDAP No-Op that does not change the directory. It is not possible to modify any API attributes such as _links, _embedded, _dn, or _parent using PATCH.

Headers

Authorization      Bearer {{accessToken}}

Content-Type      application/json

Body

raw ( application/json )

{
    "modifications": [
        {
            "attributeName": "cn",
            "modificationType": "add",
            "values": [
                "Linda F. Jones"
            ]
        },
        {
            "attributeName": "cn",
            "modificationType": "remove",
            "values": [
                "Linda Jones"
            ]
        },
        {
            "attributeName": "manager",
            "modificationType": "set",
            "values": [
                "Boss",
                "Vice Boss"
            ]
        },
        {
            "attributeName": "salary",
            "modificationType": "increment",
            "values": 20000
        },
        {
            "attributeName": "ubidEmailJSON",
            "modificationType": "add",
            "values": [
                {
                    "type": "home",
                    "value": "user@example.com",
                    "verified": true
                }
            ]
        }
    ]
}

Example Request

  • cURL

  • C#

  • Go

  • HTTP

  • Java

  • jQuery

  • NodeJS

  • Python

  • PHP

  • Ruby

  • Swift

curl --location --globoff --request PATCH '{{apiPath}}/directory/v1/{{dn}}' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {{accessToken}}' \
--data-raw '{
    "modifications": [
        {
            "attributeName": "cn",
            "modificationType": "add",
            "values": [
                "Linda F. Jones"
            ]
        },
        {
            "attributeName": "cn",
            "modificationType": "remove",
            "values": [
                "Linda Jones"
            ]
        },
        {
            "attributeName": "manager",
            "modificationType": "set",
            "values": [
                "Boss",
                "Vice Boss"
            ]
        },
        {
            "attributeName": "salary",
            "modificationType": "increment",
            "values": 20000
        },
        {
            "attributeName": "ubidEmailJSON",
            "modificationType": "add",
            "values": [
                {
                    "type": "home",
                    "value": "user@example.com",
                    "verified": true
                }
            ]
        }
    ]
}'
var options = new RestClientOptions("{{apiPath}}/directory/v1/{{dn}}")
{
  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" +
@"    ""modifications"": [" + "\n" +
@"        {" + "\n" +
@"            ""attributeName"": ""cn""," + "\n" +
@"            ""modificationType"": ""add""," + "\n" +
@"            ""values"": [" + "\n" +
@"                ""Linda F. Jones""" + "\n" +
@"            ]" + "\n" +
@"        }," + "\n" +
@"        {" + "\n" +
@"            ""attributeName"": ""cn""," + "\n" +
@"            ""modificationType"": ""remove""," + "\n" +
@"            ""values"": [" + "\n" +
@"                ""Linda Jones""" + "\n" +
@"            ]" + "\n" +
@"        }," + "\n" +
@"        {" + "\n" +
@"            ""attributeName"": ""manager""," + "\n" +
@"            ""modificationType"": ""set""," + "\n" +
@"            ""values"": [" + "\n" +
@"                ""Boss""," + "\n" +
@"                ""Vice Boss""" + "\n" +
@"            ]" + "\n" +
@"        }," + "\n" +
@"        {" + "\n" +
@"            ""attributeName"": ""salary""," + "\n" +
@"            ""modificationType"": ""increment""," + "\n" +
@"            ""values"": 20000" + "\n" +
@"        }," + "\n" +
@"        {" + "\n" +
@"            ""attributeName"": ""ubidEmailJSON""," + "\n" +
@"            ""modificationType"": ""add""," + "\n" +
@"            ""values"": [" + "\n" +
@"                {" + "\n" +
@"                    ""type"": ""home""," + "\n" +
@"                    ""value"": ""user@example.com""," + "\n" +
@"                    ""verified"": true" + "\n" +
@"                }" + "\n" +
@"            ]" + "\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 := "{{apiPath}}/directory/v1/{{dn}}"
  method := "PATCH"

  payload := strings.NewReader(`{
    "modifications": [
        {
            "attributeName": "cn",
            "modificationType": "add",
            "values": [
                "Linda F. Jones"
            ]
        },
        {
            "attributeName": "cn",
            "modificationType": "remove",
            "values": [
                "Linda Jones"
            ]
        },
        {
            "attributeName": "manager",
            "modificationType": "set",
            "values": [
                "Boss",
                "Vice Boss"
            ]
        },
        {
            "attributeName": "salary",
            "modificationType": "increment",
            "values": 20000
        },
        {
            "attributeName": "ubidEmailJSON",
            "modificationType": "add",
            "values": [
                {
                    "type": "home",
                    "value": "user@example.com",
                    "verified": 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))
}
PATCH /directory/v1/{{dn}} HTTP/1.1
Host: {{apiPath}}
Content-Type: application/json
Authorization: Bearer {{accessToken}}

{
    "modifications": [
        {
            "attributeName": "cn",
            "modificationType": "add",
            "values": [
                "Linda F. Jones"
            ]
        },
        {
            "attributeName": "cn",
            "modificationType": "remove",
            "values": [
                "Linda Jones"
            ]
        },
        {
            "attributeName": "manager",
            "modificationType": "set",
            "values": [
                "Boss",
                "Vice Boss"
            ]
        },
        {
            "attributeName": "salary",
            "modificationType": "increment",
            "values": 20000
        },
        {
            "attributeName": "ubidEmailJSON",
            "modificationType": "add",
            "values": [
                {
                    "type": "home",
                    "value": "user@example.com",
                    "verified": true
                }
            ]
        }
    ]
}
OkHttpClient client = new OkHttpClient().newBuilder()
  .build();
MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{\n    \"modifications\": [\n        {\n            \"attributeName\": \"cn\",\n            \"modificationType\": \"add\",\n            \"values\": [\n                \"Linda F. Jones\"\n            ]\n        },\n        {\n            \"attributeName\": \"cn\",\n            \"modificationType\": \"remove\",\n            \"values\": [\n                \"Linda Jones\"\n            ]\n        },\n        {\n            \"attributeName\": \"manager\",\n            \"modificationType\": \"set\",\n            \"values\": [\n                \"Boss\",\n                \"Vice Boss\"\n            ]\n        },\n        {\n            \"attributeName\": \"salary\",\n            \"modificationType\": \"increment\",\n            \"values\": 20000\n        },\n        {\n            \"attributeName\": \"ubidEmailJSON\",\n            \"modificationType\": \"add\",\n            \"values\": [\n                {\n                    \"type\": \"home\",\n                    \"value\": \"user@example.com\",\n                    \"verified\": true\n                }\n            ]\n        }\n    ]\n}");
Request request = new Request.Builder()
  .url("{{apiPath}}/directory/v1/{{dn}}")
  .method("PATCH", body)
  .addHeader("Content-Type", "application/json")
  .addHeader("Authorization", "Bearer {{accessToken}}")
  .build();
Response response = client.newCall(request).execute();
var settings = {
  "url": "{{apiPath}}/directory/v1/{{dn}}",
  "method": "PATCH",
  "timeout": 0,
  "headers": {
    "Content-Type": "application/json",
    "Authorization": "Bearer {{accessToken}}"
  },
  "data": JSON.stringify({
    "modifications": [
      {
        "attributeName": "cn",
        "modificationType": "add",
        "values": [
          "Linda F. Jones"
        ]
      },
      {
        "attributeName": "cn",
        "modificationType": "remove",
        "values": [
          "Linda Jones"
        ]
      },
      {
        "attributeName": "manager",
        "modificationType": "set",
        "values": [
          "Boss",
          "Vice Boss"
        ]
      },
      {
        "attributeName": "salary",
        "modificationType": "increment",
        "values": 20000
      },
      {
        "attributeName": "ubidEmailJSON",
        "modificationType": "add",
        "values": [
          {
            "type": "home",
            "value": "user@example.com",
            "verified": true
          }
        ]
      }
    ]
  }),
};

$.ajax(settings).done(function (response) {
  console.log(response);
});
var request = require('request');
var options = {
  'method': 'PATCH',
  'url': '{{apiPath}}/directory/v1/{{dn}}',
  'headers': {
    'Content-Type': 'application/json',
    'Authorization': 'Bearer {{accessToken}}'
  },
  body: JSON.stringify({
    "modifications": [
      {
        "attributeName": "cn",
        "modificationType": "add",
        "values": [
          "Linda F. Jones"
        ]
      },
      {
        "attributeName": "cn",
        "modificationType": "remove",
        "values": [
          "Linda Jones"
        ]
      },
      {
        "attributeName": "manager",
        "modificationType": "set",
        "values": [
          "Boss",
          "Vice Boss"
        ]
      },
      {
        "attributeName": "salary",
        "modificationType": "increment",
        "values": 20000
      },
      {
        "attributeName": "ubidEmailJSON",
        "modificationType": "add",
        "values": [
          {
            "type": "home",
            "value": "user@example.com",
            "verified": true
          }
        ]
      }
    ]
  })

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

url = "{{apiPath}}/directory/v1/{{dn}}"

payload = json.dumps({
  "modifications": [
    {
      "attributeName": "cn",
      "modificationType": "add",
      "values": [
        "Linda F. Jones"
      ]
    },
    {
      "attributeName": "cn",
      "modificationType": "remove",
      "values": [
        "Linda Jones"
      ]
    },
    {
      "attributeName": "manager",
      "modificationType": "set",
      "values": [
        "Boss",
        "Vice Boss"
      ]
    },
    {
      "attributeName": "salary",
      "modificationType": "increment",
      "values": 20000
    },
    {
      "attributeName": "ubidEmailJSON",
      "modificationType": "add",
      "values": [
        {
          "type": "home",
          "value": "user@example.com",
          "verified": True
        }
      ]
    }
  ]
})
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('{{apiPath}}/directory/v1/{{dn}}');
$request->setMethod('PATCH');
$request->setConfig(array(
  'follow_redirects' => TRUE
));
$request->setHeader(array(
  'Content-Type' => 'application/json',
  'Authorization' => 'Bearer {{accessToken}}'
));
$request->setBody('{\n    "modifications": [\n        {\n            "attributeName": "cn",\n            "modificationType": "add",\n            "values": [\n                "Linda F. Jones"\n            ]\n        },\n        {\n            "attributeName": "cn",\n            "modificationType": "remove",\n            "values": [\n                "Linda Jones"\n            ]\n        },\n        {\n            "attributeName": "manager",\n            "modificationType": "set",\n            "values": [\n                "Boss",\n                "Vice Boss"\n            ]\n        },\n        {\n            "attributeName": "salary",\n            "modificationType": "increment",\n            "values": 20000\n        },\n        {\n            "attributeName": "ubidEmailJSON",\n            "modificationType": "add",\n            "values": [\n                {\n                    "type": "home",\n                    "value": "user@example.com",\n                    "verified": true\n                }\n            ]\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("{{apiPath}}/directory/v1/{{dn}}")

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({
  "modifications": [
    {
      "attributeName": "cn",
      "modificationType": "add",
      "values": [
        "Linda F. Jones"
      ]
    },
    {
      "attributeName": "cn",
      "modificationType": "remove",
      "values": [
        "Linda Jones"
      ]
    },
    {
      "attributeName": "manager",
      "modificationType": "set",
      "values": [
        "Boss",
        "Vice Boss"
      ]
    },
    {
      "attributeName": "salary",
      "modificationType": "increment",
      "values": 20000
    },
    {
      "attributeName": "ubidEmailJSON",
      "modificationType": "add",
      "values": [
        {
          "type": "home",
          "value": "user@example.com",
          "verified": true
        }
      ]
    }
  ]
})

response = http.request(request)
puts response.read_body
let parameters = "{\n    \"modifications\": [\n        {\n            \"attributeName\": \"cn\",\n            \"modificationType\": \"add\",\n            \"values\": [\n                \"Linda F. Jones\"\n            ]\n        },\n        {\n            \"attributeName\": \"cn\",\n            \"modificationType\": \"remove\",\n            \"values\": [\n                \"Linda Jones\"\n            ]\n        },\n        {\n            \"attributeName\": \"manager\",\n            \"modificationType\": \"set\",\n            \"values\": [\n                \"Boss\",\n                \"Vice Boss\"\n            ]\n        },\n        {\n            \"attributeName\": \"salary\",\n            \"modificationType\": \"increment\",\n            \"values\": 20000\n        },\n        {\n            \"attributeName\": \"ubidEmailJSON\",\n            \"modificationType\": \"add\",\n            \"values\": [\n                {\n                    \"type\": \"home\",\n                    \"value\": \"user@example.com\",\n                    \"verified\": true\n                }\n            ]\n        }\n    ]\n}"
let postData = parameters.data(using: .utf8)

var request = URLRequest(url: URL(string: "{{apiPath}}/directory/v1/{{dn}}")!,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

{
    "_dn": "uid=lindajones,ou=people,dc=example,dc=com",
    "objectClass": [
        "top",
        "person",
        "organizationalPerson",
        "inetOrgPerson"
    ],
    "uid": [
        "lindajones"
    ],
    "cn": [
        "Linda F. Jones"
    ],
    "sn": [
        "Jones"
    ],
    "manager": [
        "Boss",
        "Vice Boss"
    ],
    "salary": [
        120000
    ],
    "ubidEmailJSON": [
        {
            "type": "home",
            "value": "user@example.com",
            "verified": true
        }
    ],
    "_links": {
        "schemas": [
            {
                "href": "https://ds.example.com/directory/v1/schemas/inetOrgPerson"
            }
        ],
        "self": {
            "href": "https://ds.example.com/directory/v1/uid=lindajones,ou=people,dc=example,dc=com"
        }
    }
}