ExFTP.Auth.WebhookAuthConfig (ExFTP v1.0.2)

View Source

A module describing the authenticator_config value for ExFTP.Auth.WebhookAuth

👀 See Also

📖 Resources

Summary

Types

password_hash_type()

A hash algorithm to use on the password supplied by the client.

t()

The authenticator_config value for ExFTP.Auth.WebhookAuth

Functions

build(m)

Builds a ExFTP.Auth.WebhookAuthConfig.t/0 from a map

Types

password_hash_type()

@type password_hash_type() :: :crypto.hash_algorithm()

A hash algorithm to use on the password supplied by the client.

Used by ExFTP.Auth.WebhookAuth.login/2

👀 See Also

t()

@type t() :: %ExFTP.Auth.WebhookAuthConfig{
  authenticated_method: ExFTP.Auth.Common.authenticated_method(),
  authenticated_ttl_ms: ExFTP.Auth.Common.authenticated_ttl_ms(),
  authenticated_url: ExFTP.Auth.Common.authenticated_url() | nil,
  login_method: ExFTP.Auth.Common.login_method(),
  login_url: ExFTP.Auth.Common.login_url(),
  password_hash_type: password_hash_type()
}

The authenticator_config value for ExFTP.Auth.WebhookAuth

🏷️ Required Keys

🏷️ Optional Keys

Functions

build(m)

@spec build(m :: map()) :: t()

Builds a ExFTP.Auth.WebhookAuthConfig.t/0 from a map

🏷️ Params