API Guide

/api/AccountService/Accounts
This URI represents the collection of accounts.
GET method for Accounts
This method returns a collection of accounts.
Description Returns the collection of accounts.
Privilege VIEW
HTTP response
codes
200
Example response
body
{
"@odata.context": "$metadata#Collection(AccountService.Account)",
"@odata.count": 1,
"value": [
{
"@odata.id": "/api/AccountService/Accounts('1814')",
"Id": "1814",
"UserTypeId": 1,
"DirectoryServiceId": 0,
"Description": "root",
"Name": "root",
"Password": null,
"UserName": "root",
"RoleId": "10",
"Locked": false,
"IsBuiltin": true,
"Enabled": true,
"Permissions": [
{
"@odata.id": "/api/AccountService/Accounts('1814')/Permissions"
}
]
}
]
}
Table 16. Attributes
Attribute Description
Id Uniquely identifies the resource within the collection.
UserTypeId Type of user.
DirectoryServiceId Directory service ID.
Description Description for the user.
Name Name of the user. This name is the same as user name.
Password Password for the user. When retrieving the details, Password is
displayed as blank.
UserName User name of the account.
RoleId Role for the account.
Locked Indicates if the account is locked or unlocked.
IsBuiltin Indicates if the account is an in-built account.
Enabled Indicates if the account enabled or disabled.
Permissions Permissions for this account.
Application settings 37