userGroup resource type

Represents an user group in Dynamics 365 Business Central.

Note

For information about enabling APIs for Business Central see Enabling the APIs for Dynamics 365 Business Central.

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.

Methods

MethodReturn TypeDescription
GET userGroupuserGroupGets a user group object.
DELETE userGroupnoneDeletes a user group object.
POST userGroupuserGroupCreates a user group object.
PATCH userGroupuserGroupUpdates a user group object.
NavigationReturn TypeDescription
userGroupPermissionsuserGroupPermissionsGets the permissions of the userGroup.
profileprofileGets the profile of the userGroup.

Properties

PropertyTypeDescription
idGUIDThe unique ID of the user group. Non-editable.
codestringThe code of the user group.
displayNamestringSpecifies the user group's name. This name will appear on all sales documents for the user group.
defaultProfileIDstringThe ID of the defaultProfile.
assignToAllNewUsersbooleanIf true, all new users are assigned to user group.

JSON representation

Here is a JSON representation of the userGroup resource.

{
    "id": "GUID",
    "code": "string",
    "displayName": "string",
    "defaultProfileID": "string",
    "assignToAllNewUsers": "boolean"
}

GET userGroup
DELETE userGroup
POST userGroup
PATCH userGroup