<< Click to Display Table of Contents >> Navigation:  Low-code Process Automation > Studio Cloud - Authoring environment > Bizagi Studio > Bizagi from external applications > Bizagi API > Alternative SOAP services > Available SOAP web services > EntityManagerSOA Web methods > Create User

Overview

This Web method is used to create users in Bizagi (from an external application).

This method receives a single input having the values to insert for the user attributes.

 

•For the CreateUser method, the request and response XML's are of the native .NET XmlDocument type.

•For the CreateUserAsString method the same XML structure is handled, but this parameter is sent as a string type.

 

Input

 

Input Schema

The following shows a sample XML structure of information to send to Bizagi:

 

<?xml version="1.0"?>

<xs:schema attributeFormDefault="unqualified" elementFormDefault="qualified" xmlns:xs="http://www.w3.org/2001/XMLSchema">

 <xs:element name="BizAgiWSParam">

         <xs:complexType>

                 <xs:sequence>

                         <xs:element name="Entities" maxOccurs="1">

         <xs:element name="WFUSER" minOccurs="1" maxOccurs="unbounded">

           <xs:element name="BasicInformation" minOccurs="0" maxOccurs="1">

             <xs:complexType/>

           </xs:element>  

           <xs:element name="UserConfiguration" minOccurs="0" maxOccurs="1">

             <xs:complexType/>

           </xs:element>

         </xs:element>

                         </xs:element>

                 </xs:sequence>

         </xs:complexType>

 </xs:element>

</xs:schema>

 

Input Parameters

•BizAgiWSParam: Is the root node of the XML.

•Entities: Is the root sub-node of the XML.

•WFUSER: Is the root node of the user to be created

•BasicInformation: Contains the basic information of the user to be created, the requires nodes are UserName, FullName, Domain, Organization and ContactEmail.

•UserConfiguration: Contains the configuration information (such as Roles, Area, Location, IdDelegate) of the user to be created,

 

Input Example

In the following sample XML, two users will be created:

 

 

CreateUser Method Input

<BizAgiWSParam>

<Entities>

<WFUSER>

 <BasicInformation>

   <FullName>Juliette Leroy</FullName>

   <UserName>juliettel</UserName>

   <Domain>agilityCorp</Domain>

   <ContactEmail>juliettel@agilityCorp.com</ContactEmail>

   <Organizations>

     <Organization>1</Organization>

   </Organizations>

 </BasicInformation>

 <UserConfiguration></UserConfiguration>

</WFUSER>

<WFUSER>

 <BasicInformation>

   <FullName>Kirby Lovett</FullName>

   <UserName>klovett</UserName>

   <Domain>agilityCorp</Domain>

   <ContactEmail>klovett@agilityCorp.com</ContactEmail>

   <Password>Bizagi123</Password>

   <Picture>/9j/4AAQSkZJRgABAQEAYABgAAD/4QHGRXhpZgAATU0AKgAAA..</Picture>

   <Organizations>

     <Organization>1</Organization>

   </Organizations>

 </BasicInformation>

 <UserConfiguration>  

   <Roles>

     <idRole key="1"></idRole>

     <idRole key="9998"></idRole>

   </Roles>

   <idArea key="1"></idArea>

   <idLocation key="1"></idLocation>

   <Positions>

     <Position>1</Position>

   </Positions>

   <Enabled>1</Enabled>

   <EnabledForAssignation>0</EnabledForAssignation>

 </UserConfiguration>

</WFUSER>

</Entities>

</BizAgiWSParam>

 

CreateUserAsString Method Input

 

<entityInfo>

  <![CDATA[<BizAgiWSParam>

  <Entities>

  <WFUSER>

  <BasicInformation>

  <FullName>Juliette Leroy</FullName>

  <UserName>juliettel</UserName>

  <Domain>agilityCorp</Domain>

  <ContactEmail>juliettel@agilityCorp.com</ContactEmail>

  <Organizations>

  <Organization>1</Organization>

  </Organizations>

  </BasicInformation>

  <UserConfiguration></UserConfiguration>

  </WFUSER>

  <WFUSER>

  <BasicInformation>

  <FullName>Kirby Lovett</FullName>

  <UserName>klovett</UserName>

  <Domain>agilityCorp</Domain>

  <ContactEmail>klovett@agilityCorp.com</ContactEmail>

  <Password>Bizagi123</Password>

  <Picture>/9j/4AAQSkZJRgABAQEAYABgAAD/4QHGRXhpZgAATU0AKgAAA..</Picture>

  <Organizations>

  <Organization>1</Organization>

  </Organizations>

  </BasicInformation>

  <UserConfiguration>  

  <Roles>

  <idRole key="1"></idRole>

  <idRole key="9998"></idRole>

  </Roles>

  <idArea key="1"></idArea>

  <idLocation key="1"></idLocation>

  <Positions>

  <Position>1</Position>

  </Positions>

  <Enabled>1</Enabled>

  <EnabledForAssignation>0</EnabledForAssignation>

  </UserConfiguration>

  </WFUSER>

  </Entities>

  </BizAgiWSParam>]]>

</entityInfo>

 

Output

 

Output Schema and Parameters

The following shows a sample XML structure of information returned by Bizagi:

 

<?xml version="1.0"?>

<xs:schema attributeFormDefault="unqualified" elementFormDefault="qualified" xmlns:xs="http://www.w3.org/2001/XMLSchema">

 <xs:element name="Entities">

   <xs:complexType/>

 </xs:element>

</xs:schema>

 

Its inner elements (Entities structure) will correspond to the identifiers of the users created.

 

Output Example

In the following samples XMLs, we illustrate the returned structured response from Bizagi SOA layer.

 

CreateUser Method Output

 

CreateUserAsString Method Output

 

Related Web methods

To update information of a user, it is recommended to use method saveEntityAsString, this is so because this method is able to update information of WFUSER entity.

For further information about this method, refer to the saveEntity Web service.

Last Updated 1/6/2022 5:12:36 PM