verify_api_key | SignalWire

Verify an API key using constant-time comparison.

Parameters

api_key

strRequired

The API key string to verify.

Returns

bool — True if the key matches. Returns False if API key authentication is not enabled.

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 is_valid = auth.verify_api_key("my-secret-api-key")
7 
8 print(f"API key valid: {is_valid}")

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	is_valid = auth.verify_api_key("my-secret-api-key")
7
8	print(f"API key valid: {is_valid}")