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
| Method | Return Type | Description |
|---|---|---|
| GET user | user | Gets a user object. |
| PATCH user | user | Updates 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.
Navigation
| Navigation | Return Type | Description |
|---|---|---|
| securityGroupMembers | securityGroupMembers | Gets the securitygroupmembers of the user. |
| userPermissions | userPermissions | Gets the userpermissions of the user. |
| scheduledJobs | scheduledJobs | Gets the scheduledjobs of the user. |
Properties
| Property | Type | Description |
|---|---|---|
| userSecurityId | GUID | The unique ID of the user security. |
| userName | string | Specifies the user name. |
| displayName | string | Specifies the user's name. This name will appear on all sales documents for the user. |
| state | string | Specifies the user's state. |
| expiryDate | datetime | The date of expiration. |
| contactEmail | string | Specifies 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"
}