Skip to content

Manage AD Groups with the KopiCloud AD API»

KopiCloud_AD_API

Manage AD Groups in Microsoft Active Directory using the KopiCloud AD API

List AD Groups Inside an OU»

GET /api/ADGroups

Parameters

Name Type Description Mandatory
OUPath string Organization Unit DN Path No
Recursive boolean Recursive Search (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
13
14
{
  "output": "string",
  "result": [
    {
      "guid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "name": "string",
      "scope": "Global",
      "description": "string",
      "email": "string",
      "ouPath": "string",
      "type": "string"
    }
  ]
}

Show AD Group Details»

GET /api/ADGroups/{GroupName}

Parameters

Name Type Description Mandatory
GroupName string AD Group Name Yes
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",
    "scope": "Global",
    "description": "string",
    "email": "string",
    "ouPath": "string",
    "type": "string"
  }
}

Check If an AD Group Exists»

GET /api/ADGroups/{GroupName}/Exists

Parameters

Name Type Description Mandatory
GroupName string AD Group Name Yes
Auth-Token string Bearer or Basic Authentication Token Yes

Return Schema

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

Get a List of All AD Groups»

GET /api/ADGroups/All

Parameters

Name Type Description Mandatory
Auth-Token string Bearer or Basic Authentication Token Yes

Return Schema

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
{
  "output": "string",
  "result": [
    {
      "guid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "name": "string",
      "scope": "Global",
      "description": "string",
      "email": "string",
      "ouPath": "string",
      "type": "string"
    }
  ]
}

List All AD Distribution Groups»

GET /api/ADGroups/Distribution/All

Parameters

Name Type Description Mandatory
OUPath string Organization Unit DN Path No
Recursive boolean Recursive Search (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
13
14
{
  "output": "string",
  "result": [
    {
      "guid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "name": "string",
      "scope": "Global",
      "description": "string",
      "email": "string",
      "ouPath": "string",
      "type": "string"
    }
  ]
}

List All AD Security Groups»

GET /api/ADGroups/Security/All

Parameters

Name Type Description Mandatory
OUPath string Organization Unit DN Path No
Recursive boolean Recursive Search (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
13
14
{
  "output": "string",
  "result": [
    {
      "guid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "name": "string",
      "scope": "Global",
      "description": "string",
      "email": "string",
      "ouPath": "string",
      "type": "string"
    }
  ]
}

Create an AD Distribution Group»

Note: Optional set the OU where to create the group or create it in the default Users OU

POST /api/ADGroups/{GroupName}/Distribution

Parameters

Name Type Description Mandatory
OUPath string Organization Unit DN Path No
GroupName string AD Group Name Yes
GroupScope string AD GroupScope No
GroupDescription string AD Group Description No
GroupEmail string AD Group Email 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",
    "scope": "Global",
    "description": "string",
    "email": "string",
    "ouPath": "string",
    "type": "string"
  }
}

Create an AD Security Group»

Note: Optional set the OU where to create the group or create it in the default Users OU

POST /api/ADGroups/{GroupName}/Security

Parameters

Name Type Description Mandatory
OUPath string Organization Unit DN Path No
GroupName string AD Group Name Yes
GroupScope string AD GroupScope No
GroupDescription string AD Group Description No
GroupEmail string AD Group Email 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",
    "scope": "Global",
    "description": "string",
    "email": "string",
    "ouPath": "string",
    "type": "string"
  }
}

Rename an AD Group»

PUT /api/ADGroups/{GroupName}/Rename/{NewGroupName}

Parameters

Name Type Description Mandatory
GroupName string AD Group Name Yes
NewGroupName string New AD Group Name Yes
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",
    "scope": "Global",
    "description": "string",
    "email": "string",
    "ouPath": "string",
    "type": "string"
  }
}

Delete an AD Group»

DELETE /api/ADGroups/{GroupName}/Remove

Parameters

Name Type Description Mandatory
GroupName string AD Group Name Yes
OUPath string Organization Unit DN Path 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",
    "scope": "Global",
    "description": "string",
    "email": "string",
    "ouPath": "string",
    "type": "string"
  }
}