Title	Enumerate Active Directories
Group	admin
URL Path	vault_rest/settings/ activedirectories
Method	GET
Access	Internal

Http return	200, 400, 401, 403, 500
Table of Contents	Summary Use Cases (used by) HTTP header parameters Method: POST Descriptions of request: Request Error Response Example of successful request: Example of failed request: Descriptions of response:
Last Updated	06 Aug 2019

Summary

Returns MetaDefender Vault Active Directories.

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 API key of the caller	REQUIRED	This header should have the following format: Bearer [ API key obtained from authenticate API] Example: Bearer Cp01BwnXAIOLZXxn7yogjKqIZnZpQD

Request Error

400	Bad Request	Invalid HTTP request
403	Forbidden	API key is incorrect
500	Internal Server Error	Server is temporarily unavailable

Response

Example of a successful request:

{  
   "items":[  
      {  
         "changes_check_period":240,
         "configured":true,
         "enabled":true,
         "id":1,
         "server_address":"WIN-61PRPU3NJ0D.opswat.com",
         "users_count":213
      }
   ]
}

Descriptions of request:

changes_check_period	Specifies the time interval between synchronizations	positive integer
configured	Specifies if Active Directory is configured	true/false
enabled	Specifies if Active Directory Synchronization is enabled	true/false
id	Specifies how many AD are configured	positive integer
server_address	The address of the Active Directory server	string or integer
users_count	Specifies how many users are in Active Directories	integer