GET api/Administrators
Get Administrators List
Request Information
URI Parameters
None.
Body Parameters
None.
Response Information
Resource Description
Returns administrator properties
Collection of 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 "SpecifiedCompanies" then the list of Companies can be emty for backward compatibility. If set "AllCompanies" then the list of Companies must be empty. |
AccessToCompaniesEnum |
None. |
Response Formats
application/json, text/json
Sample:
[ { "AdminID": "02d98222-e6b3-4361-8258-8a9fabd2cd05", "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 }, "LastLogin": "2022-05-19T02:41:36.4209001+00:00", "DateCreated": "2022-05-19T02:41:36.4209001+00:00", "Companies": [ "sample string 1", "sample string 2" ], "AccessToCompaniesMode": 0 }, { "AdminID": "02d98222-e6b3-4361-8258-8a9fabd2cd05", "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 }, "LastLogin": "2022-05-19T02:41:36.4209001+00:00", "DateCreated": "2022-05-19T02:41:36.4209001+00:00", "Companies": [ "sample string 1", "sample string 2" ], "AccessToCompaniesMode": 0 } ]
application/xml, text/xml
Sample:
<ArrayOfAdministratorsModels xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/MBSAPImvc.Engine.Models"> <AdministratorsModels> <AccessToCompaniesMode>SpecifiedCompanies</AccessToCompaniesMode> <AdminID>02d98222-e6b3-4361-8258-8a9fabd2cd05</AdminID> <Companies xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d3p1:string>sample string 1</d3p1:string> <d3p1:string>sample string 2</d3p1:string> </Companies> <DateCreated>2022-05-19T02:41:36.4209001+00:00</DateCreated> <Email>sample string 2</Email> <Enabled>true</Enabled> <FirstName>sample string 3</FirstName> <LastLogin>2022-05-19T02:41:36.4209001+00:00</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> <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> <AdministratorsModels> <AccessToCompaniesMode>SpecifiedCompanies</AccessToCompaniesMode> <AdminID>02d98222-e6b3-4361-8258-8a9fabd2cd05</AdminID> <Companies xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d3p1:string>sample string 1</d3p1:string> <d3p1:string>sample string 2</d3p1:string> </Companies> <DateCreated>2022-05-19T02:41:36.4209001+00:00</DateCreated> <Email>sample string 2</Email> <Enabled>true</Enabled> <FirstName>sample string 3</FirstName> <LastLogin>2022-05-19T02:41:36.4209001+00:00</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> <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> </ArrayOfAdministratorsModels>