Endpoints

Create

The create endpoints are broken into 3 distinct controllers:

Group

OrganizationalUnit

User

Create Query Parameters

All of the create endpoints allow for these query parameters in the request:

Name	Type	Enum Values	Default Value	Description
domain	string		null	The domain or domain controller the server should use..

---

Delete

Deletes an object from Active Directory.

• Request Type - DELETE

Query Parameters

Name	Type	Enum Values	Default Value	Description
dn*	string		N/A	The distinguishedName of the object to delete.
domain	string		null	The domain or domain controller the server should use.

---

Edit

Edits an existing object in Active Directory.

• Request Type - PUT

Request Body

See Edit Operation - JSON Body Syntax

Edit Query Parameters

Name	Type	Enum Values	Default Value	Description
domain	string		null	The domain or domain controller the server should use.

---

Move

Moves an Active Directory object to new container/OU.

• Request Type - POST

Request Body

{
  "dn": "<DN of the object to move>",
  "dest": "<DN of the container or OU to move the object into>"
}

Move Query Parameters

Name	Type	Enum Values	Default Value	Description
domain	string		null	The domain or domain controller the server should use.

---

Password

The password endpoints are broken into 2 distinct operations:

Change

Reset

Password Query Parameters

Name	Type	Enum Values	Default Value	Description
domain	string		null	The domain or domain controller the server should use.

---

Rename

Renames an Active Directory object. This is functionally the same as a simple CommonName (CN) change or a move operation with a new CN set.

• Request Type - PUT

Request Body

{
  "dn": "<DN of the object to rename>",
  "newName": "<The new CN of the object>"
}

Rename Query Parameters

Name	Type	Enum Values	Default Value	Description
domain	string		null	The domain or domain controller the server should use.

---

Search

The search endpoint is broken into 4 distinct controllers:

Computer

Generic

Group

User

Search Query Parameters

All of the search endpoints allow for these query parameters in the request:

Name	Type	Enum Values	Default Value	Description
domain	string		null	The domain or domain controller the server should use in the search.
includeDetails	boolean		false	Indicates the response should details about the LDAP query that was made.
limit	integer		0	Set the limit size of the query; 0 indicates 'use server limit'.
properties	string[]		null	A space (or '+') delimited list of additional properties that each found result should return with.
scope	string	base, oneLevel, subtree	subtree	The search scope the query is performed with.
searchBase	string		null	The distinguishedName of the SearchBase the query should start at.
sortBy	string		name	The property the results will sorted by.
sortDir	string	asc, desc	asc	The sort direction.

---

Asterisk

* = Required Parameter