user resource type

Represents an user in Dynamics 365 Business Central.

Note

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

Methods

MethodReturn TypeDescription
GET useruserGets a user object.
PATCH useruserUpdates a user object.

Bound Actions

The user resource type offers a bound action called getNewUsersFromOffice365Async which get new users from office 365 asyncs the corresponding user batch. This is illustrated in the following example: POST https://<server address>:<server API port>/<server instance name>/api/v2.0/companies({id})/users({id})/Microsoft.NAV.getNewUsersFromOffice365Async

The response has no content; the response code is 204.

The user resource type offers a bound action called getNewUsersFromOffice365 which get new users from office 365s the corresponding user batch. This is illustrated in the following example: POST https://<server address>:<server API port>/<server instance name>/api/v2.0/companies({id})/users({id})/Microsoft.NAV.getNewUsersFromOffice365

The response has no content; the response code is 204.

NavigationReturn TypeDescription
securityGroupMemberssecurityGroupMembersGets the securitygroupmembers of the user.
userPermissionsuserPermissionsGets the userpermissions of the user.
scheduledJobsscheduledJobsGets the scheduledjobs of the user.

Properties

PropertyTypeDescription
userSecurityIdGUIDThe unique ID of the user security.
userNamestringSpecifies the user name.
displayNamestringSpecifies the user's name. This name will appear on all sales documents for the user.
statestringSpecifies the user's state.
expiryDatedatetimeThe date of expiration.
contactEmailstringSpecifies the user's email.

JSON representation

Here is a JSON representation of the user resource.

{
    "userSecurityId": "GUID",
    "userName": "string",
    "displayName": "string",
    "state": "string",
    "expiryDate": "datetime",
    "contactEmail": "string"
}

GET user
PATCH user