User Creation

The CreateUser call is used to automatically create a new user(s) with specified roles and properties. The current Data Load Rules option allows Native type users to be created only (no single sign on users). The Dimension Security API allows you to create both Native and SSO user types.

A customer supplies a data load file with user information for users to be created in Planful. A Boomi process (or any other Soap API) consumes the API to perform the required user creation and update tasks. If the user is already present in the tenant group, but mapped to another tenant, the API will map the user to that tenant. When a user is added to a tenant, the API will not update the first name, last name, and roles/properties for the user if the information differs from current user details.

Format of API String

Bool CreateUser(string firstName, string lastName, string userLogin, string navigationRole, string reportingRole, string supportRole, string authenticationType, bool isActive, string loginName, string password, string tenantCode)

Data that needs to be supplied to the API:

• FirstName – In string format
• LastName – In string format
• UserLogin – A valid email ID (the API will check to see if the user is already mapped in the application)
• NavigationRole - Existing navigation role
• ReportingRole - Existing reporting role
• SupportRole - Existing support role type (the API validates if the number of administrators are within the allowed limit)
• IsBMEUser - In Boolean format (provide true for granting BME access to the User support role; otherwise false)
  
  Note: 

  For the support roles of Administrator and Budget Manager, the user gets access according to the specified role, regardless of the Boolean value.
  

  • An Administrator gets access to both the Full Experience and the Budget Manager Experience
  • A Budget Manager gets access only to the Budget Manager Experience
• authenticationType – In string format
• status – In Boolean format (“false” for Inactive, “true” for Active)
• DynamicPlanningUser - If the user is a Dynamic planning user (Yes or No)
• DynamicPlanningRole - If the user is a Dynamic Planning user, then this field must have an appropriate Dynamic Planning Role type
• LoginName, Password, and TenantCode – the credentials of the user are used to authenticate the API connection

Following is sample request and response code of a successful API call.

Sample Request

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns="http://www.HostAnalytics.com/API/SOAP/StateFree/Common/2009/03/19">
  <soapenv:Header/>
  <soapenv:Body>
     <ns:CreateNewUser>
        <!--Optional:-->
        <ns:FirstName>NewUser</ns:FirstName>
        <!--Optional:-->
        <ns:LastName>NewUser</ns:LastName>
        <!--Optional:-->
        <ns:UserLogin>benbradley@planful.com</ns:UserLogin>
        <!--Optional:-->
        <ns:NavigationRole>Super Admin</ns:NavigationRole>
        <!--Optional:-->
        <ns:ReportingRole>Regular User</ns:ReportingRole>
        <!--Optional:-->
        <ns:SupportRole>User</ns:SupportRole>
        <ns:IsBMEUser>true</ns:IsBMEUser>
        <!--Optional:-->
        <ns:authenticationType>native</ns:authenticationType>
        <ns:status>true</ns:status>
        <!--Optional:-->
        <ns:DynamicPlanningUser>?</ns:DynamicPlanningUser>
        <!--Optional:-->
        <ns:DynamicPlanningRole>?</ns:DynamicPlanningRole>
        <!--Optional:-->
        <ns:LoginName>benparker@planful.com</ns:LoginName>
        <!--Optional:-->
        <ns:Password>password</ns:Password>
        <!--Optional:-->
        <ns:TenantCode>BVTTenant</ns:TenantCode>
     </ns:CreateNewUser>
  </soapenv:Body>
</soapenv:Envelope>

Sample Response

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns="http://www.HostAnalytics.com/API/SOAP/StateFree/Common/2009/03/19">
   <soapenv:Header/>
   <soapenv:Body>
      <ns:UpdateUserInformation>
         <!--Optional:-->
         <ns:UserLogin>testingbme914@false.com</ns:UserLogin>
         <!--Optional:-->
         <ns:UserPropertyName>IsBMEUser</ns:UserPropertyName>
         <!--Optional:-->
         <ns:Value>False</ns:Value>
         <!--Optional:-->
         <ns:LoginName>benparker@planful.com</ns:LoginName>
         <!--Optional:-->
         <ns:Password>password</ns:Password>
         <!--Optional:-->
         <ns:TenantCode>BVTPlatform</ns:TenantCode>
      </ns:UpdateUserInformation>
   </soapenv:Body>
</soapenv:Envelope> 

Dynamic Planning Users and Roles are supported only in those applications where the Unified User Management is enabled. You can contact Planful Support to enable this feature in your application.

Sample Call

(“Prasanna””Lakshmi”,”klakshmi@planful.com”,”BudgetAdministrator”,”RegularUser”,”SSO”,true,”planfuluser@gmail.com”,”planfulusertest”,”QATenant”)Invalid Input - User already exists in the tenant
<CreateNewUserResult>
<Code>5</Code>
<Success>false</Success>
<message>User already exists in current tenant.</message>
</CreateNewUserResult>
	Valid Input - User created successfully
<CreateNewUserResult>
<Success>true</Success>
<message>User Created Succesfully.</message>
</CreateNewUserResult>

Invalid Cases

• The user’s first name is null or empty
• The user login is not a valid email, the email already exists in the tenant, or the email is present in another tenant group
• The navigation role, reporting role, or support role is invalid
• The authentication type is not Native or SSO. The authentication type must match the tenant authentication type