POST api/Administrators

Create administrator

Request Information

URI Parameters

None.

Body Parameters

Name	Description	Type	Additional information
Email	Administrator email	string	Required
InitialPassword	Initial password	string	Required
SendInstruction	Send email with instruction to administrator	boolean	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.
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.

Request Formats

application/json, text/json

Sample:

{
  "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": 0,
    "LicenseUsageHistory": 0,
    "BackupHistory": 0,
    "PurchaseHistory": 0,
    "UsersCreateEdit": 0,
    "UsersDelete": 0,
    "ManageCompanies": 0,
    "ManageImmutability": 0
  },
  "Companies": [
    "sample string 1",
    "sample string 2"
  ],
  "AccessToCompaniesMode": 0
}

application/xml, text/xml

Sample:

<AdministratorsNewModels xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/MBSAPImvc.Engine.Models">
  <AccessToCompaniesMode>SpecifiedCompanies</AccessToCompaniesMode>
  <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>
    <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>
  <SendInstruction>true</SendInstruction>
</AdministratorsNewModels>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

ID of new administrator or error

string

Response Formats

application/json, text/json

Sample:

"sample string"

application/xml, text/xml

Sample:

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