Configuration

Configuration

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