Get a security group with the automation API

Get the properties and relationships of a security group in Business Central.

HTTP request

Replace the URL prefix for Business Central depending on environment following the guideline.

GET /microsoft/automation/v2.0/companies({companyId})/securityGroups('{securityGroupId}')

Request headers

Header	Value
Authorization	Bearer {token}. Required.

Request body

Don't supply a request body for this method.

Response

If successful, this method returns a 200 OK response code and a securityGroup object in the response body.

Example

Request

Here's an example of the request.

GET https://api.businesscentral.dynamics.com/v2.0/{environment name}/api/microsoft/automation/v2.0/companies({companyId})/securityGroups('{securityGroupId}')

Response

Here's an example of the response.

{
    "id": "00aa00aa-bb11-cc22-dd33-44ee44ee44ee",
    "code": "FINANCE",
    "groupName": "Finance",
    "groupUserSecurityId": "aaaaaaaa-0000-1111-2222-bbbbbbbbbbbb",
    "groupId": "00aa00aa-bb11-cc22-dd33-44ee44ee44ee",
    "retrievedSuccessfully": true
}

Related information

Tips for working with the APIs
Security group DELETE securityGroup