Configuration

Configuration

Configuration Key	Description	Default
token_lifespan	time span that GTA tokens are valid for	two weeks
batch_request_ buffer_throttle	timeframe in which a subsequent requests are considered "batch" requests	five seconds
change_headers_on_each_request	whether new auth headers / tokens are created on each request	true
mappings	scope to class mappings	an empty a hash
redirect_whitelist	array of urls that are allowed to be redirected to after authentication requests	nil
param_white_list	hash where key is the scope and value is array of attributes that are permitted to be set on a resource	nil
authentication_keys	array of attributes that can be used to find a resource	[:email]
omniauth_prefix	url prefix where omniauth and related callbacks are mounted, this will become the OmniAuth::config.path_prefix	'/omniauth'
ignore_default_ serialization_blacklist	when set to true, the default serialization blacklist is not applied only use this when you need to serialize an attribute that is in the default list	false
additional_ serialization_blacklist	list of attributes that should be ignored when serializing an object	an empty Array
from_address	the "from" email for authentication emails	nil
default_url_options	url hash for creating urls in auth emails, see HTTP	an empty hash
mailer	Mailer class used to send emails	SMTPMailer
default_password_reset_url	refault redirect url if not provided in password reset params	nil
smtp_configuration	SMTP configuration hash for SMTP mailer, see SMTP	an empty hash
secret	Random Hex String used to salt key generation	nil
digest	default digest method, see HMAC	SHA256
messages	message classes that are used to create emails, see DEFAULT_MESSAGES	GrapeTokenAuth::Mail::DEFAULT_MESSAGES