msapp_mcp
v0.1.0

MsappMcp (msapp_mcp v0.1.0)

MsappMcp API

Summary

Functions

authenticate(params, host_addr, session_name, opts \\ [])

See MsappMcp.Impl.Authentication.authenticate/4.

delete_session(session_name)

See MssubMcp.delete_session/1.

generate_session_name()

See MssubMcp.generate_session_name/0.

get_mssub_mcp_state()

See MsappMcp.Impl.Settings.get_mssub_mcp_state/0.

launch_bootstrap?()

See MsappMcp.Impl.Settings.launch_bootstrap?/0.

load_disallowed_passwords()

See MsappMcp.Impl.McpBootstrap.load_disallowed_passwords/0.

process_bootstrap_data(data)

See MsappMcp.Impl.McpBootstrap.process_bootstrap_data/1.

test_session_authentication(session_name)

See MsappMcp.Impl.Authentication.test_session_authentication/1.

Functions

Link to this function

authenticate(params, host_addr, session_name, opts \\ [])

@spec authenticate(map(), IP.addr(), MssubMcp.Types.session_name() | nil, Keyword.t()) ::
  MsappMcp.Types.login_result()

See MsappMcp.Impl.Authentication.authenticate/4.

Link to this function

delete_session(session_name)

@spec delete_session(MssubMcp.Types.session_name()) ::
  :ok | {:ok, :not_found} | {:error, MscmpSystError.t()}

See MssubMcp.delete_session/1.

Link to this function

generate_session_name()

See MssubMcp.generate_session_name/0.

Link to this function

get_mssub_mcp_state()

@spec get_mssub_mcp_state() :: MsappMcp.Types.mssub_mcp_states()

See MsappMcp.Impl.Settings.get_mssub_mcp_state/0.

Link to this function

launch_bootstrap?()

@spec launch_bootstrap?() :: boolean()

See MsappMcp.Impl.Settings.launch_bootstrap?/0.

Link to this function

load_disallowed_passwords()

@spec load_disallowed_passwords() :: :ok | {:error, MscmpSystError.t()}

See MsappMcp.Impl.McpBootstrap.load_disallowed_passwords/0.

Link to this function

process_bootstrap_data(data)

@spec process_bootstrap_data(MssubMcp.Types.tenant_bootstrap_params()) ::
  {:ok, MssubMcp.Types.tenant_bootstrap_result()} | {:error, MscmpSystError.t()}

See MsappMcp.Impl.McpBootstrap.process_bootstrap_data/1.

Link to this function

test_session_authentication(session_name)

@spec test_session_authentication(MssubMcp.Types.session_name()) ::
  :session_valid | :session_invalid | {:session_reset, String.t()}

See MsappMcp.Impl.Authentication.test_session_authentication/1.