REST API

Directory

Updated: December 19, 2019

This page is scheduled for review and update. Check back soon for updated content!

Representation of a Directory.

Resource Representation

{
  "entity-type": "directory",
  "name": string,
  "schema": string,
  "idField": string,
  "parent": string,
  "contextParameters": object
}
Property Name Value Description Notes
entity-type string The entity type name. Value: the fixed string "directory".
name string The directory name.
schema string The directory schema name.
idField string The directory id field name.
parent string The parent directory name.
contextParameters object A collection of key-value pairs filled by enabled enrichers. Optional

We'd love to hear your thoughts!

All fields required