ExDaytona.Api.Users (ex_daytona v0.3.0)

API calls for all endpoints tagged Users.

Summary

Functions

confirm_pending_sso_link(connection, id, opts \\ [])

Confirm (link) a pending SSO account link

dismiss_pending_sso_link(connection, id, opts \\ [])

Dismiss a pending SSO account link

enroll_in_sms_mfa(connection, opts \\ [])

Enroll in SMS MFA

get_authenticated_user(connection, opts \\ [])

Get authenticated user

get_available_account_providers(connection, opts \\ [])

Get available account providers

link_account(connection, create_linked_account, opts \\ [])

Link account

list_pending_sso_links(connection, opts \\ [])

List pending SSO account links for the authenticated user

unlink_account(connection, provider, provider_user_id, opts \\ [])

Unlink account

Functions

confirm_pending_sso_link(connection, id, opts \\ [])

@spec confirm_pending_sso_link(Tesla.Env.client(), String.t(), keyword()) ::
  {:ok, nil} | {:error, Tesla.Env.t()}

Confirm (link) a pending SSO account link

Parameters

connection (ExDaytona.Connection): Connection to server
id (String.t):
opts (keyword): Optional parameters

Returns

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

dismiss_pending_sso_link(connection, id, opts \\ [])

@spec dismiss_pending_sso_link(Tesla.Env.client(), String.t(), keyword()) ::
  {:ok, nil} | {:error, Tesla.Env.t()}

Dismiss a pending SSO account link

Parameters

connection (ExDaytona.Connection): Connection to server
id (String.t):
opts (keyword): Optional parameters

Returns

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

enroll_in_sms_mfa(connection, opts \\ [])

@spec enroll_in_sms_mfa(
  Tesla.Env.client(),
  keyword()
) :: {:ok, String.t()} | {:error, Tesla.Env.t()}

Enroll in SMS MFA

Parameters

connection (ExDaytona.Connection): Connection to server
opts (keyword): Optional parameters

Returns

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

get_authenticated_user(connection, opts \\ [])

@spec get_authenticated_user(
  Tesla.Env.client(),
  keyword()
) :: {:ok, ExDaytona.Model.User.t()} | {:error, Tesla.Env.t()}

Get authenticated user

Parameters

connection (ExDaytona.Connection): Connection to server
opts (keyword): Optional parameters

Returns

{:ok, ExDaytona.Model.User.t} on success
{:error, Tesla.Env.t} on failure

get_available_account_providers(connection, opts \\ [])

@spec get_available_account_providers(
  Tesla.Env.client(),
  keyword()
) :: {:ok, [ExDaytona.Model.AccountProvider.t()]} | {:error, Tesla.Env.t()}

Get available account providers

Parameters

connection (ExDaytona.Connection): Connection to server
opts (keyword): Optional parameters

Returns

{:ok, [%AccountProvider{}, ...]} on success
{:error, Tesla.Env.t} on failure

link_account(connection, create_linked_account, opts \\ [])

@spec link_account(
  Tesla.Env.client(),
  ExDaytona.Model.CreateLinkedAccount.t(),
  keyword()
) ::
  {:ok, nil} | {:error, Tesla.Env.t()}

Link account

Parameters

connection (ExDaytona.Connection): Connection to server
create_linked_account (CreateLinkedAccount):
opts (keyword): Optional parameters

Returns

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

list_pending_sso_links(connection, opts \\ [])

@spec list_pending_sso_links(
  Tesla.Env.client(),
  keyword()
) :: {:ok, [ExDaytona.Model.PendingSsoLink.t()]} | {:error, Tesla.Env.t()}

List pending SSO account links for the authenticated user

Parameters

connection (ExDaytona.Connection): Connection to server
opts (keyword): Optional parameters

Returns

{:ok, [%PendingSsoLink{}, ...]} on success
{:error, Tesla.Env.t} on failure

unlink_account(connection, provider, provider_user_id, opts \\ [])

@spec unlink_account(Tesla.Env.client(), String.t(), String.t(), keyword()) ::
  {:ok, nil} | {:error, Tesla.Env.t()}

Unlink account

Parameters

connection (ExDaytona.Connection): Connection to server
provider (String.t):
provider_user_id (String.t):
opts (keyword): Optional parameters

Returns

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