Wiki
Clone wikiNumera.LibrisAPI / identity.update
Home > API Reference Documentation > identity.update
identity.update
The identity.update action is used to update an existing user identity. You should include the parameters for the information you actually want to update, so if you don't want to update the person's email address or profile information, then do not send those items. We have to make a service call into the identity platform for those changes, so you can increase performance if you don't need to update that information. This will only work for users with the role of Agent Supervisor or above.
Input Parameters
| Property | Required | Description |
|---|---|---|
account_id | yes | The account_id of the user to change |
provider_login | no | If the provider is Numera.NIS and you want to change the login the user uses |
role | no | A new role for the user |
realm | no | A new realm for the user |
email | no | If you want to update the user's email address |
secret | no | If you want to update the user's secret (only SUPERUSERs can do this) |
first_name | no | If you want to update the first name |
last_name | no | If you want to update the last name |
country | no | If you want to update the country |
culture | no | If you want to update the culture |
date_of_birth | no | If you want to update the DOB, expects a string as YYYYMMDD |
timezone | no | If you want to update the timezone |
Output
If everything worked successfully, the result object will have an identity object (documented here) filled out completely reflecting the changes. In addition, it may contain the following items reporting all the work that was done on behalf of this update action:
| Property | Description |
|---|---|
updated_profile_api | If you updated profile information, this reports the changes were saved successfully in the identity platform |
updated_profile_libris | If you updated profile information, this reports the changes were saved successfully in the platform |
updated_email | If you updated the email address, this reports the success |
updated_login_api | If you updated the login, this reports the changes were saved successfully in the identity platform |
updated_login_libris | If you updated the login, this reports the changes were saved successfully in the platform |
updated_realm | If you updated the realm, this reports the changes were saved successfully in the platform |
updated_role | If you updated the role, this reports the changes were saved successfully in the platform |
updated_login_secret | If you updated the secret, this reports the changes were saved successfully in the platform |
If there is a failure, the result object may contain more information (in a attempted_on_exception property) detailing where it failed in the chain. The properties detailed above will give you some idea of how much of what you asked for was completed since there are many systems involved, but you will also see other information:
| Value | Description |
|---|---|
UPDATE_SECRET | Attempting to update the secret |
UPDATE_ROLE | Attempting to update the role |
UPDATE_REALM | Attempting to update the realm |
UPDATE_LOGIN | Attempting to update the login |
UPDATE_PROFILE | Attempting to update the profile |
UPDATE_EMAIL | Attempting to update the email |
LOAD_PROFILE | Attempting to re-load the profile after an update |
SAVE_PROFILE | Attempting to save the updated profile |
Possible Status Codes
| Status Code | Reason | Description |
|---|---|---|
1000 | NOT_IN_REALM | If the current user is not a Superuser, and their realm does not match the realm of the user they are trying to update, then the request will fail. |
1001 | API_EXCEPTION | The api_status_code, api_reason property of the result object will contain the code returned by Numera.Net if there was some type of API exception, if there was an http issue, the http_response_code will have the status code |
1003 | INVALID_USER | We could not locate a user with the account_id you provided |
1004 | ROLE_OUT_OF_BOUNDS | You tried to give a user a role you don't have the privilege to grant |
1005 | INVALID_PROVIDER | You can't update the login for a non-Numera.NIS account |
1006 | DUPLICATE_EMAIL | The email you are trying to update to already exists for another user |
1007 | SECRET_UPDATE_RESTRICTED | User does not have permissions to update the secret |
Updated