> For the complete documentation index, see [llms.txt](https://documentation.efalia.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://documentation.efalia.com/api-reference/efalia-process-api/directory.md).

# Directory

## Search Users in the Directory

> Find Users matching a json filter in the Directory.\
> \
> \<a href="./#wky-note-manager" class="wky-label wky-label-manager">Manager\</a>

```json
{"openapi":"3.0.0","info":{"title":"Efalia Process API","version":"6.36.1"},"tags":[{"name":"Directory","description":""}],"servers":[{"url":"http://{hostname}/{workeyContext}/api/","variables":{"hostname":{"default":"localhost:8080","description":"Hostname and port of the Workey server"},"workeyContext":{"default":"workey","description":"Name of the running context of Workey"}}}],"security":[{"Basic":[]},{"Bearer":[]},{"ApiKey":[],"ApiKeyImpersonate":[]}],"components":{"securitySchemes":{"Basic":{"type":"http","scheme":"basic","description":"Value: Basic {encode username:password}"},"Bearer":{"type":"http","scheme":"bearer","description":"Value: Bearer {jwt}"},"ApiKey":{"type":"apiKey","name":"X-API-KEY","in":"header","description":"API key defined in Process configuration."}},"schemas":{"Directory":{"type":"object","properties":{"cn":{"type":"string"},"mail":{"type":"string"},"type":{"type":"string"},"dn":{"type":"string"},"fields":{"type":"object","additionalProperties":{"type":"string"}}}},"RestMessage":{"type":"object","properties":{"code":{"type":"integer"},"error":{"type":"boolean"},"message":{"type":"string"},"cause":{"$ref":"#/components/schemas/ErrorCause"}}},"ErrorCause":{"type":"object","properties":{"className":{"type":"string"},"method":{"type":"string"},"line":{"type":"integer"},"stackTrace":{"type":"object"}}}},"responses":{"WorkeyUnauthorized":{"description":"Unauthorized Workey access error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestMessage"}}}},"WorkeyError":{"description":"Unexpected Workey Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestMessage"}}}}}},"paths":{"/directory":{"get":{"summary":"Search Users in the Directory","description":"Find Users matching a json filter in the Directory.\n\n<a href=\"./#wky-note-manager\" class=\"wky-label wky-label-manager\">Manager</a>","operationId":"searchUserByJsonQuery","deprecated":false,"tags":["Directory"],"parameters":[{"name":"json","in":"query","schema":{"type":"string"}},{"name":"limit","in":"query","schema":{"type":"string"},"required":false,"description":"Maximum number of entries returned by the filter. Note that the directory server \n can limit itself to a certain number of results."},{"name":"attr","in":"query","schema":{"type":"string"},"required":false,"description":"The name of the directory attribute to fetch. This attribute can be repeated to include more attributes."}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Directory"}}}}},"401":{"$ref":"#/components/responses/WorkeyUnauthorized"},"555":{"$ref":"#/components/responses/WorkeyError"}}}}}}
```

## Create New User in the Directory

> Create a new user in the LDAP Directory.\
> \
> \<a href="./#wky-note-workflow-manager" class="wky-label wky-label-workflow-manager">Workflow Manager\</a>\
> \### Note\
> \<p>This resource requires some property to be defined in \`\`catalina.properties\`\` to work:\</p>\
> &#x20; \<dl>\
> &#x20;     \<dt>Login attribute\</dt>\<dd>com.clog.workey.LDAPCreate.attribute.login=uid,sn\</dd>\
> &#x20;     \<dt>Name attribute\</dt>\<dd>com.clog.workey.LDAPCreate.attribute.name=cn,displayName\</dd>\
> &#x20;     \<dt>Email attribute\</dt>\<dd>com.clog.workey.LDAPCreate.attribute.email=mail\</dd>\
> &#x20;     \<dt>Password attribute\</dt>\<dd>com.clog.workey.LDAPCreate.attribute.password=userPassword\</dd>\
> &#x20;     \<!-- le ${name} sera remplace par le nom, ${login} par le login et ${mail} par l'email -->\
> &#x20;     \<dt>DN Template\</dt>\<dd>com.clog.workey.LDAPCreate.contextTemplate=uid=${name},ou=users,ou=system\</dd>\
> &#x20;     \<dt>objectClass attribute\</dt>\<dd>com.clog.workey.LDAPCreate.objectClass=inetOrgPerson\</dd>\
> &#x20;     \<dt>Password length\</dt>\<dd>com.clog.workey.LDAPCreate.passwordLength=32\</dd>\
> &#x20;     \<dt>Characters used for password\</dt>\<dd>com.clog.workey.LDAPCreate.passwordChars=ABCDEF0123456789\</dd>\
> &#x20; \</dl>\
> &#x20; \
> &#x20; \<p>Only JSON input/output is supported.\</p>

```json
{"openapi":"3.0.0","info":{"title":"Efalia Process API","version":"6.36.1"},"tags":[{"name":"Directory","description":""}],"servers":[{"url":"http://{hostname}/{workeyContext}/api/","variables":{"hostname":{"default":"localhost:8080","description":"Hostname and port of the Workey server"},"workeyContext":{"default":"workey","description":"Name of the running context of Workey"}}}],"security":[{"Basic":[]},{"Bearer":[]},{"ApiKey":[],"ApiKeyImpersonate":[]}],"components":{"securitySchemes":{"Basic":{"type":"http","scheme":"basic","description":"Value: Basic {encode username:password}"},"Bearer":{"type":"http","scheme":"bearer","description":"Value: Bearer {jwt}"},"ApiKey":{"type":"apiKey","name":"X-API-KEY","in":"header","description":"API key defined in Process configuration."}},"schemas":{"DirectoryNewUser":{"type":"object","properties":{"login":{"type":"string"},"name":{"type":"string"},"mail":{"type":"string"},"password":{"type":"string"},"dn":{"type":"string"}}},"RestMessage":{"type":"object","properties":{"code":{"type":"integer"},"error":{"type":"boolean"},"message":{"type":"string"},"cause":{"$ref":"#/components/schemas/ErrorCause"}}},"ErrorCause":{"type":"object","properties":{"className":{"type":"string"},"method":{"type":"string"},"line":{"type":"integer"},"stackTrace":{"type":"object"}}}},"responses":{"WorkeyUnauthorized":{"description":"Unauthorized Workey access error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestMessage"}}}},"WorkeyError":{"description":"Unexpected Workey Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestMessage"}}}}}},"paths":{"/directory/user":{"post":{"summary":"Create New User in the Directory","description":"Create a new user in the LDAP Directory.\n\n<a href=\"./#wky-note-workflow-manager\" class=\"wky-label wky-label-workflow-manager\">Workflow Manager</a>\n### Note\n<p>This resource requires some property to be defined in ``catalina.properties`` to work:</p>\n  <dl>\n      <dt>Login attribute</dt><dd>com.clog.workey.LDAPCreate.attribute.login=uid,sn</dd>\n      <dt>Name attribute</dt><dd>com.clog.workey.LDAPCreate.attribute.name=cn,displayName</dd>\n      <dt>Email attribute</dt><dd>com.clog.workey.LDAPCreate.attribute.email=mail</dd>\n      <dt>Password attribute</dt><dd>com.clog.workey.LDAPCreate.attribute.password=userPassword</dd>\n      <!-- le ${name} sera remplace par le nom, ${login} par le login et ${mail} par l'email -->\n      <dt>DN Template</dt><dd>com.clog.workey.LDAPCreate.contextTemplate=uid=${name},ou=users,ou=system</dd>\n      <dt>objectClass attribute</dt><dd>com.clog.workey.LDAPCreate.objectClass=inetOrgPerson</dd>\n      <dt>Password length</dt><dd>com.clog.workey.LDAPCreate.passwordLength=32</dd>\n      <dt>Characters used for password</dt><dd>com.clog.workey.LDAPCreate.passwordChars=ABCDEF0123456789</dd>\n  </dl>\n  \n  <p>Only JSON input/output is supported.</p>","operationId":"postCreateIdpUser","deprecated":false,"tags":["Directory"],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DirectoryNewUser"}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DirectoryNewUser"}}}},"401":{"$ref":"#/components/responses/WorkeyUnauthorized"},"555":{"$ref":"#/components/responses/WorkeyError"}}}}}}
```

## Modify a User in the Directory

> Modify a user in the LDAP Directory.\
> \
> \<a href="./#wky-note-workflow-manager" class="wky-label wky-label-workflow-manager">Workflow Manager\</a>\
> \### Note\
> \<p>This resource requires some property to be defined in \`\`catalina.properties\`\` to work:\</p>\
> &#x20; \<dl>\
> &#x20;     \<dt>Login attribute\</dt>\<dd>com.clog.workey.LDAPCreate.attribute.login=uid,sn\</dd>\
> &#x20;     \<dt>Name attribute\</dt>\<dd>com.clog.workey.LDAPCreate.attribute.name=cn,displayName\</dd>\
> &#x20;     \<dt>Email attribute\</dt>\<dd>com.clog.workey.LDAPCreate.attribute.email=mail\</dd>\
> &#x20;     \<dt>Password attribute\</dt>\<dd>com.clog.workey.LDAPCreate.attribute.password=userPassword\</dd>\
> &#x20;     \<!-- le ${name} sera remplace par le nom, ${login} par le login et ${mail} par l'email -->\
> &#x20;     \<dt>DN Template\</dt>\<dd>com.clog.workey.LDAPCreate.contextTemplate=uid=${name},ou=users,ou=system\</dd>\
> &#x20;     \<dt>objectClass attribute\</dt>\<dd>com.clog.workey.LDAPCreate.objectClass=inetOrgPerson\</dd>\
> &#x20;     \<dt>Password length\</dt>\<dd>com.clog.workey.LDAPCreate.passwordLength=32\</dd>\
> &#x20;     \<dt>Characters used for password\</dt>\<dd>com.clog.workey.LDAPCreate.passwordChars=ABCDEF0123456789\</dd>\
> &#x20; \</dl>\
> &#x20; \
> &#x20; \<p>Only JSON input/output is supported.\</p>

```json
{"openapi":"3.0.0","info":{"title":"Efalia Process API","version":"6.36.1"},"tags":[{"name":"Directory","description":""}],"servers":[{"url":"http://{hostname}/{workeyContext}/api/","variables":{"hostname":{"default":"localhost:8080","description":"Hostname and port of the Workey server"},"workeyContext":{"default":"workey","description":"Name of the running context of Workey"}}}],"security":[{"Basic":[]},{"Bearer":[]},{"ApiKey":[],"ApiKeyImpersonate":[]}],"components":{"securitySchemes":{"Basic":{"type":"http","scheme":"basic","description":"Value: Basic {encode username:password}"},"Bearer":{"type":"http","scheme":"bearer","description":"Value: Bearer {jwt}"},"ApiKey":{"type":"apiKey","name":"X-API-KEY","in":"header","description":"API key defined in Process configuration."}},"schemas":{"DirectoryUpdateUser":{"type":"object","properties":{"login":{"type":"string"},"name":{"type":"string"},"mail":{"type":"string"}}},"RestMessage":{"type":"object","properties":{"code":{"type":"integer"},"error":{"type":"boolean"},"message":{"type":"string"},"cause":{"$ref":"#/components/schemas/ErrorCause"}}},"ErrorCause":{"type":"object","properties":{"className":{"type":"string"},"method":{"type":"string"},"line":{"type":"integer"},"stackTrace":{"type":"object"}}}},"responses":{"WorkeyUnauthorized":{"description":"Unauthorized Workey access error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestMessage"}}}},"WorkeyError":{"description":"Unexpected Workey Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestMessage"}}}}}},"paths":{"/directory/user":{"put":{"summary":"Modify a User in the Directory","description":"Modify a user in the LDAP Directory.\n\n<a href=\"./#wky-note-workflow-manager\" class=\"wky-label wky-label-workflow-manager\">Workflow Manager</a>\n### Note\n<p>This resource requires some property to be defined in ``catalina.properties`` to work:</p>\n  <dl>\n      <dt>Login attribute</dt><dd>com.clog.workey.LDAPCreate.attribute.login=uid,sn</dd>\n      <dt>Name attribute</dt><dd>com.clog.workey.LDAPCreate.attribute.name=cn,displayName</dd>\n      <dt>Email attribute</dt><dd>com.clog.workey.LDAPCreate.attribute.email=mail</dd>\n      <dt>Password attribute</dt><dd>com.clog.workey.LDAPCreate.attribute.password=userPassword</dd>\n      <!-- le ${name} sera remplace par le nom, ${login} par le login et ${mail} par l'email -->\n      <dt>DN Template</dt><dd>com.clog.workey.LDAPCreate.contextTemplate=uid=${name},ou=users,ou=system</dd>\n      <dt>objectClass attribute</dt><dd>com.clog.workey.LDAPCreate.objectClass=inetOrgPerson</dd>\n      <dt>Password length</dt><dd>com.clog.workey.LDAPCreate.passwordLength=32</dd>\n      <dt>Characters used for password</dt><dd>com.clog.workey.LDAPCreate.passwordChars=ABCDEF0123456789</dd>\n  </dl>\n  \n  <p>Only JSON input/output is supported.</p>","operationId":"putModifyIdpUser","deprecated":false,"tags":["Directory"],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DirectoryUpdateUser"}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DirectoryUpdateUser"}}}},"401":{"$ref":"#/components/responses/WorkeyUnauthorized"},"555":{"$ref":"#/components/responses/WorkeyError"}}}}}}
```

## Delete a User in the Directory

> Delete a user in the LDAP Directory.\
> \
> \<a href="./#wky-note-workflow-manager" class="wky-label wky-label-workflow-manager">Workflow Manager\</a>\
> \### Note\
> \<p>This resource requires some property to be defined in \`\`catalina.properties\`\` to work:\</p>\
> &#x20; \<dl>\
> &#x20;     \<dt>Login attribute\</dt>\<dd>com.clog.workey.LDAPCreate.attribute.login=uid,sn\</dd>\
> &#x20;     \<dt>Name attribute\</dt>\<dd>com.clog.workey.LDAPCreate.attribute.name=cn,displayName\</dd>\
> &#x20;     \<dt>Email attribute\</dt>\<dd>com.clog.workey.LDAPCreate.attribute.email=mail\</dd>\
> &#x20;     \<dt>Password attribute\</dt>\<dd>com.clog.workey.LDAPCreate.attribute.password=userPassword\</dd>\
> &#x20;     \<!-- le ${name} sera remplace par le nom, ${login} par le login et ${mail} par l'email -->\
> &#x20;     \<dt>DN Template\</dt>\<dd>com.clog.workey.LDAPCreate.contextTemplate=uid=${name},ou=users,ou=system\</dd>\
> &#x20;     \<dt>objectClass attribute\</dt>\<dd>com.clog.workey.LDAPCreate.objectClass=inetOrgPerson\</dd>\
> &#x20;     \<dt>Password length\</dt>\<dd>com.clog.workey.LDAPCreate.passwordLength=32\</dd>\
> &#x20;     \<dt>Characters used for password\</dt>\<dd>com.clog.workey.LDAPCreate.passwordChars=ABCDEF0123456789\</dd>\
> &#x20; \</dl>\
> &#x20; \
> &#x20; \<p>Only JSON input/output is supported.\</p>

```json
{"openapi":"3.0.0","info":{"title":"Efalia Process API","version":"6.36.1"},"tags":[{"name":"Directory","description":""}],"servers":[{"url":"http://{hostname}/{workeyContext}/api/","variables":{"hostname":{"default":"localhost:8080","description":"Hostname and port of the Workey server"},"workeyContext":{"default":"workey","description":"Name of the running context of Workey"}}}],"security":[{"Basic":[]},{"Bearer":[]},{"ApiKey":[],"ApiKeyImpersonate":[]}],"components":{"securitySchemes":{"Basic":{"type":"http","scheme":"basic","description":"Value: Basic {encode username:password}"},"Bearer":{"type":"http","scheme":"bearer","description":"Value: Bearer {jwt}"},"ApiKey":{"type":"apiKey","name":"X-API-KEY","in":"header","description":"API key defined in Process configuration."}},"schemas":{"DirectoryUpdateUser":{"type":"object","properties":{"login":{"type":"string"},"name":{"type":"string"},"mail":{"type":"string"}}},"RestMessage":{"type":"object","properties":{"code":{"type":"integer"},"error":{"type":"boolean"},"message":{"type":"string"},"cause":{"$ref":"#/components/schemas/ErrorCause"}}},"ErrorCause":{"type":"object","properties":{"className":{"type":"string"},"method":{"type":"string"},"line":{"type":"integer"},"stackTrace":{"type":"object"}}}},"responses":{"WorkeyUnauthorized":{"description":"Unauthorized Workey access error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestMessage"}}}},"WorkeyError":{"description":"Unexpected Workey Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestMessage"}}}}}},"paths":{"/directory/user":{"delete":{"summary":"Delete a User in the Directory","description":"Delete a user in the LDAP Directory.\n\n<a href=\"./#wky-note-workflow-manager\" class=\"wky-label wky-label-workflow-manager\">Workflow Manager</a>\n### Note\n<p>This resource requires some property to be defined in ``catalina.properties`` to work:</p>\n  <dl>\n      <dt>Login attribute</dt><dd>com.clog.workey.LDAPCreate.attribute.login=uid,sn</dd>\n      <dt>Name attribute</dt><dd>com.clog.workey.LDAPCreate.attribute.name=cn,displayName</dd>\n      <dt>Email attribute</dt><dd>com.clog.workey.LDAPCreate.attribute.email=mail</dd>\n      <dt>Password attribute</dt><dd>com.clog.workey.LDAPCreate.attribute.password=userPassword</dd>\n      <!-- le ${name} sera remplace par le nom, ${login} par le login et ${mail} par l'email -->\n      <dt>DN Template</dt><dd>com.clog.workey.LDAPCreate.contextTemplate=uid=${name},ou=users,ou=system</dd>\n      <dt>objectClass attribute</dt><dd>com.clog.workey.LDAPCreate.objectClass=inetOrgPerson</dd>\n      <dt>Password length</dt><dd>com.clog.workey.LDAPCreate.passwordLength=32</dd>\n      <dt>Characters used for password</dt><dd>com.clog.workey.LDAPCreate.passwordChars=ABCDEF0123456789</dd>\n  </dl>\n  \n  <p>Only JSON input/output is supported.</p>","operationId":"deleteDeleteIdpUser","deprecated":false,"tags":["Directory"],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DirectoryUpdateUser"}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DirectoryUpdateUser"}}}},"401":{"$ref":"#/components/responses/WorkeyUnauthorized"},"555":{"$ref":"#/components/responses/WorkeyError"}}}}}}
```

## Search User by Login

> Find an user knowing their login.\
> \
> \<a href="./#wky-note-manager" class="wky-label wky-label-manager">Manager\</a>

```json
{"openapi":"3.0.0","info":{"title":"Efalia Process API","version":"6.36.1"},"tags":[{"name":"Directory","description":""}],"servers":[{"url":"http://{hostname}/{workeyContext}/api/","variables":{"hostname":{"default":"localhost:8080","description":"Hostname and port of the Workey server"},"workeyContext":{"default":"workey","description":"Name of the running context of Workey"}}}],"security":[{"Basic":[]},{"Bearer":[]},{"ApiKey":[],"ApiKeyImpersonate":[]}],"components":{"securitySchemes":{"Basic":{"type":"http","scheme":"basic","description":"Value: Basic {encode username:password}"},"Bearer":{"type":"http","scheme":"bearer","description":"Value: Bearer {jwt}"},"ApiKey":{"type":"apiKey","name":"X-API-KEY","in":"header","description":"API key defined in Process configuration."}},"schemas":{"Directory":{"type":"object","properties":{"cn":{"type":"string"},"mail":{"type":"string"},"type":{"type":"string"},"dn":{"type":"string"},"fields":{"type":"object","additionalProperties":{"type":"string"}}}},"RestMessage":{"type":"object","properties":{"code":{"type":"integer"},"error":{"type":"boolean"},"message":{"type":"string"},"cause":{"$ref":"#/components/schemas/ErrorCause"}}},"ErrorCause":{"type":"object","properties":{"className":{"type":"string"},"method":{"type":"string"},"line":{"type":"integer"},"stackTrace":{"type":"object"}}}},"responses":{"WorkeyUnauthorized":{"description":"Unauthorized Workey access error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestMessage"}}}},"WorkeyError":{"description":"Unexpected Workey Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestMessage"}}}}}},"paths":{"/directory/{userLogin}":{"get":{"summary":"Search User by Login","description":"Find an user knowing their login.\n\n<a href=\"./#wky-note-manager\" class=\"wky-label wky-label-manager\">Manager</a>","operationId":"callSearchActorLogin","deprecated":false,"tags":["Directory"],"parameters":[{"name":"userLogin","in":"path","required":true,"schema":{"type":"string"},"description":"The login of the user to look for."},{"name":"login","in":"query","schema":{"type":"string"},"required":false,"description":"The directory attribute to use as login attribute."},{"name":"limit","in":"query","schema":{"type":"integer"},"required":false,"description":"Maximum number of entries returned by the filter. Note that the directory server \n can limit itself to a certain number of results."},{"name":"attr","in":"query","schema":{"type":"string"},"required":false,"description":"The name of the directory attribute to fetch."}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Directory"}}}}},"401":{"$ref":"#/components/responses/WorkeyUnauthorized"},"555":{"$ref":"#/components/responses/WorkeyError"}}}}}}
```


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://documentation.efalia.com/api-reference/efalia-process-api/directory.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.