PUT API/Administrators

Updates administrator properties to new values.

Request Information

URI Parameters

None.

Body Parameters

User Edit properties structure

AdministratorsEditModels

Name Description Type Additional Information
AdminID Administrator Unique Identifier Globally Unique Identifier Required
Password Initial Password string None
FirstName - string None
LastName - string None
Enabled Administrator status (enabled or disabled) boolean Required
PermissionsModels Administrator Permission List PermissionsModels Required
Companies Companies Assigned to Administrator Collection of string None

Request Formats

application/json, text/json

{
  "AdminID": "9f007f6f-85eb-4ed3-b4f9-533af3fe7a91",
  "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
  },
  "Companies": [
    "sample string 1",
    "sample string 2"
  ]
}

application/xml, text/xml

<AdministratorsEditModels xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/MBSAPImvc.Engine.Models">
  <AdminID>9f007f6f-85eb-4ed3-b4f9-533af3fe7a91</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>
    <Billing>None</Billing>
    <CapacityReport>None</CapacityReport>
    <Dashboard>None</Dashboard>
    <GoogleApps>None</GoogleApps>
    <HelpMarketing>None</HelpMarketing>
    <LicenseActivate>None</LicenseActivate>
    <LicenseBuy>None</LicenseBuy>
    <Licenses>None</Licenses>
    <Monitiring>None</Monitiring>
    <Notification>None</Notification>
    <OnlineAccess>None</OnlineAccess>
    <PSA>None</PSA>
    <Rebranding>None</Rebranding>
    <RemoteDeploy>None</RemoteDeploy>
    <RemoteManagment>None</RemoteManagment>
    <Storage>None</Storage>
    <StorageLimit>None</StorageLimit>
    <StorageUsage>None</StorageUsage>
    <Users>None</Users>
  </PermissionsModels>
</AdministratorsEditModels>

Response Information

Resource Description

IHttpActionResult None.

Response Formats

  • application/json
  • text/json
  • application/xml
  • text/xml.
https://git.cloudberrylab.com/egor.m/doc-help-mbs.git