Edit

Share via

(automation API) Create userGroupPermission

  • Article

Creates a user group permission in Dynamics 365 Business Central.

HTTP request

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

POST /microsoft/automation/v2.0/companies({companyId})/userGroups({userGroupId})/userGroupPermission

Request headers

Header Value
Authorization Bearer {token}. Required.
Content-Type application/json

Request body

In the request body, supply a JSON representation of a userGroupPermission object.

Response

If successful, this method returns 201 Created response code and a userGroupPermission object in the response body.

Example

Request

Here is an example of the request.

POST https://api.businesscentral.dynamics.com/v2.0/{environment name}/api/microsoft/automation/v2.0/companies({companyId})/userGroups({userGroupId})/userGroupPermission
Content-Type:application/json
{ 
    "roleId": "D365 COMPANY HUB", 
    "displayName": "D365 COMPANY HUB"
}

Response

Here is an example of the response.

Note

The response object shown here may be truncated for brevity. All of the properties will be returned from an actual call.

{
    "id": "d38a92e2-9d74-eb11-bb5c-00155df3a615",
    "userGroupCode": "D365 COMPANY HUB",
    "roleId": "D365 COMPANY HUB",
    "displayName": "D365 COMPANY HUB",
    "appID": "00001111-aaaa-2222-bbbb-3333cccc4444",
    "scope": "System",
    "extensionName": ""
}

Tips for working with the APIs
userGroupPermission