createUser

Last modified on September 11, 2023 at 5:40 pm

Request Elements

authSee above
emailAddressThe email address of the user to create
usernameThe username of the user to create (leave blank if your org doesn’t use)
firstNameThe first name of the user to create
lastNameThe last name of the user to create
passwordThe plaintext password of the user to create (this will be encrypted in the DigitalChalk system and will not be retrievable).
passwordResetPossible 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
licenseAgreedtrue/false, true if the digitalchalk license is agreed to
tagsThe 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)
usernameThe user’s username
emailAddressThe user’s email address
nameThe 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>