Products: Managed Backup (Agent)
Article ID: m0663Last Modified: 29-Sep-2024

POST API/Administrators

Creates new administrator.

Request Information

URI Parameters

None.

Body Parameters

AdministratorsNewModels

Name Description Type Additional Information
Email Administrator Email Address string Required
InitialPassword Initial Password string Required
SendInstruction Sends Email with Instructions to Administrator boolean 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

{
  "Email": "sample string 1",
  "InitialPassword": "sample string 2",
  "SendInstruction": true,
  "FirstName": "sample string 4",
  "LastName": "sample string 5",
  "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": ,
    "LicenseUsageHistory": 0,
    "BackupHistory": 0,
    "PurchaseHistory": 0,
    "UsersCreateEdit": 0,
    "UsersDelete": 0,
    "ManageCompanies": 0
  },
  "AccessToCompaniesMode": 0
  ]
}

application/xml, text/xml

<AdministratorsNewModels xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/MBSAPImvc.Engine.Models">
  <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>
  <Email>sample string 1</Email>
  <Enabled>true</Enabled>
  <FirstName>sample string 4</FirstName>
  <InitialPassword>sample string 2</InitialPassword>
  <LastName>sample string 5</LastName>
  <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>
  <SendInstruction>true</SendInstruction>
</AdministratorsNewModels>

Response Information

Resource Description

New administrator ID or error. Type: string.

Response Formats

application/json, text/json

"sample string"

application/xml, text/xml

<string xmlns="http://schemas.microsoft.com/2003/10/Serialization/">sample string</string>

https://git.cloudberrylab.com/egor.m/doc-help-mbs.git