Request Elements
auth | See above |
emailAddress | The email address of the user to create |
username | The username of the user to create (leave blank if your org doesn’t use) |
firstName | The first name of the user to create |
lastName | The last name of the user to create |
password | The plaintext password of the user to create (this will be encrypted in the DigitalChalk system and will not be retrievable). |
passwordReset | Possible values are “true” or “false” (without the quotes). Indicate true if the user should reset his or her password when they login to the system |
licenseAgreed | true/false, true if the digitalchalk license is agreed to |
tags | The space separated tags for the user. These can be used to filter who has access to register for an offering. |
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:dcAPI="http://digitalchalk.com/api/v4">
<soap:Body>
<dcAPI:createUserRequest>
<dcAPI:auth>
<dcAPI:accessKey>?</dcAPI:accessKey>
<dcAPI:timestamp>?</dcAPI:timestamp>
<dcAPI:signature>?</dcAPI:signature>
</dcAPI:auth>
<dcAPI:user>
<dcAPI:emailAddress>?</dcAPI:emailAddress>
<dcAPI:username>?</dcAPI:username>
<dcAPI:firstName>?</dcAPI:firstName>
<dcAPI:lastName>?</dcAPI:lastName>
<dcAPI:licenseAgreed>?</dcAPI:licenseAgreed>
<dcAPI:password>?</dcAPI:password>
<dcAPI:passwordReset>?</dcAPI:passwordReset>
<dcAPI:tags/>
</dcAPI:user>
</dcAPI:createUserRequest>
</soap:Body>
</soap:Envelope>
Response Elements
success | “true” if the user was created successfully, “false” if not (although you will receive a soap fault with a more specific message in this case) |
username | The user’s username |
emailAddress | The user’s email address |
name | The user’s full name |
<?xml version="1.0" encoding="UTF-8"?>
<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/">
<SOAP-ENV:Header/>
<SOAP-ENV:Body>
<dcAPI:createUserResponse xmlns:dcAPI="http://digitalchalk.com/api/v4">
<dcAPI:username>?</dcAPI:username>
<dcAPI:emailAddress>?</dcAPI:emailAddress>
<dcAPI:name>?</dcAPI:name>
<dcAPI:success>?</dcAPI:success>
</dcAPI:createUserResponse>
</SOAP-ENV:Body>