PingDirectory

Configuration API paths

The Configuration API and supported sub-paths are available under the /config path.

A full listing of supported sub-paths is available when you access the base /config/ResourceTypes endpoint.

GET /config/ResourceTypes
Host: example.com:5033
Accept: application/scim+json

Some paths reflect hierarchical relationships between objects. For example, properties of a local DB VLV index for the userRoot backend are available using a path like /config/backends/userRoot/local-db-indexes/uid. Some paths represent singleton objects, which have properties but cannot be deleted or created. These paths can be differentiated from others by their singular, rather than plural, relation name, such as global-configuration.

Example

The following sample response is abbreviated.

{
  "schemas": [
    "urn:ietf:params:scim:api:messages:2.0:ListResponse"
  ],
  "totalResults": 520,
  "Resources": [
    {
      "schemas": [
        "urn:ietf:params:scim:schemas:core:2.0:ResourceType"
      ],
      "id": "dsee-compat-access-control-handler",
      "name": "DSEE Compat Access Control Handler",
      "description": "The DSEE Compat Access Control
              Handler provides an implementation that uses syntax
              compatible with the Sun Java System Directory Server
              Enterprise Edition access control handler.",
      "endpoint": "/access-control-handler",
      "meta": {
        "resourceType": "ResourceType",
        "location": "http://example.com:5033/config/ResourceTypes/dsee-compat-access-control-handler"
      }
    },
    {
      "schemas": [
        "urn:ietf:params:scim:schemas:core:2.0:ResourceType"
      ],
      "id": "access-control-handler",
      "name": "Access Control Handler",
      "description": "Access Control Handlers manage the
              application-wide access control. The server's access
              control handler is defined through an extensible
              interface, so that alternate implementations can be created.
              Only one access control handler may be active in the server
                        at any given time.",
      "endpoint": "/access-control-handler",
      "meta": {
        "resourceType": "ResourceType",
        "location": "http://example.com:5033/config/ResourceTypes/access-control-handler"
      }
    },
    {
 ...

The response’s endpoint elements enumerate all available sub-paths. You can use the path /config/access-control-handler in the example to get a list of existing access control handlers and create new ones. You can use a path containing an object name, such as /config/backends/{backendName} (where {backendName} corresponds to an existing backend like userRoot) to obtain an object’s properties, update the properties, or delete the object.