MCPcopy Create free account
hub / github.com/StackStorm/st2 / validate_api_key_and_source

Function validate_api_key_and_source

st2common/st2common/util/auth.py:138–161  ·  view source on GitHub ↗

Validate the provided API key. :param api_key_in_headers: API key provided via headers. :type api_key_in_headers: ``str`` :param api_key_query_params: API key provided via query params. :type api_key_query_params: ``str`` :return: TokenDB object on success. :rtype: :c

(api_key_in_headers, api_key_query_params)

Source from the content-addressed store, hash-verified

136
137
138def validate_api_key_and_source(api_key_in_headers, api_key_query_params):
139 """
140 Validate the provided API key.
141
142 :param api_key_in_headers: API key provided via headers.
143 :type api_key_in_headers: ``str``
144
145 :param api_key_query_params: API key provided via query params.
146 :type api_key_query_params: ``str``
147
148 :return: TokenDB object on success.
149 :rtype: :class:`.ApiKeyDB`
150 """
151 if not api_key_in_headers and not api_key_query_params:
152 LOG.audit("API key is not found in header or query parameters.")
153 raise exceptions.ApiKeyNotProvidedError("API key is not provided.")
154
155 if api_key_in_headers:
156 LOG.audit("API key provided in headers")
157
158 if api_key_query_params:
159 LOG.audit("API key provided in query parameters")
160
161 return validate_api_key(api_key_in_headers or api_key_query_params)

Callers

nothing calls this directly

Calls 1

validate_api_keyFunction · 0.85

Tested by

no test coverage detected