Update User Details

Catalyst allows you to modify and update the following details of an end-user:

  • First Name
  • Last Name
  • OrgID : OrgID is a unique value that is generated by Catalyst to associate with an organization.
  • RoleID : Role ID is the value generated by Catalyst that is assigned to a particular user role.

Create a dictionary

    
copy
update_config = { "email_id": "amelia.burrows@zylker.com", "last_name": "Burrows", "first_name": "Amelia", "org_id": "1012585680", "role_id": "6759000000054065", }

The SDK snippet below demonstrates updating an end-user’s details using the update_user_details(userID, userDetails) method. The first name of the user is updated in the example below.

To know more about the component instance authentication_service used below, please refer to this section.

Parameters Used

Parameter Name Data Type Definition
UserID String A Mandatory parameter. Will hold the UserID of the user whose details are to be updated.
update_config Object A Mandatory parameter. Will hold the values of email_id, last_name, first_name, org_id and role_id. You can update the first_name or last_name parameter here.
    
copy
authentication_service = app.authentication() user_details=authentication_service.update_user_details('6759000000124659', update_config)
Info : Refer to the SDK Scopes table to determine the required permission level for performing the above operation.

Last Updated 2025-03-28 18:24:49 +0530 +0530