Update Active Directory filter settings by id
|
Title |
Get Active Directory filter settings by id |
|
Group |
admin |
|
URL Path |
vault_rest/settings/ ad_filter_settings /{id} |
|
Method |
POST |
|
Access |
Internal |
|
Http return |
200, 400, 401, 403, 500 |
|
Table of Contents |
|
|
Last Updated |
06 Aug 2019 |
Summary
Update Active Directory synchronization settings to achieve integration in MetaDefender Vault.
Use Cases (used by)
Used by UI to update the Active Directory synchronization settings. These settings ensure that MetaDefender Vault is integrated with Active Directory and users added to Active Directory groups are also seen in MetaDefender Vault.
HTTP header parameters
|
Authorization |
The authentication token of the caller |
REQUIRED |
This header should have the following format: Bearer [ Example: Bearer Cp01BwnXAIOLZXxn7yogjKqIZnZpQD |
Request Error
|
400 |
Bad Request |
Invalid HTTP request |
|
403 |
Forbidden |
Authentication token is incorrect |
|
500 |
Internal Server Error |
Server is temporarily unavailable |
Method: POST
|
HTTP body |
JSON body |
REQUIRED |
Sample HTTP body
{ "admin_groups":[ { "dn":"CN=Administrators,CN=Builtin,DC=opswat,DC=local","guid":"bc5f7352410e4ad4b9dbf6aab9cfb1c4","last_ad_change":"2016-08-31T17:39:22.0000000","name":"Administrators"}],"included_groups":[ { "dn":"CN=Users,CN=Builtin,DC=opswat,DC=local","guid":"31bd0d22eb454163acb7ac145e6a9524","last_ad_change":"2016-08-31T16:54:38.0000000","name":"Users"}],"excluded_groups":[ ],"included_ou":[ { "distinguished_name":"OU=OU1,DC=opswat,DC=local","full_name":null,"guid":"84c380bbf18e4ccea5ffc76645600688","last_ad_change":"2018-03-09T15:19:24.0000000","name":"OU1"}],"excluded_ou":[ ]}
Descriptions of response:
|
dn/ distinguished_name |
Specifies the distinguished name |
string |
|
guid |
Globally unique identifier of the group |
string |
|
last_ad_change |
Specifies the last time related change in AD |
integer |
|
name |
Name of group |
string |
Response
Example of a successful request:
{"message":null,"ui_message_key":null}Example of a failed request:
{"message": "Couldn't found Active Directory settings","ui_message_key": "ACTIVE_DIRECTORY_NOT_FOUND","status_code": "NotFound"}