Active Directory Change APIs
Create User Account (POST)
Creates a user account in AD and returns the result of this task.
Route
|
URI |
/api/v1/account |
|
Method |
POST |
|
Result |
JSON – IActionResult |
Parameters
|
Name |
Type |
Mandatory |
Description |
|---|---|---|---|
|
data |
CreateUserAccountArgument |
No |
|
Example
POST http://localhost/api/v1/account
Delete Account2 (DELETE)
Deletes a user or group account and returns the result of this task.
Route
|
URI |
/api/v1/account |
|
Method |
DELETE |
|
Result |
JSON – IActionResult |
Request Payload
DeleteAccountArgument object:
|
Property |
Type |
Mandatory |
Description |
|---|---|---|---|
|
AccountDn |
string |
Yes |
|
|
Comment |
string |
Yes |
|
|
DeleteNonEmpties |
bool |
No |
Indicates that non-empty groups should also be deleted |
|
DeleteRelatedAces |
bool |
No |
Indicates that all account relates aces should be removed additionally |
|
ExecutionDate |
string |
No |
An optional execution date. |
Example
DELETE http://localhost/api/v1/account
Activate User Account (POST)
Activate Useraccount in AD.
Route
|
URI |
/api/v1/account/activateUser |
|
Method |
POST |
|
Result |
JSON – IActionResult |
Request Payload
ActivateAccountRequestArgument object:
|
Property |
Type |
Mandatory |
Description |
|---|---|---|---|
|
UserAccountDn |
string |
Yes |
|
|
MoveToRecyclingOu |
bool |
No |
Indicates if the deactivated account should be moved into the recycling OU configured for this domain in 8MAN. |
|
Comment |
string |
Yes |
|
|
ExecutionDate |
string |
No |
An optional execution date. |
Example
POST http://localhost/api/v1/account/activateUser Content-Type: application/json
{
"UserAccountDn": "sample",
"MoveToRecyclingOu": true,
"Comment": "sample",
"ExecutionDate": "sample"
}
Deactivate User Account (POST)
Deactivates a user account, optionally moves it into the preconfigured recycling OU ("soft delete"), and returns the result of this task.
Route
|
URI |
/api/v1/account/deactivateUser |
|
Method |
POST |
|
Result |
JSON – IActionResult |
Request Payload
ActivateAccountRequestArgument object:
|
Property |
Type |
Mandatory |
Description |
|---|---|---|---|
|
UserAccountDn |
string |
Yes |
|
|
MoveToRecyclingOu |
bool |
No |
Indicates if the deactivated account should be moved into the recycling OU configured for this domain in 8MAN. |
|
Comment |
string |
Yes |
|
|
ExecutionDate |
string |
No |
An optional execution date. |
Example
POST http://localhost/api/v1/account/deactivateUser Content-Type: application/json
{
"UserAccountDn": "sample",
"MoveToRecyclingOu": true,
"Comment": "sample",
"ExecutionDate": "sample"
}
Modify Group Memberships (POST)
Change AD group memberships for the given account
Route
|
URI |
/api/v1/account/groupmember |
|
Method |
POST |
|
Result |
JSON – KeyValuePair<string, ChangeResult>[] |
Parameters
|
Name |
Type |
Mandatory |
Description |
|---|---|---|---|
|
data |
ModifyGroupMembershipsArgument |
No |
|
Example
POST http://localhost/api/v1/account/groupmember
Modify Ldap Attributes (POST)
Modify LDAP Attributes for AD for the given account.
Route
|
URI |
/api/v1/account/ldap |
|
Method |
POST |
|
Result |
JSON – IActionResult |
Parameters
|
Name |
Type |
Mandatory |
Description |
|---|---|---|---|
|
data |
ModifyLdapAttributesArguments |
No |
|
Example
POST http://localhost/api/v1/account/ldap
Reset Password (POST)
Reset the password of an AD account.
Route
|
URI |
/api/v1/account/resetpassword |
|
Method |
POST |
|
Result |
JSON – ChangeResult |
Parameters
|
Name |
Type |
Mandatory |
Description |
|---|---|---|---|
|
resetPasswordRequest |
ResetPasswordRequest |
No |
|
Response Structure Returns ChangeResult object containing:
-
Success: bool value
-
Data: object value
-
ResponseId: Guid? value
-
ErrorDetails: ExternalInterfaceException value
Example
POST http://localhost/api/v1/account/resetpassword
Example Response
{ "Success": true, "Data": {}, "ResponseId": "123e4567-e89b-12d3-a456-426614174000", "ErrorDetails": {} }
Modify User Account Control (POST)
Modify AD UAC parameters of given account
Route
|
URI |
/api/v1/account/uac |
|
Method |
POST |
|
Result |
JSON – IActionResult |
Parameters
|
Name |
Type |
Mandatory |
Description |
|---|---|---|---|
|
data |
ModifyUserAccountControlArgument |
No |
|
Example
POST http://localhost/api/v1/account/uac
Delete Account2 (POST)
Deletes a user or group account and returns the result of this task.
Route
|
URI |
/api/v1/deleteAccount |
|
Method |
POST |
|
Result |
JSON – IActionResult |
Request Payload
DeleteAccountArgument object:
|
Property |
Type |
Mandatory |
Description |
|---|---|---|---|
|
AccountDn |
string |
Yes |
|
|
Comment |
string |
Yes |
|
|
DeleteNonEmpties |
bool |
No |
Indicates that non-empty groups should also be deleted |
|
DeleteRelatedAces |
bool |
No |
Indicates that all account relates aces should be removed additionally |
|
ExecutionDate |
string |
No |
An optional execution date. |
Example
POST http://localhost/api/v1/deleteAccount Content-Type: application/json
{
"AccountDn": "sample",
"Comment": "sample",
"DeleteNonEmpties": true,
"DeleteRelatedAces": true,
"ExecutionDate": "sample"
}
Create Group Account (POST)
Creates a new active directory group.
Route
|
URI |
/api/v1/group |
|
Method |
POST |
|
Result |
JSON – IActionResult |
Parameters
|
Name |
Type |
Mandatory |
Description |
|---|---|---|---|
|
data |
CreateGroupAccountArgument |
No |
|
Example
POST http://localhost/api/v1/group