Manage AD Group Membership with the KopiCloud AD API»

Manage AD Group Membership in Microsoft Active Directory using the KopiCloud AD API

Check If a User Is a Member of an AD Group and return the AD Group»

GET /api/ADUser/{Username}/Group/{GroupName}

Parameters

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

Return Schema

{
  "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 User Is a Member of an AD Group»

GET /api/ADUser/{Username}/Group/{GroupName}/Exists

Parameters

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

Return Schema

{
  "output": "string",
  "result": true
}

Get AD User Group Membership»

GET /api/ADUser/{Username}/Group/All

Parameters

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

Return Schema

{
  "output": "string",
  "result": [
    {
      "guid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "name": "string",
      "scope": "Global",
      "description": "string",
      "email": "string",
      "ouPath": "string",
      "type": "string"
    }
  ]
}

Add an AD User to an AD Group»

POST /api/ADUser/{Username}/Group/{GroupName}

Parameters

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

Return Schema

{
  "output": "string",
  "result": {
    "guid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "name": "string",
    "scope": "Global",
    "description": "string",
    "email": "string",
    "ouPath": "string",
    "type": "string"
  }
}

Remove an AD User from an AD Group»

DELETE /api/ADUser/{Username}/Group/{GroupName}

Parameters

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

Return Schema

{
  "output": "string",
  "result": {
    "guid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "name": "string",
    "scope": "Global",
    "description": "string",
    "email": "string",
    "ouPath": "string",
    "type": "string"
  }
}

Add an AD Group to an AD Group »

POST /api/ADGroup/{ParentGroupName}/Group/{ChildGroupName}

Parameters

Name	Type	Description	Mandatory
ParentGroupName	string	Parent AD Group Name	Yes
ChildGroupName	string	Child AD Group Name	Yes
Auth-Token	string	Bearer or Basic Authentication Token	Yes

Return Schema

{
  "output": "string",
  "result": {
    "guid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "name": "string",
    "scope": "Global",
    "description": "string",
    "email": "string",
    "ouPath": "string",
    "type": "string"
  }
}

Remove an AD Group Name from an AD Group Name »

DELETE /api/ADGroup/{ParentGroupName}/Group/{ChildGroupName}

Parameters

Name	Type	Description	Mandatory
ParentGroupName	string	Parent AD Group Name	Yes
ChildGroupName	string	Child AD Group Name	Yes
Auth-Token	string	Bearer or Basic Authentication Token	Yes

Return Schema

{
  "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 Is a Member of an AD Group »

GET /api/ADGroup/{ParentGroupName}/Group/{ChildGroupName}/Exists

Parameters

Name	Type	Description	Mandatory
ParentGroupName	string	Parent AD Group Name	Yes
ChildGroupName	string	Child AD Group Name	Yes
Auth-Token	string	Bearer or Basic Authentication Token	Yes

Return Schema

{
  "output": "string",
  "result": true
}