dynamics_usergrouppermission_get.md

title	description	author	ms.topic	ms.devlang	ms.date	ms.author	ms.reviewer
(automation API) Get userGroupPermission	Gets a user group permission object in Dynamics 365 Business Central.	SusanneWindfeldPedersen	reference	al	05/31/2024	solsen	solsen

(automation API) Get userGroupPermission

Retrieves the properties and relationships of a user group permission object for [!INCLUDEd365fin_long_md].

HTTP request

Replace the URL prefix for [!INCLUDE prod_short] depending on environment following the guideline.

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

Request headers

Header	Value
Authorization	Bearer {token}. Required.

Request body

Do not supply a request body for this method.

Response

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

Example

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})/userGroupPermission({userGroupPermissionId})

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": "00000000-0000-0000-0000-000000000000",
    "scope": "System",
    "extensionName": ""
}

See Also

Tips for working with the APIs
userGroupPermission