Edit

userGroup resource type

  • Article

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

Method Return Type Description
GET userGroup userGroup Gets a user group object.
DELETE userGroup none Deletes a user group object.
POST userGroup userGroup Creates a user group object.
PATCH userGroup userGroup Updates a user group object.
Navigation Return Type Description
userGroupPermissions userGroupPermissions Gets the permissions of the userGroup.
profile profile Gets the profile of the userGroup.

Properties

Property Type Description
id GUID The unique ID of the user group. Non-editable.
code string The code of the user group.
displayName string Specifies the user group's name. This name will appear on all sales documents for the user group.
defaultProfileID string The ID of the defaultProfile.
assignToAllNewUsers boolean If 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"
}

See Also

GET userGroup
DELETE userGroup
POST userGroup
PATCH userGroup