POST /service/api/securecloud/customers/{customerId}/users

Creates a new user for an end customer.

The API returns two distinct status codes based on the outcome of the user creation request:
200 OK: This status code indicates that the user was created successfully, but with a difference in the service configuration compared to the request.
201 Created: This status code is returned when the user was created successfully exactly as requested, without any modifications to the service configuration.
These status codes enable the caller to differentiate between user creation with or without configuration changes.

Note: Before calling the Create User API method, callers typically fetch the list of available domains and services from the User Services API method first. This response provides the available services that can be assigned. Once the domains and services are retrieved, the creation of a user can then proceed by assigning appropriate services and domain.

Request Information

URI Parameters

NameDescriptionTypeAdditional Information
customerId

A unique id by which an end customer is identified.

 string

Required

URI Sample(s)
POST
https://unityapi.webrootcloudav.com/service/api/securecloud/customers/1e0a7a3c-92b7-480d-a48f-a38600f660bf/users

Body Parameters

Information about the user to be created for the customer.

CreateCustomerUserRequestModel
NameDescriptionTypeAdditional Information
FirstName

First name of the user.

 string

Required
LastName

Last name of the user.

 string

Required
PhoneNumber

Phone number of the user.

 string

None.
EmailAddress

Email address of the user.

 string

Required
Roles

Roles assignable to the user. User roles are listed in order of privilege, from highest to lowest.
Valid Roles for a Partner Customer:

  • Partner_Administrator
  • Partner_Sales
  • Partner_Support
  • Customer_Administrator
  • Billing
Valid Role for a Resold Customer:
  • Customer_Administrator
Default Access:
If no role is specified, the user is granted access only to their own services, without any administrative privileges.

 Collection of string

None.
UserServices

Services information for the user.

 Collection of UserService

None.
SendWelcomeEmail

Indicates whether a welcome email should be sent to the user.

 boolean

None.

Sample Request

{
  "FirstName": "Richard",
  "LastName": "Illingworth",
  "PhoneNumber": "1234567890",
  "EmailAddress": "richardillingworth@spkuk.co.in",
  "Roles": [
    "Partner_Administrator",
    "Billing"
  ],
  "UserServices": [
    {
      "ServiceName": "Email Threat Protection",
      "ServiceConfiguration": [
        {
          "Name": "SendQuarantinedMessageReports",
          "Value": [
            "false"
          ]
        },
        {
          "Name": "SendQuarantinedMessageReportsWhenEmpty",
          "Value": [
            "true"
          ]
        }
      ]
    },
    {
      "ServiceName": "Exchange",
      "ServiceConfiguration": [
        {
          "Name": "MailboxType",
          "Value": [
            "Full"
          ]
        },
        {
          "Name": "MailboxLocation",
          "Value": [
            "USA"
          ]
        }
      ]
    }
  ],
  "SendWelcomeEmail": true
}                    
<CreateCustomerUserRequestModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Webroot.UnityAPI.ServiceExtension.SecureCloud.Models">
  <EmailAddress>richardillingworth@spkuk.co.in</EmailAddress>
  <FirstName>Richard</FirstName>
  <LastName>Illingworth</LastName>
  <PhoneNumber>1234567890</PhoneNumber>
  <Roles xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>Partner_Administrator</d2p1:string>
    <d2p1:string>Billing</d2p1:string>
  </Roles>
  <SendWelcomeEmail>true</SendWelcomeEmail>
  <UserServices>
    <UserService>
      <ServiceName>Email Threat Protection</ServiceName>
      <ServiceConfiguration>
        <UserServiceServiceConfiguration>
          <Name>SendQuarantinedMessageReports</Name>
          <Value xmlns:d6p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
            <d6p1:string>false</d6p1:string>
          </Value>
        </UserServiceServiceConfiguration>
        <UserServiceServiceConfiguration>
          <Name>SendQuarantinedMessageReportsWhenEmpty</Name>
          <Value xmlns:d6p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
            <d6p1:string>true</d6p1:string>
          </Value>
        </UserServiceServiceConfiguration>
      </ServiceConfiguration>
    </UserService>
    <UserService>
      <ServiceName>Exchange</ServiceName>
      <ServiceConfiguration>
        <UserServiceServiceConfiguration>
          <Name>MailboxType</Name>
          <Value xmlns:d6p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
            <d6p1:string>Full</d6p1:string>
          </Value>
        </UserServiceServiceConfiguration>
        <UserServiceServiceConfiguration>
          <Name>MailboxLocation</Name>
          <Value xmlns:d6p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
            <d6p1:string>USA</d6p1:string>
          </Value>
        </UserServiceServiceConfiguration>
      </ServiceConfiguration>
    </UserService>
  </UserServices>
</CreateCustomerUserRequestModel>

Response Information

Resource Description

Information about the user that was created.

CreateCustomerUserResponseModel
NameDescriptionTypeAdditional Information
UserId

Unique identifier for a new user generated in OpenText Secure Cloud platform.

 string

None.
Message

Additional information received during user creation.

 string

This field is applicable only when the http status code is 200.
UserConfigurations

Services information for a user.

 Collection of UserService

This field is applicable only when the http status code is 200.

Sample Response

{
  "UserId": "56ec486b-aa86-4dce-9c39-6f6ada69113c",
  "Message": "Sample message",
  "UserConfigurations": [
    {
      "ServiceName": "Email Threat Protection",
      "ServiceConfiguration": [
        {
          "Name": "SendQuarantinedMessageReports",
          "Value": [
            "true"
          ]
        }
      ]
    }
  ]
}                    
<CreateCustomerUserResponseModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Webroot.UnityAPI.ServiceExtension.SecureCloud.Models">
  <Message>Sample message</Message>
  <UserConfigurations>
    <UserService>
      <ServiceName>Email Threat Protection</ServiceName>
      <ServiceConfiguration>
        <UserServiceServiceConfiguration>
          <Name>SendQuarantinedMessageReports</Name>
          <Value xmlns:d6p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
            <d6p1:string>true</d6p1:string>
          </Value>
        </UserServiceServiceConfiguration>
      </ServiceConfiguration>
    </UserService>
  </UserConfigurations>
  <UserId>56ec486b-aa86-4dce-9c39-6f6ada69113c</UserId>
</CreateCustomerUserResponseModel>