{"info":{"_postman_id":"805148e9-6784-4ab6-8027-dbce3850299c","name":"PingDirectory REST Simple","description":"

This collection may be useful to get started with RESTful interactions with PingDirectory and may be executed as a sequence with postman collection runner or newman.

For a full reference of the API, see https://apidocs.pingidentity.com/pingdirectory/directory/v1/api/guide/

\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"1355701","collectionId":"805148e9-6784-4ab6-8027-dbce3850299c","publishedId":"SW7c27j1","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"EF5B25"},"publishDate":"2019-11-22T19:07:46.000Z"},"item":[{"name":"Get Schemas","id":"b79926b6-3a14-40fc-86ac-c659e1d5a6ec","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://localhost:1443/directory/v1/schemas/person","description":"

A schema is the set of directory server rules that define the structures, contents, and constraints of a Directory Information Tree (DIT). The schema guarantees that any new data entries or modifications meet and conform to these predetermined set of definitions. It also reduces redundant data definitions and provides a uniform method for clients or applications to access its Directory Server objects. The PingDirectory Server ships with a default set of read-only schema files that define the core properties for the directory server.

Schemas endpoints provide operations to get all defined schemas.

A GET request on the base endpoint, /directory/v1, returns metadata about the server and API. It also returns a list of configured schemas allowed on the server.

\n","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"cn=administrator"},{"key":"password","value":"2FederateM0re"}]},"isInherited":true,"source":{"_postman_id":"805148e9-6784-4ab6-8027-dbce3850299c","id":"805148e9-6784-4ab6-8027-dbce3850299c","name":"PingDirectory REST Simple","type":"collection"}},"urlObject":{"protocol":"https","port":"1443","path":["directory","v1",""],"host":["localhost"],"query":[],"variable":[]}},"response":[],"_postman_id":"2ea84bfb-096f-4477-9f89-21fde93bf91a"},{"name":"Create User","event":[{"listen":"prerequest","script":{"id":"cc4d0f7e-4c14-49f8-a6d4-a5b9f8f76e5e","exec":["pm.environment.set(\"userID\",Math.floor(Math.random()*1000000));"],"type":"text/javascript"}},{"listen":"test","script":{"id":"f4ecff27-49d5-48fd-aa9e-12d2e0766660","exec":["pm.test(\"response is ok\", function(){"," pm.response.to.have.status(201);"," ","});","","pm.test(\"response is JSON\", function(){"," pm.response.to.be.json;","});","","var jsonData = JSON.parse(responseBody);","","","var jsonData = JSON.parse(responseBody);","postman.setEnvironmentVariable(\"userURL\", jsonData[\"_links\"].self.href);","postman.setEnvironmentVariable(\"userDN\", jsonData[\"_dn\"]);"],"type":"text/javascript"}}],"id":"35ff7253-9b55-4b1c-b6cb-eaef09e9f879","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"_parentDN\": \"dc=example,dc=com\",\n \"objectClass\": [ \"person\" ],\n \"cn\": [\"user.{{userID}}\"],\n \"sn\": [\"pm-test-user\"],\n \"userPassword\": [\"2Federate!\"]\n}"},"url":"https://localhost:1443/directory/v1/","description":"

The POST /directory/v1 operation adds a new entry to the directory. The request body must contain all of the required attributes as defined in the schema. If there are no required attributes defined in the schema, you can submit a valid create request with only the _dn attribute in the request body.

This operation returns the entry specified by its disstinguished name (DN).

This operation retrieves the user entry created by using the URL returned by the previous POST call.

This request leverages the search API with filtering and paging facilities.

baseObject or singleLevel or wholeSubtree or subordinateSubtree

\n","type":"text/plain"},"key":"searchScope","value":"wholeSubtree"},{"description":{"content":"

SCIM filtering parameter to limit the returned result set to those entries meeting the specified criteria.

\n","type":"text/plain"},"key":"filter","value":"cn eq \"user.{{userID}}\""}],"variable":[]}},"response":[],"_postman_id":"f11896aa-af72-4e16-8afc-6652ec33b64a"},{"name":"Search all users","event":[{"listen":"test","script":{"id":"cd12833b-8aeb-4ae2-86af-ff8846371ab8","exec":["pm.test(\"response is ok\", function(){"," pm.response.to.have.status(200);"," ","});","","pm.test(\"response is JSON\", function(){"," pm.response.to.be.json;","});",""],"type":"text/javascript"}}],"id":"884472be-70f2-49be-8a80-32ba469069a8","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://localhost:1443/directory/v1/dc=example,dc=com/subtree?searchScope=wholeSubtree&filter=sn eq \"pm-test-user\"","description":"

This request leverages the search API with filtering and paging facilities.

baseObject or singleLevel or wholeSubtree or subordinateSubtree

\n","type":"text/plain"},"key":"searchScope","value":"wholeSubtree"},{"description":{"content":"

SCIM filtering parameter to limit the returned result set to those entries meeting the specified criteria.

\n","type":"text/plain"},"key":"filter","value":"sn eq \"pm-test-user\""}],"variable":[]}},"response":[],"_postman_id":"884472be-70f2-49be-8a80-32ba469069a8"},{"name":"Update User (set description)","event":[{"listen":"test","script":{"id":"7fb307bf-907c-4ddd-8b35-bfabf3d7a5c3","exec":["pm.test(\"response is ok\", function(){"," pm.response.to.have.status(200);"," ","});","","pm.test(\"response is JSON\", function(){"," pm.response.to.be.json;","});",""],"type":"text/javascript"}}],"id":"1a4a532d-7768-41f6-acd2-ed3a9909a303","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"description\": [\"This user is created via the PingDirectory REST API\"]\n}"},"url":"https://localhost:1443/directory/v1/{{userDN}}","description":"

Modify an entry in PingDirectory.

\n","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"cn=administrator"},{"key":"password","value":"2FederateM0re"}]},"isInherited":true,"source":{"_postman_id":"805148e9-6784-4ab6-8027-dbce3850299c","id":"805148e9-6784-4ab6-8027-dbce3850299c","name":"PingDirectory REST Simple","type":"collection"}},"urlObject":{"protocol":"https","port":"1443","path":["directory","v1","{{userDN}}"],"host":["localhost"],"query":[],"variable":[]}},"response":[],"_postman_id":"1a4a532d-7768-41f6-acd2-ed3a9909a303"},{"name":"Update User (add description)","event":[{"listen":"test","script":{"id":"05b59aab-a314-49e4-ba0e-8f1a6c1532a5","exec":["pm.test(\"response is ok\", function(){"," pm.response.to.have.status(200);"," ","});","","pm.test(\"response is JSON\", function(){"," pm.response.to.be.json;","});",""],"type":"text/javascript"}}],"id":"fad80bf9-964b-4c8d-898f-71f92d6b108b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PATCH","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\t\"modifications\": \n\t\t[\n\t\t\t{\n\t\t\t\t\"attributeName\": \"description\",\n\t\t\t\t\"modificationType\": \"add\",\n\t\t\t\t\"values\": [\"furthermore, these are set via a Postman collection\"]\n\t\t\t}\n\t\t]\n}"},"url":"https://localhost:1443/directory/v1/{{userDN}}","description":"

Modify an entry in PingDirectory.

Delete an entry from PingDirectory