Edit a user
Resource URL
URL: user/edit
Parameters
Not passing a parameter will leave corresponding user attribute unchanged. Passing empty parameter will reset corresponding user property value. Not all user properties can be reset. Those that can be reset are marked as resetable.
string username | Username | ||
string password | Password | ||
string userId | Trainingportal internal ID of the user to be edited | ||
| string userExternalId optional | External ID of the user. Either userId or userExternalId must be filled | ||
| string newExternalId optional, resetable | New external ID for the user. | ||
| string firstName optional | First name | ||
| string lastName optional | Last name | ||
string eMailAddress | E-mail address | ||
| string birthDate optional, resetable | Birth date of the user, on format YYYY-MM-DD | ||
| string phoneCountryCode optional, resetable | Country code for the user's phone number. may be prefixed with "+". Example: "+47" or "47" | ||
| string phoneNumber optional, resetable | Phone number for the user, without country code | ||
| enum preferredLanguage optional, resetable | ISO 639-1 (two letter abbreviation) for the user's preferred language. Currently supported languages are:
| ||
| string addressLine1 optional, resetable | Address, line 1 | ||
| string addressLine2 optional, resetable | Address, line 2 | ||
| string zipCode optional,resetable | Address, zip Code | ||
| string city optional, resetable | Address, city | ||
| string country optional, resetable | Address, country | ||
| string gender optional, resetable | 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.
Note: Existing portal specific attributes that is not present in the parameter will not be deleted. | ||
| string userUsername optional | Username for the user. | ||
| string userPassword optional | Password for the user. |
Return value
The method returns information about the edited user
userId | Internal Trainingportal id of the user |
| userExternalId | External ID of the user |
| userUsername | Username 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"
}
