PUT api/Administrators

Updates administrator properties to new values.

Request Information

URI Parameters

None.

Body Parameters

User Edit properties structure

Name	Description	Type	Additional information
AdminID	Administrator unique identification	globally unique identifier	Required
Password	Initial password	string	None.
FirstName	First name	string	None.
LastName	Last name	string	None.
Enabled	Enabled or disabled administrator	boolean	Required
PermissionsModels	Administrator permissions	PermissionsModels	Required
Companies	Administrator companies	Collection of string	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.
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.

Request Formats

application/json, text/json

Sample:

{
  "AdminID": "60f7fba8-8b4b-491f-b457-3eca548b52f0",
  "Password": "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
  },
  "Companies": [
    "sample string 1",
    "sample string 2"
  ],
  "AccountType": 0,
  "AccessToCompaniesMode": 0
}

application/xml, text/xml

Sample:

<AdministratorsEditModels xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/MBSAPImvc.Engine.Models">
  <AccessToCompaniesMode>SpecifiedCompanies</AccessToCompaniesMode>
  <AccountType>Undefined</AccountType>
  <AdminID>60f7fba8-8b4b-491f-b457-3eca548b52f0</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>
  <Enabled>true</Enabled>
  <FirstName>sample string 3</FirstName>
  <LastName>sample string 4</LastName>
  <Password>sample string 2</Password>
  <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>
</AdministratorsEditModels>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

IHttpActionResult

None.

Response Formats

application/json, text/json, application/xml, text/xml

Sample:

Sample not available.