Skip to content

Manage AD Users with the KopiCloud AD API»

KopiCloud_AD_API

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

Show AD User Details»

GET /api/ADUser/{UserName}/Details

Parameters

Name Type Description Mandatory
Username string AD User Name Yes
ShowFields string Recursive Search 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
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
{
  "output": "string",
  "result": {
    "guid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "username": "string",
    "firstName": "string",
    "lastName": "string",
    "displayName": "string",
    "description": "string",
    "emailAddress": "string",
    "department": "string",
    "office": "string",
    "company": "string",
    "samUsername": "string",
    "initials": "string",
    "ouPath": "string",
    "changePasswordNextLogon": true,
    "passwordNeverExpired": true,
    "jobTitle": "string",
    "manager": "string",
    "streetAddress": "string",
    "streetPoBox": "string",
    "city": "string",
    "state": "string",
    "postalCode": "string",
    "country": "string",
    "officePhone": "string",
    "homePhone": "string",
    "mobilePhone": "string",
    "profilePath": "string",
    "profileLogonScript": "string",
    "homeFolderPath": "string",
    "homeFolderDrive": "string",
    "homeFolderDirectory": "string",
    "rdsProfilePath": "string",
    "rdsHomeFolderPath": "string",
    "rdsHomeFolderDrive": "string",
    "rdsConnectDrive": true,
    "rdsAllowLogon": true,
    "_IncludeAllProperties": true,
    "_ShowFields": [
      "string"
    ]
  }
}

Check If AD User Exist»

GET /api/ADUser/{UserName}/Exists

Parameters

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

Return Schema

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

Show AD User Last Logon»

GET /api/ADUser/{UserName}/LastLogon

Parameters

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

Return Schema

1
2
3
4
{
  "output": "string",
  "result": "2023-03-24T18:01:26.340Z"
}

List AD Users Inside an OU»

GET /api/ADUser/ListUsers

Parameters

Name Type Description Mandatory
OUPath string Organization Unit DN Path No
ShowFields string User Fields to show. Optional argument: comma-separated string with the name of the fields you want to be returned No
Recursive boolean Recursive Search (Default = true) Yes
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
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
{
  "output": "string",
  "result": [
    {
      "guid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "username": "string",
      "firstName": "string",
      "lastName": "string",
      "displayName": "string",
      "description": "string",
      "emailAddress": "string",
      "department": "string",
      "office": "string",
      "company": "string",
      "samUsername": "string",
      "initials": "string",
      "ouPath": "string",
      "changePasswordNextLogon": true,
      "passwordNeverExpired": true,
      "jobTitle": "string",
      "manager": "string",
      "streetAddress": "string",
      "streetPoBox": "string",
      "city": "string",
      "state": "string",
      "postalCode": "string",
      "country": "string",
      "officePhone": "string",
      "homePhone": "string",
      "mobilePhone": "string",
      "profilePath": "string",
      "profileLogonScript": "string",
      "homeFolderPath": "string",
      "homeFolderDrive": "string",
      "homeFolderDirectory": "string",
      "rdsProfilePath": "string",
      "rdsHomeFolderPath": "string",
      "rdsHomeFolderDrive": "string",
      "rdsConnectDrive": true,
      "rdsAllowLogon": true,
      "_IncludeAllProperties": true,
      "_ShowFields": [
        "string"
      ]
    }
  ]
}

List All AD Users»

GET /api/ADUser/ListUsers/All

Parameters

Name Type Description Mandatory
ShowFields string Optional argument: comma-separated string with the name of the fields you want to be returned 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
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
{
  "output": "string",
  "result": [
    {
      "guid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "username": "string",
      "firstName": "string",
      "lastName": "string",
      "displayName": "string",
      "description": "string",
      "emailAddress": "string",
      "department": "string",
      "office": "string",
      "company": "string",
      "samUsername": "string",
      "initials": "string",
      "ouPath": "string",
      "changePasswordNextLogon": true,
      "passwordNeverExpired": true,
      "jobTitle": "string",
      "manager": "string",
      "streetAddress": "string",
      "streetPoBox": "string",
      "city": "string",
      "state": "string",
      "postalCode": "string",
      "country": "string",
      "officePhone": "string",
      "homePhone": "string",
      "mobilePhone": "string",
      "profilePath": "string",
      "profileLogonScript": "string",
      "homeFolderPath": "string",
      "homeFolderDrive": "string",
      "homeFolderDirectory": "string",
      "rdsProfilePath": "string",
      "rdsHomeFolderPath": "string",
      "rdsHomeFolderDrive": "string",
      "rdsConnectDrive": true,
      "rdsAllowLogon": true,
      "_IncludeAllProperties": true,
      "_ShowFields": [
        "string"
      ]
    }
  ]
}

Create AD User»

POST /api/ADUser/{UserName}

Parameters

Name Type Description Mandatory
Username string AD User Name Yes
Password string User Password No
FirstName string AD User First Name No
Initials string AD User Initials No
LastName string AD User LastName No
DisplayName string User DisplayName No
Description string User Description No
EmailAddress string User Email Address No
Department string User Department No
Office string User Office No
Company string User Company No
OUPath string Organization Unit DN Path No
ChangePasswordNextLogon boolean User Must Change Password at Next Logon (Default = true) No
PasswordNeverExpired boolean Password never expire. (Default = false) No
JobTitle string AD User Job Title No
Manager string AD User Manager No
Street string AD User Street No
POBox string AD User Po Box No
City string AD User City No
State string AD User State No
ZipCode string AD User Zip Code No
Country string AD User Country No
OfficePhone string AD User Office Phone No
HomePhone string AD User Home Phone No
MobilePhone string AD User Mobile Phone No
ProfilePath string AD User Profile Path No
ProfileLogonScript string AD User Profile Logon Script No
HomeFolderPath string AD User Home Folder Path No
HomeFolderDrive string AD User Home Folde rDrive No
HomeFolderDirectory string AD User Home Folder Directory No
RdsProfilePath string AD User Rds Profile Path No
RdsHomeFolderPath string AD User Rds Home Folder Path No
RdsHomeFolderDrive string AD User Rds Home Folder Drive No
RdsConnectDrive boolean AD User Rds Connect Drive (Default = false) No
RdsAllowLogon string AD User Allow RDS Logon (Default = true) No
ShowFields string User Fields to show. Optional argument: comma-separated string with the name of the fields you want to be returned 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
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
{
  "output": "string",
  "result": {
    "guid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "username": "string",
    "firstName": "string",
    "lastName": "string",
    "displayName": "string",
    "description": "string",
    "emailAddress": "string",
    "department": "string",
    "office": "string",
    "company": "string",
    "samUsername": "string",
    "initials": "string",
    "ouPath": "string",
    "changePasswordNextLogon": true,
    "passwordNeverExpired": true,
    "jobTitle": "string",
    "manager": "string",
    "streetAddress": "string",
    "streetPoBox": "string",
    "city": "string",
    "state": "string",
    "postalCode": "string",
    "country": "string",
    "officePhone": "string",
    "homePhone": "string",
    "mobilePhone": "string",
    "profilePath": "string",
    "profileLogonScript": "string",
    "homeFolderPath": "string",
    "homeFolderDrive": "string",
    "homeFolderDirectory": "string",
    "rdsProfilePath": "string",
    "rdsHomeFolderPath": "string",
    "rdsHomeFolderDrive": "string",
    "rdsConnectDrive": true,
    "rdsAllowLogon": true,
    "_IncludeAllProperties": true,
    "_ShowFields": [
      "string"
    ]
  }
}

Update AD User»

PUT /api/ADUser/{UserName}

Parameters

Name Type Description Mandatory
Username string AD User Name Yes
Password string User Password No
FirstName string AD User First Name No
Initials string AD User Initials No
LastName string AD User LastName No
DisplayName string User DisplayName No
Description string User Description No
EmailAddress string User Email Address No
Department string User Department No
Office string User Office No
Company string User Company No
OUPath string Organization Unit DN Path No
ChangePasswordNextLogon boolean User Must Change Password at Next Logon (Default = true) No
PasswordNeverExpired boolean Password never expire. (Default = false) No
JobTitle string AD User Job Title No
Manager string AD User Manager No
Street string AD User Street No
POBox string AD User Po Box No
City string AD User City No
State string AD User State No
ZipCode string AD User Zip Code No
Country string AD User Country No
OfficePhone string AD User Office Phone No
HomePhone string AD User Home Phone No
MobilePhone string AD User Mobile Phone No
ProfilePath string AD User Profile Path No
ProfileLogonScript string AD User Profile Logon Script No
HomeFolderPath string AD User Home Folder Path No
HomeFolderDrive string AD User Home Folde rDrive No
HomeFolderDirectory string AD User Home Folder Directory No
RdsProfilePath string AD User Rds Profile Path No
RdsHomeFolderPath string AD User Rds Home Folder Path No
RdsHomeFolderDrive string AD User Rds Home Folder Drive No
RdsConnectDrive boolean AD User Rds Connect Drive (Default = false) No
RdsAllowLogon string AD User Allow RDS Logon (Default = true) No
ShowFields string User Fields to show. Optional argument: comma-separated string with the name of the fields you want to be returned 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
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
{
  "output": "string",
  "result": {
    "guid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "username": "string",
    "firstName": "string",
    "lastName": "string",
    "displayName": "string",
    "description": "string",
    "emailAddress": "string",
    "department": "string",
    "office": "string",
    "company": "string",
    "samUsername": "string",
    "initials": "string",
    "ouPath": "string",
    "changePasswordNextLogon": true,
    "passwordNeverExpired": true,
    "jobTitle": "string",
    "manager": "string",
    "streetAddress": "string",
    "streetPoBox": "string",
    "city": "string",
    "state": "string",
    "postalCode": "string",
    "country": "string",
    "officePhone": "string",
    "homePhone": "string",
    "mobilePhone": "string",
    "profilePath": "string",
    "profileLogonScript": "string",
    "homeFolderPath": "string",
    "homeFolderDrive": "string",
    "homeFolderDirectory": "string",
    "rdsProfilePath": "string",
    "rdsHomeFolderPath": "string",
    "rdsHomeFolderDrive": "string",
    "rdsConnectDrive": true,
    "rdsAllowLogon": true,
    "_IncludeAllProperties": true,
    "_ShowFields": [
      "string"
    ]
  }
}

Disable AD User»

PUT /api/ADUser/{UserName}/Disable

Parameters

Name Type Description Mandatory
Username string AD User Name Yes
ShowFields string User Fields to show. Optional argument: comma-separated string with the name of the fields you want to be returned 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
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
{
  "output": "string",
  "result": {
    "guid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "username": "string",
    "firstName": "string",
    "lastName": "string",
    "displayName": "string",
    "description": "string",
    "emailAddress": "string",
    "department": "string",
    "office": "string",
    "company": "string",
    "samUsername": "string",
    "initials": "string",
    "ouPath": "string",
    "changePasswordNextLogon": true,
    "passwordNeverExpired": true,
    "jobTitle": "string",
    "manager": "string",
    "streetAddress": "string",
    "streetPoBox": "string",
    "city": "string",
    "state": "string",
    "postalCode": "string",
    "country": "string",
    "officePhone": "string",
    "homePhone": "string",
    "mobilePhone": "string",
    "profilePath": "string",
    "profileLogonScript": "string",
    "homeFolderPath": "string",
    "homeFolderDrive": "string",
    "homeFolderDirectory": "string",
    "rdsProfilePath": "string",
    "rdsHomeFolderPath": "string",
    "rdsHomeFolderDrive": "string",
    "rdsConnectDrive": true,
    "rdsAllowLogon": true,
    "_IncludeAllProperties": true,
    "_ShowFields": [
      "string"
    ]
  }
}

Enable AD User»

PUT /api/ADUser/{UserName}/Enable

Parameters

Name Type Description Mandatory
Username string AD User Name Yes
ShowFields string User Fields to show. Optional argument: comma-separated string with the name of the fields you want to be returned 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
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
{
  "output": "string",
  "result": {
    "guid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "username": "string",
    "firstName": "string",
    "lastName": "string",
    "displayName": "string",
    "description": "string",
    "emailAddress": "string",
    "department": "string",
    "office": "string",
    "company": "string",
    "samUsername": "string",
    "initials": "string",
    "ouPath": "string",
    "changePasswordNextLogon": true,
    "passwordNeverExpired": true,
    "jobTitle": "string",
    "manager": "string",
    "streetAddress": "string",
    "streetPoBox": "string",
    "city": "string",
    "state": "string",
    "postalCode": "string",
    "country": "string",
    "officePhone": "string",
    "homePhone": "string",
    "mobilePhone": "string",
    "profilePath": "string",
    "profileLogonScript": "string",
    "homeFolderPath": "string",
    "homeFolderDrive": "string",
    "homeFolderDirectory": "string",
    "rdsProfilePath": "string",
    "rdsHomeFolderPath": "string",
    "rdsHomeFolderDrive": "string",
    "rdsConnectDrive": true,
    "rdsAllowLogon": true,
    "_IncludeAllProperties": true,
    "_ShowFields": [
      "string"
    ]
  }
}

Rename AD User»

PUT /api/ADUser/{UserName}/Rename/{NewUserName}

Parameters

Name Type Description Mandatory
Username string AD User Name Yes
NewUsername string New AD User Name No
ShowFields string User Fields to show. Optional argument: comma-separated string with the name of the fields you want to be returned 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
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
{
  "output": "string",
  "result": {
    "guid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "username": "string",
    "firstName": "string",
    "lastName": "string",
    "displayName": "string",
    "description": "string",
    "emailAddress": "string",
    "department": "string",
    "office": "string",
    "company": "string",
    "samUsername": "string",
    "initials": "string",
    "ouPath": "string",
    "changePasswordNextLogon": true,
    "passwordNeverExpired": true,
    "jobTitle": "string",
    "manager": "string",
    "streetAddress": "string",
    "streetPoBox": "string",
    "city": "string",
    "state": "string",
    "postalCode": "string",
    "country": "string",
    "officePhone": "string",
    "homePhone": "string",
    "mobilePhone": "string",
    "profilePath": "string",
    "profileLogonScript": "string",
    "homeFolderPath": "string",
    "homeFolderDrive": "string",
    "homeFolderDirectory": "string",
    "rdsProfilePath": "string",
    "rdsHomeFolderPath": "string",
    "rdsHomeFolderDrive": "string",
    "rdsConnectDrive": true,
    "rdsAllowLogon": true,
    "_IncludeAllProperties": true,
    "_ShowFields": [
      "string"
    ]
  }
}

Reset AD User Password»

PUT /api/ADUser/{UserName}/ResetPassword

Parameters

Name Type Description Mandatory
Username string AD User Name Yes
newPassword string New User Password No
ChangePassword boolean Force User to Change Password on Next Login (Default = false) No
ShowFields string User Fields to show. Optional argument: comma-separated string with the name of the fields you want to be returned 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
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
{
  "output": "string",
  "result": {
    "guid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "username": "string",
    "firstName": "string",
    "lastName": "string",
    "displayName": "string",
    "description": "string",
    "emailAddress": "string",
    "department": "string",
    "office": "string",
    "company": "string",
    "samUsername": "string",
    "initials": "string",
    "ouPath": "string",
    "changePasswordNextLogon": true,
    "passwordNeverExpired": true,
    "jobTitle": "string",
    "manager": "string",
    "streetAddress": "string",
    "streetPoBox": "string",
    "city": "string",
    "state": "string",
    "postalCode": "string",
    "country": "string",
    "officePhone": "string",
    "homePhone": "string",
    "mobilePhone": "string",
    "profilePath": "string",
    "profileLogonScript": "string",
    "homeFolderPath": "string",
    "homeFolderDrive": "string",
    "homeFolderDirectory": "string",
    "rdsProfilePath": "string",
    "rdsHomeFolderPath": "string",
    "rdsHomeFolderDrive": "string",
    "rdsConnectDrive": true,
    "rdsAllowLogon": true,
    "_IncludeAllProperties": true,
    "_ShowFields": [
      "string"
    ]
  }
}

Unlock AD User»

PUT /api/ADUser/{UserName}/Unlock

Parameters

Name Type Description Mandatory
Username string AD User Name Yes
ShowFields string User Fields to show. Optional argument: comma-separated string with the name of the fields you want to be returned 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
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
{
  "output": "string",
  "result": {
    "guid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "username": "string",
    "firstName": "string",
    "lastName": "string",
    "displayName": "string",
    "description": "string",
    "emailAddress": "string",
    "department": "string",
    "office": "string",
    "company": "string",
    "samUsername": "string",
    "initials": "string",
    "ouPath": "string",
    "changePasswordNextLogon": true,
    "passwordNeverExpired": true,
    "jobTitle": "string",
    "manager": "string",
    "streetAddress": "string",
    "streetPoBox": "string",
    "city": "string",
    "state": "string",
    "postalCode": "string",
    "country": "string",
    "officePhone": "string",
    "homePhone": "string",
    "mobilePhone": "string",
    "profilePath": "string",
    "profileLogonScript": "string",
    "homeFolderPath": "string",
    "homeFolderDrive": "string",
    "homeFolderDirectory": "string",
    "rdsProfilePath": "string",
    "rdsHomeFolderPath": "string",
    "rdsHomeFolderDrive": "string",
    "rdsConnectDrive": true,
    "rdsAllowLogon": true,
    "_IncludeAllProperties": true,
    "_ShowFields": [
      "string"
    ]
  }
}

Delete AD User»

DELETE /api/ADUser/{UserName}

Parameters

Name Type Description Mandatory
Username string AD User Name Yes
ShowFields string User Fields to show. Optional argument: comma-separated string with the name of the fields you want to be returned 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
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
{
  "output": "string",
  "result": {
    "guid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "username": "string",
    "firstName": "string",
    "lastName": "string",
    "displayName": "string",
    "description": "string",
    "emailAddress": "string",
    "department": "string",
    "office": "string",
    "company": "string",
    "samUsername": "string",
    "initials": "string",
    "ouPath": "string",
    "changePasswordNextLogon": true,
    "passwordNeverExpired": true,
    "jobTitle": "string",
    "manager": "string",
    "streetAddress": "string",
    "streetPoBox": "string",
    "city": "string",
    "state": "string",
    "postalCode": "string",
    "country": "string",
    "officePhone": "string",
    "homePhone": "string",
    "mobilePhone": "string",
    "profilePath": "string",
    "profileLogonScript": "string",
    "homeFolderPath": "string",
    "homeFolderDrive": "string",
    "homeFolderDirectory": "string",
    "rdsProfilePath": "string",
    "rdsHomeFolderPath": "string",
    "rdsHomeFolderDrive": "string",
    "rdsConnectDrive": true,
    "rdsAllowLogon": true,
    "_IncludeAllProperties": true,
    "_ShowFields": [
      "string"
    ]
  }
}