Method: UserAccountsClient#update_user

Defined in:
lib/lockstep_sdk/clients/user_accounts_client.rb

#update_user(id:, body:) ⇒ Object

Updates a User that matches the specified id with the requested information.

The PATCH method allows you to change specific values on the object while leaving other values alone. As input you should supply a list of field names and new values. If you do not provide the name of a field, that field will remain unchanged. This allows you to ensure that you are only updating the specific fields desired.

A User represents a person who has the ability to authenticate against the Lockstep Platform and use services such as Lockstep Inbox. A User is uniquely identified by an Azure identity, and each user must have an email address defined within their account. All Users must validate their email to make use of Lockstep platform services. Users may have different privileges and access control rights within the Lockstep Platform.

Parameters:

  • id (uuid) —

    The unique ID number of the User to retrieve

  • body (object) —

    A list of changes to apply to this User



49
50
51
52
 
# File 'lib/lockstep_sdk/clients/user_accounts_client.rb', line 49

def update_user(id:, body:)
    path = "/api/v1/UserAccounts/#{id}"
    @connection.request(:patch, path, body.to_camelback_keys.to_json, nil)
end