(automation API) Get userPermission

Retrieves the properties and relationships of an user permission object for Dynamics 365 Business Central.

HTTP request

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

/microsoft/automation/v2.0/companies({companyId})/users({userSecurityId})/userPermissions({userPermissionId})

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 userPermission 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})/users({userSecurityId})/userPermissions({userPermissionId})

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",
    "userSecurityId": "a0ad6d24-99b7-440e-a26d-9a86840c2056",
    "roleId": "SUPER",
    "company": "",
    "scope": "System",
    "appId": "00001111-aaaa-2222-bbbb-3333cccc4444",
    "displayName": "This role has all permissions.",
    "extensionName": ""

}

Tips for working with the APIs
userPermission