Security Groups - Active Directory ​
POST /api/securitygroup
Adding Active Directory Security Groups via the API can be achieved by making a POST request on the URL, with appropriate fields forming the HTTP message body. To manage Security Groups, you must be using the 'Security Groups and User Accounts' API Key from the screen Administration -> System Settings -> API tab.
Note: Once you have added the Security Group via the API, the Passwordstate Windows Service will start synchronizing its members within one minute of the Security Group being added.
Below are a list of all possible fields which can be included in your POST request, explaining which ones are mandatory, and detailed instructions for each field as appropriate.
| Heading | Data Type | Mandatory | Description |
|---|---|---|---|
| SecurityGroupName | String (255) | Yes | The name of the Security Group in Active Directory for |
| Description | String (255) | No | A description for the Security Group. |
| ADDomainNetBIOS | String | Yes | The NetBIOS Name for the appropriate domain from the screen Administration -> Active Directory Domains. |
| APIKey | String | The API Key authorized to add Security Groups, from the screen Administration -> System Settings -> API tab |