The CreateUser method allows you to create users through the API.
public int CreateUser(string tokenIn, string title, string firstName, string lastName, string emailAddress,
string addressLine1, string addressLine2, string town, string zipCode, string stateProvince, string countryISO,
string telephone, string fax, string cellphone, string skype, string alternateEmailAddress, string languageISO,
bool isActive, UserType userType, UserRoles roles, string directoryServiceUserName, string customId,
string password, bool sendEmail, out string tokenOut, out int userId)
Send Params |
Return Params |
|---|---|
•addressLine1 •addressLine2 •alternateEmailAddress •countryISO •cellphone •customId •directoryServiceUserName •emailAddress •fax •firstName •isActive - Indicates if the user is active or not •languageISO •lastName •password •roles - Indicates the user's roles (None = 1, Apps = 2, Reports = 4, Connections = 8, Users = 16, Account = 32, API = 64, Portal = 128) •sendEmail - If true the user will be sent an email with a temporary password. •skype •stateProvince •telephone •title •tokenIn - This is the security token that is obtained by the previous API call. See the API Security topic for more details. •town •userId - The ID of the newly created user. •userType - Indicates the type of user (1 - Basic User, 2 Advanced User) •zipCode |
tokenOut - This is the new security token that should be used for the next Web Service call after this one. See the API Security topic for more details. |
SOAP 1.1
The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.
POST /api/API.asmx HTTP/1.1 Host: app.perfectforms.com Content-Type: text/xml; charset=utf-8 Content-Length: length SOAPAction: "http://www.PerfectApps.com/API/CreateUser"
<?xml version="1.0" encoding="utf-8"?> <soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"> <soap:Body> <CreateUser xmlns="http://www.PerfectApps.com/API"> <tokenIn>string</tokenIn> <title>string</title> <firstName>string</firstName> <lastName>string</lastName> <emailAddress>string</emailAddress> <addressLine1>string</addressLine1> <addressLine2>string</addressLine2> <town>string</town> <zipCode>string</zipCode> <stateProvince>string</stateProvince> <countryISO>string</countryISO> <telephone>string</telephone> <fax>string</fax> <cellphone>string</cellphone> <skype>string</skype> <alternateEmailAddress>string</alternateEmailAddress> <languageISO>string</languageISO> <isActive>boolean</isActive> <userType>Basic or Advanced or Limited</userType> <roles>None or Apps or Reports or Connections or Users or Account or API or Portal</roles> <directoryServiceUserName>string</directoryServiceUserName> <customId>string</customId> <password>string</password> <sendEmail>boolean</sendEmail> <hasOfflineRight>boolean</hasOfflineRight> </CreateUser> </soap:Body> </soap:Envelope> |
HTTP/1.1 200 OK Content-Type: text/xml; charset=utf-8 Content-Length: length
<?xml version="1.0" encoding="utf-8"?> <soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"> <soap:Body> <CreateUserResponse xmlns="http://www.PerfectApps.com/API"> <CreateUserResult>int</CreateUserResult> <tokenOut>string</tokenOut> <userId>int</userId> </CreateUserResponse> </soap:Body> </soap:Envelope> |
SOAP 1.2
The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values.
POST /api/API.asmx HTTP/1.1 Host: app.perfectforms.com Content-Type: application/soap+xml; charset=utf-8 Content-Length: length
<?xml version="1.0" encoding="utf-8"?> <soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope"> <soap12:Body> <CreateUser xmlns="http://www.PerfectApps.com/API"> <tokenIn>string</tokenIn> <title>string</title> <firstName>string</firstName> <lastName>string</lastName> <emailAddress>string</emailAddress> <addressLine1>string</addressLine1> <addressLine2>string</addressLine2> <town>string</town> <zipCode>string</zipCode> <stateProvince>string</stateProvince> <countryISO>string</countryISO> <telephone>string</telephone> <fax>string</fax> <cellphone>string</cellphone> <skype>string</skype> <alternateEmailAddress>string</alternateEmailAddress> <languageISO>string</languageISO> <isActive>boolean</isActive> <userType>Basic or Advanced or Limited</userType> <roles>None or Apps or Reports or Connections or Users or Account or API or Portal</roles> <directoryServiceUserName>string</directoryServiceUserName> <customId>string</customId> <password>string</password> <sendEmail>boolean</sendEmail> <hasOfflineRight>boolean</hasOfflineRight> </CreateUser> </soap12:Body> </soap12:Envelope> |
HTTP/1.1 200 OK Content-Type: application/soap+xml; charset=utf-8 Content-Length: length
<?xml version="1.0" encoding="utf-8"?> <soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope"> <soap12:Body> <CreateUserResponse xmlns="http://www.PerfectApps.com/API"> <CreateUserResult>int</CreateUserResult> <tokenOut>string</tokenOut> <userId>int</userId> </CreateUserResponse> </soap12:Body> </soap12:Envelope> |
Return to: Account API Methods (SOAP), Integration
