OpenXchangeClient.Api.Passwordchange (open_xchange_client v0.10.0)

API calls for all endpoints tagged Passwordchange.

Link to this section Summary

Functions

Updates or changes the password of the current use.

Link to this section Functions

Link to this function

update_password(connection, session, body, opts \\ [])

Updates or changes the password of the current use.

Note The new password will be set without any checks. The client must ensure that it is the password the user wants to set.

parameters

Parameters

  • connection (OpenXchangeClient.Connection): Connection to server
  • session (String.t): A session ID previously obtained from the login module.
  • body (PasswordChangeBody): A JSON object containing the old and the new password.
  • opts (KeywordList): [optional] Optional parameters

returns

Returns

on success {:error, Tesla.Env.t} on failure