Products: Managed Backup (Agent)
Article ID: m0621Last Modified: 13-Nov-2024

POST API/Users

Creates new user.

Request Information

URI Parameters

None.

Body Parameters

Name Description Type Additional Information
Email User login(email) string Required
FirstName - string None
LastName - string None
NotificationEmails - Collection of strings None
Company - string None
Enabled - boolean Required
Password User Password string Required string length: inclusive between 6 and 100
DestinationList - Collection of DestinationForNewUser None
SendEmailInstruction Sends email with instructions to user boolean None
LicenseManagmentMode Mode of user license management UserModeType None

Request Formats

application/json, text/json

{
  "Email": "sample string 1",
  "FirstName": "sample string 2",
  "LastName": "sample string 3",
  "NotificationEmails": [
    "sample string 1",
    "sample string 2"
  ],
  "Company": "sample string 4",
  "Enabled": true,
  "Password": "sample string 6",
  "DestinationList": [
    {
      "AccountID": "sample string 1",
      "Destination": "sample string 2",
      "PackageID": 3
    },
    {
      "AccountID": "sample string 1",
      "Destination": "sample string 2",
      "PackageID": 3
    }
  ],
  "SendEmailInstruction": true,
  "LicenseManagmentMode": 0
}

application/xml, text/xml

<UsersAddModels xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/MBSAPImvc.Engine.Models">
  <Company>sample string 4</Company>
  <DestinationList>
    <DestinationForNewUser>
      <AccountID>sample string 1</AccountID>
      <Destination>sample string 2</Destination>
      <PackageID>3</PackageID>
    </DestinationForNewUser>
    <DestinationForNewUser>
      <AccountID>sample string 1</AccountID>
      <Destination>sample string 2</Destination>
      <PackageID>3</PackageID>
    </DestinationForNewUser>
  </DestinationList>
  <Email>sample string 1</Email>
  <Enabled>true</Enabled>
  <FirstName>sample string 2</FirstName>
  <LastName>sample string 3</LastName>
  <LicenseManagmentMode>Manual</LicenseManagmentMode>
  <NotificationEmails xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </NotificationEmails>
  <Password>sample string 6</Password>
  <SendEmailInstruction>true</SendEmailInstruction>
</UsersAddModels>

Response Information

Resource Description

New user 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