Create a user
Resource URL
URL: user/create
Parameters
string username | Username | ||
string password | Password | ||
| string userExternalId required | External Id of the new user. External ID must be unique for the portal. | ||
| string firstName required | First name | ||
| string lastName required | Last name | ||
string eMailAddress | E-mail address | ||
| string birthDate optional | Birth date of the user, on format YYYY-MM-DD | ||
| string phoneCountryCode optional | Country code for the user's phone number. may be prefixed with "+". Example: "+47" or "47" | ||
| string phoneNumber optional | Phone number for the user, without country code | ||
| enum prefferedLanguage optional | ISO 639-1 (two letter abbreviation) for the user's preferred language. Currently supported languages are:
| ||
| string addressLine1 optional | Address, line 1 | ||
| string addressLine2 optional | Address, line 2 | ||
| string zipCode optional | Address, zip Code | ||
| string city optional | Address, city | ||
| string country optional | Address, country | ||
| string gender optional | Gender. MALE or FEMALE | ||
| json portalSpecificAttributes optional | json string with portal specific attributes for the user. Each attribute will be a key/value pair with logicalId of the attribute as key.
| ||
| string userUsername optional | Username for the created user. If not present in the request, a unique username will be generated for the user. Note that usernames must be unique across all portals. | ||
| string userPassword optional | Password for the created user. If not present in the request or empty, a password will be generated for the user. | ||
| boolean sendWelcomeMail optional | If true, a welcome mail will be sent to the created user. Default value: false. |
Return value
The method returns information about the created user
userId | Internal Trainingportal id of the user |
| userExternalId | External ID of the user |
| userUsername | Username for the user |
| userPassword | Password for the user |
Example request
URL | |
POST DATA | userExternalId=a001&firstName=John&lastName=Doe&username=username&password=secret |
{
"userId":102356,
"userExternalId":"a001",
"userUserName":"John.Doe"
"userPassword": "123456"
}
