API Docs
Update User Details
Contents
This Web service updates a specific user's details.
The update is done in a 'Swap All' mode: existing fields' information will be replaced with the incoming information. Incoming lists will replace existing lists.
Exception for this are the following fields:
roles - if the incoming list does not contain roles, existing roles will be kept.
External users: Preferred first name, Preferred middle name, Preferred last name, User group, Job category, PIN number, User language, Resource sharing libraries, Campus code and User title: these fields will not be replaced if updated manually (or if empty in the incoming user record), unless 'override' parameter is sent with the field's name.
Resource URL
PUT /almaws/v1/users/{user_id}
API Description
URL Parameters
Parameter | Type | Description |
---|---|---|
user_id | xs:string | A unique identifier for the user |
Querystring Parameters
Parameter | Type | Required | Description |
---|---|---|---|
user_id_type | xs:string | Optional. Default: all_unique | The type of identifier that is being searched. Optional. If this is not provided, all unique identifier types are used. The values that can be used are any of the values in the User Identifier Type code table. |
override | xs:string | Optional. | The following fields of the user object are not replaced if they were updated manually: user_group, job_category, pin_number, preferred_language, campus_code, rs_libraries, user_title, library_notices, pref_first_name, pref_middle_name, pref_last_name, cataloger_level. To update these fields, specify the fields you want to replace in this parameter. For example override=user_group,job_category. Default is empty. |
send_pin_number_letter | xs:string | Optional. Default: false | The email notification for PIN setting change will be sent |
recalculate_roles | xs:string | Optional. Default: false | Recalculate the roles based on role assignment rules. |
registration_rules | xs:string | Optional. Default: false | Apply registration rules in the context of the library. True or false. Optional. |
library | xs:string | Optional. | The code of the library. For use with registration rules. Optional. |
Body Parameters
This method takes a User object. See doc
Output
This method returns a User
object. See doc
Possible Error Codes
Code | Message |
---|---|
401890 | User with identifier X of type Y was not found. |
401859 | Action currently not supported. |
401676 | No valid XML was given. |
401858 | The external id in DB does not fit the given value in xml - external id cannot be updated. |
401855 | The account type 'Internal with external authentication' is currently not supported. |
500038 | New password must be at least 8 characters long and must not include the user-name or any commonly used password. |
401860 | Failed to update user. |
401652 | General Error: An error has occurred while processing the request. |
401863 | Given X type (Y) is not supported for given user record type (Z). |
401864 | Given X type (Y) is invalid. |