Skip to content

Manage AD OUs with the KopiCloud AD API»

KopiCloud_AD_API

Manage AD Organization Units (OUs) in Microsoft Active Directory using the KopiCloud AD API

List All AD OUs»

GET /api/OU/All

Parameters

Name Type Description Mandatory
ListContainers boolean List All AD Containers, Including Hidden and System Containers (Default = value) No
Auth-Token string Bearer or Basic Authentication Token Yes

Return Schema

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
{
  "output": "string",
  "result": [
    {
      "guid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "name": "string",
      "description": "string",
      "path": "string",
      "protected": true
    }
  ]
}

Get AD OU Details using the GUID»

GET /api/OU/Guid/Details

Parameters

Name Type Description Mandatory
OUGuid string Organization Unit Guid Yes
Auth-Token string Bearer or Basic Authentication Token Yes

Return Schema

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
{
  "output": "string",
  "result": {
    "guid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "name": "string",
    "description": "string",
    "path": "string",
    "protected": true
  }
}

Get AD OU Details using the OU Path»

GET /api/OU/Path/Details

Parameters

Name Type Description Mandatory
OUPath string Organization Unit DN Path Yes
Auth-Token string Bearer or Basic Authentication Token Yes

Return Schema

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
{
  "output": "string",
  "result": {
    "guid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "name": "string",
    "description": "string",
    "path": "string",
    "protected": true
  }
}

Check If the AD OU Exists»

GET /api/OU/Path/Exists

Parameters

Name Type Description Mandatory
OUPath string Organization Unit DN Path Yes
Auth-Token string Bearer or Basic Authentication Token Yes

Return Schema

1
2
3
4
{
  "output": "string",
  "result": true
}

Create an AD OU»

POST /api/OU

Parameters

Name Type Description Mandatory
OUName string Organization Unit Name Yes
OUDestinationPath string Destination Organization Unit DN Path (Parent) Yes
OUDescription string Organization Unit Description No
IsProtected boolean Protect Organization Unit from Accidental Deletion (Default = value) No
Auth-Token string Bearer or Basic Authentication Token Yes

Return Schema

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
{
  "output": "string",
  "result": {
    "guid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "name": "string",
    "description": "string",
    "path": "string",
    "protected": true
  }
}

Update an AD OU»

PUT /api/OU

Parameters

Name Type Description Mandatory
OUPath string Organization Unit DN Path Yes
OUDescription string Organization Unit Description No
IsProtected boolean Protect Organization Unit from Accidental Deletion (Default = value) No
Auth-Token string Bearer or Basic Authentication Token Yes

Return Schema

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
{
  "output": "string",
  "result": {
    "guid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "name": "string",
    "description": "string",
    "path": "string",
    "protected": true
  }
}

Move an AD OU»

PUT /api/OU/Move

Parameters

Name Type Description Mandatory
OUPath string Organization Unit DN Path Yes
OUDestinationPath string Destination Organization DN Path (New Parent OU) Yes
Auth-Token string Bearer or Basic Authentication Token Yes

Return Schema

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
{
  "output": "string",
  "result": {
    "guid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "name": "string",
    "description": "string",
    "path": "string",
    "protected": true
  }
}

Rename an AD OU»

PUT /api/OU/Rename

Parameters

Name Type Description Mandatory
OUPath string Organization Unit DN Path Yes
OUNewName string Organization Unit New Name Yes
Auth-Token string Bearer or Basic Authentication Token Yes

Return Schema

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
{
  "output": "string",
  "result": {
    "guid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "name": "string",
    "description": "string",
    "path": "string",
    "protected": true
  }
}

Delete an AD OU»

DELETE /api/OU/Path/Remove

Parameters

Name Type Description Mandatory
OUPath string Organization Unit DN Path Yes
Force boolean Force Deletion of Protected Organization Unit (Default = value) No
Auth-Token string Bearer or Basic Authentication Token Yes

Return Schema

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
{
  "output": "string",
  "result": {
    "guid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "name": "string",
    "description": "string",
    "path": "string",
    "protected": true
  }
}