OpenXchangeClient.Api.Multifactor (open_xchange_client v0.10.0)

API calls for all endpoints tagged Multifactor.

Link to this section Summary

Link to this section Functions

Link to this function

multifactor_device_action_all(connection, session, opts \\ [])

@spec multifactor_device_action_all(Tesla.Env.client(), String.t(), keyword()) ::
  {:ok, OpenXchangeClient.Model.MultifactorDevicesResponse.t()}
  | {:error, Tesla.Env.t()}

Gets all multifactor devices

parameters

Parameters

  • connection (OpenXchangeClient.Connection): Connection to server
  • session (String.t): A session ID previously obtained from the login module.
  • opts (KeywordList): [optional] Optional parameters

returns

Returns

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

Link to this function

multifactor_device_action_delete(connection, session, provider_name, device_id, opts \\ [])

@spec multifactor_device_action_delete(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  String.t(),
  keyword()
) ::
  {:ok, OpenXchangeClient.Model.MultifactorDeleteResponse.t()}
  | {:error, Tesla.Env.t()}

Deletes a multifactor device

parameters

Parameters

  • connection (OpenXchangeClient.Connection): Connection to server
  • session (String.t): A session ID previously obtained from the login module.
  • provider_name (String.t): The name of the multifactor provider
  • device_id (String.t): The ID of the multifactor device
  • opts (KeywordList): [optional] Optional parameters

returns

Returns

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

Link to this function

multifactor_device_action_rename(connection, session, provider_name, body, opts \\ [])

Renames an existing multifactor device

parameters

Parameters

  • connection (OpenXchangeClient.Connection): Connection to server
  • session (String.t): A session ID previously obtained from the login module.
  • provider_name (String.t): The name of the multifactor provider
  • body (MultifactorDevice): A device containing the device ID, and the new name.
  • opts (KeywordList): [optional] Optional parameters

returns

Returns

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

Link to this function

multifactor_device_action_start_authentication(connection, session, provider_name, device_id, opts \\ [])

@spec multifactor_device_action_start_authentication(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  String.t(),
  keyword()
) ::
  {:ok, OpenXchangeClient.Model.MultifactorStartAuthenticationResponse.t()}
  | {:error, Tesla.Env.t()}

Starts the process of authentication against a multifactor device

parameters

Parameters

  • connection (OpenXchangeClient.Connection): Connection to server
  • session (String.t): A session ID previously obtained from the login module.
  • provider_name (String.t): The name of the multifactor provider
  • device_id (String.t): The ID of the multifactor device
  • opts (KeywordList): [optional] Optional parameters

returns

Returns

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

Link to this function

multifactor_device_action_start_registration(connection, session, opts \\ [])

@spec multifactor_device_action_start_registration(
  Tesla.Env.client(),
  String.t(),
  keyword()
) ::
  {:ok, OpenXchangeClient.Model.MultifactorStartRegistrationResponse.t()}
  | {:error, Tesla.Env.t()}

Starts the process of registering a new multifactor device

parameters

Parameters

  • connection (OpenXchangeClient.Connection): Connection to server
  • session (String.t): A session ID previously obtained from the login module.
  • opts (KeywordList): [optional] Optional parameters
    • :body (MultifactorDevice): A device which should be registered as new multifactor device.

returns

Returns

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

Link to this function

multifactor_device_actionfinish_authentication(connection, session, provider_name, device_id, body, opts \\ [])

@spec multifactor_device_actionfinish_authentication(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  String.t(),
  OpenXchangeClient.Model.MultifactorFinishAuthenticationData.t(),
  keyword()
) :: {:ok, OpenXchangeClient.Model.CommonResponse.t()} | {:error, Tesla.Env.t()}

Finishes authentication against a multifactor device

parameters

Parameters

  • connection (OpenXchangeClient.Connection): Connection to server
  • session (String.t): A session ID previously obtained from the login module.
  • provider_name (String.t): The name of the multifactor provider
  • device_id (String.t): The ID of the multifactor device
  • body (MultifactorFinishAuthenticationData): The information required to finish the registration of a new multifactor device.
  • opts (KeywordList): [optional] Optional parameters

returns

Returns

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

Link to this function

multifactor_device_actionfinish_registration(connection, session, provider_name, device_id, body, opts \\ [])

Finishes the process of registering a new multifactor device

parameters

Parameters

  • connection (OpenXchangeClient.Connection): Connection to server
  • session (String.t): A session ID previously obtained from the login module.
  • provider_name (String.t): The name of the multifactor provider
  • device_id (String.t): The ID of the multifactor device
  • body (MultifactorFinishRegistrationData): The information required to finish the registration of a new multifactor device.
  • opts (KeywordList): [optional] Optional parameters

returns

Returns

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

Link to this function

multifactor_provider_action_all(connection, session, opts \\ [])

@spec multifactor_provider_action_all(Tesla.Env.client(), String.t(), keyword()) ::
  {:ok, OpenXchangeClient.Model.MultifactorProvidersResponse.t()}
  | {:error, Tesla.Env.t()}

Gets all available multifactor providers

parameters

Parameters

  • connection (OpenXchangeClient.Connection): Connection to server
  • session (String.t): A session ID previously obtained from the login module.
  • opts (KeywordList): [optional] Optional parameters
    • :providers (String.t): A comma separated list of provider names to return. Omit to return all available providers.

returns

Returns

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