GET api/Administrators/{id}
Get administrator by administrator ID
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
id |
Administrators unique identifier |
string |
Required |
Body Parameters
None.
Response Information
Resource Description
Returns users properties
AdministratorsModelsName | Description | Type | Additional information |
---|---|---|---|
AdminID |
Administrator unique identification |
globally unique identifier |
None. |
Administrator email |
string |
None. |
|
FirstName |
First name |
string |
None. |
LastName |
Last name |
string |
None. |
Enabled |
Enabled or disabled administrator |
boolean |
None. |
PermissionsModels |
Administrator permissions |
PermissionsModels |
None. |
LastLogin |
Last login date |
date |
None. |
DateCreated |
Date created |
date |
None. |
Companies |
Administrator companies |
Collection of string |
None. |
AccessToCompaniesMode |
Access To Companies Note: The default is "SpecifiedCompanies". If set to "SpecifiedCompanies" then the list of Companies can be empty for backward compatibility. If set to "AllCompanies" then the list of Companies must be empty. |
AccessToCompaniesEnum |
None. |
AccountType |
This value is intended for future RBAC. If set to "Internal" then access to an employee inside company is provided. If set to "External" then access to any third party, such as a customer, is provided. This field can be empty for backward compatibility. |
AdministratorAccountType |
None. |
Response Formats
application/json, text/json
{ "AdminID": "c796c84b-dc9a-4b9e-af34-f6749dcd54a1", "Email": "sample string 2", "FirstName": "sample string 3", "LastName": "sample string 4", "Enabled": true, "PermissionsModels": { "Users": 0, "StorageLimit": 0, "Notification": 0, "OnlineAccess": 0, "Licenses": 0, "Billing": 0, "Monitiring": 0, "RemoteDeploy": 0, "RemoteManagment": 0, "HelpMarketing": 0, "AuditLog": 0, "PSA": 0, "Administrators": 0, "Rebranding": 0, "Storage": 0, "ADS": 0, "LicenseBuy": 0, "LicenseActivate": 0, "StorageUsage": 0, "CapacityReport": 0, "GoogleApps": 0, "Dashboard": 0, "Downloads": 0, "CloudRestore": 0, "EC2Snapshots": 0, "LicenseUsageHistory": 0, "BackupHistory": 0, "PurchaseHistory": 0, "UsersCreateEdit": 0, "UsersDelete": 0, "ManageCompanies": 0, "ManageImmutability": 0, "ManageTags": 0 }, "LastLogin": "2024-11-21T07:38:07.2196821Z", "DateCreated": "2024-11-21T07:38:07.2196821Z", "Companies": [ "sample string 1", "sample string 2" ], "AccessToCompaniesMode": 0, "AccountType": 0 }
application/xml, text/xml
<AdministratorsModels xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/MBSAPImvc.Engine.Models"> <AccessToCompaniesMode>SpecifiedCompanies</AccessToCompaniesMode> <AdminID>c796c84b-dc9a-4b9e-af34-f6749dcd54a1</AdminID> <Companies xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d2p1:string>sample string 1</d2p1:string> <d2p1:string>sample string 2</d2p1:string> </Companies> <DateCreated>2024-11-21T07:38:07.2196821Z</DateCreated> <Email>sample string 2</Email> <Enabled>true</Enabled> <FirstName>sample string 3</FirstName> <LastLogin>2024-11-21T07:38:07.2196821Z</LastLogin> <LastName>sample string 4</LastName> <PermissionsModels> <ADS>None</ADS> <Administrators>None</Administrators> <AuditLog>None</AuditLog> <BackupHistory>None</BackupHistory> <Billing>None</Billing> <CapacityReport>None</CapacityReport> <CloudRestore>None</CloudRestore> <Dashboard>None</Dashboard> <Downloads>None</Downloads> <EC2Snapshots>None</EC2Snapshots> <GoogleApps>None</GoogleApps> <HelpMarketing>None</HelpMarketing> <LicenseActivate>None</LicenseActivate> <LicenseBuy>None</LicenseBuy> <LicenseUsageHistory>None</LicenseUsageHistory> <Licenses>None</Licenses> <ManageCompanies>None</ManageCompanies> <ManageImmutability>None</ManageImmutability> <ManageTags>None</ManageTags> <Monitiring>None</Monitiring> <Notification>None</Notification> <OnlineAccess>None</OnlineAccess> <PSA>None</PSA> <PurchaseHistory>None</PurchaseHistory> <Rebranding>None</Rebranding> <RemoteDeploy>None</RemoteDeploy> <RemoteManagment>None</RemoteManagment> <Storage>None</Storage> <StorageLimit>None</StorageLimit> <StorageUsage>None</StorageUsage> <Users>None</Users> <UsersCreateEdit>None</UsersCreateEdit> <UsersDelete>None</UsersDelete> </PermissionsModels> </AdministratorsModels>