get_auth_info | SignalWire

Get a summary of which authentication methods are configured and their settings. Sensitive values (passwords, tokens, keys) are not included.

Returns

dict[str, Any] — Dictionary with keys for each enabled method (basic, bearer, api_key), each containing enabled: True and relevant non-sensitive metadata.

Example

1 from signalwire.core.security_config import SecurityConfig
2 from signalwire.core.auth_handler import AuthHandler
3 
4 security = SecurityConfig()
5 auth = AuthHandler(security)
6 info = auth.get_auth_info()
7 
8 print(info)
9 # {
10 #   'basic': {'enabled': True, 'username': 'signalwire'},
11 #   'bearer': {'enabled': True, 'hint': 'Use Authorization: Bearer <token>'},
12 #   'api_key': {'enabled': True, 'header': 'X-API-Key', 'hint': 'Use X-API-Key: <key>'}
13 # }

1	from signalwire.core.security_config import SecurityConfig
2	from signalwire.core.auth_handler import AuthHandler
3
4	security = SecurityConfig()
5	auth = AuthHandler(security)
6	info = auth.get_auth_info()
7
8	print(info)
9	# {
10	# 'basic': {'enabled': True, 'username': 'signalwire'},
11	# 'bearer': {'enabled': True, 'hint': 'Use Authorization: Bearer <token>'},
12	# 'api_key': {'enabled': True, 'header': 'X-API-Key', 'hint': 'Use X-API-Key: <key>'}
13	# }