title | description | author | ms.topic | ms.devlang | ms.date | ms.author |
---|---|---|---|---|---|---|
Get userGroup |
Gets an user group object in Dynamics 365 Business Central. |
SusanneWindfeldPedersen |
reference |
al |
12/03/2023 |
solsen |
Note
User groups are replaced with security groups and will be deprecated in version 25. For more information, see security group APIs and Control Access to Business Central Using Security Groups.
Retrieves the properties and relationships of an user group object for [!INCLUDEd365fin_long_md].
Replace the URL prefix for [!INCLUDE prod_short] depending on environment following the guideline.
GET /microsoft/automation/v2.0/companies({companyId})/userGroups({userGroupId})
Header | Value |
---|---|
Authorization | Bearer {token}. Required. |
Do not supply a request body for this method.
If successful, this method returns a 200 OK
response code and an userGroup object in the response body.
Request
Here is an example of the request.
GET https://api.businesscentral.dynamics.com/v2.0/{environment name}/api/microsoft/automation/v2.0/companies({companyId})/userGroups({userGroupId})
Response Here is an example of the response.
{
"id": "d38a92e2-9d74-eb11-bb5c-00155df3a615",
"code": "D365 ACCOUNTANTS",
"displayName": "Dynamics 365 for Accountants",
"defaultProfileID": "ACCOUNTANT PORTAL",
"assignToAllNewUsers": false
}