Skip to content

get_access_token_with_key endpoint param #296

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
paulineribeyre wants to merge 2 commits into from
+10 −6
Closed

get_access_token_with_key endpoint param #296

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
2351f26
get_access_token_with_key endpoint param
paulineribeyre Apr 7, 2026
56fe574
Apply automatic documentation changes
paulineribeyre Apr 7, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 5 additions & 3 deletions docs/_build/html/_modules/gen3/auth.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -98,11 +98,11 @@ <h1>Source code for gen3.auth</h1><div class="highlight"><pre>
<span class="k">raise</span> <span class="n">Gen3AuthError</span><span class="p">(</span><span class="n">err_msg</span><span class="o">.</span><span class="n">format</span><span class="p">(</span><span class="n">resp</span><span class="o">.</span><span class="n">url</span><span class="p">,</span> <span class="n">json_resp</span><span class="p">))</span>


<span class="k">def</span><span class="w"> </span><span class="nf">get_access_token_with_key</span><span class="p">(</span><span class="n">api_key</span><span class="p">):</span>
<span class="k">def</span><span class="w"> </span><span class="nf">get_access_token_with_key</span><span class="p">(</span><span class="n">api_key</span><span class="p">,</span> <span class="n">endpoint</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;</span>
<span class="sd"> Try to fetch an access token given the api key</span>
<span class="sd"> &quot;&quot;&quot;</span>
<span class="n">endpoint</span> <span class="o">=</span> <span class="n">endpoint_from_token</span><span class="p">(</span><span class="n">api_key</span><span class="p">[</span><span class="s2">&quot;api_key&quot;</span><span class="p">])</span>
<span class="n">endpoint</span> <span class="o">=</span> <span class="n">endpoint</span> <span class="ow">or</span> <span class="n">endpoint_from_token</span><span class="p">(</span><span class="n">api_key</span><span class="p">[</span><span class="s2">&quot;api_key&quot;</span><span class="p">])</span>
<span class="c1"># attempt to get a token from Fence</span>
<span class="n">auth_url</span> <span class="o">=</span> <span class="s2">&quot;</span><span class="si">{}</span><span class="s2">/user/credentials/cdis/access_token&quot;</span><span class="o">.</span><span class="n">format</span><span class="p">(</span><span class="n">endpoint</span><span class="p">)</span>
<span class="n">resp</span> <span class="o">=</span> <span class="n">requests</span><span class="o">.</span><span class="n">post</span><span class="p">(</span><span class="n">auth_url</span><span class="p">,</span> <span class="n">json</span><span class="o">=</span><span class="n">api_key</span><span class="p">)</span>
Expand Down Expand Up @@ -405,7 +405,9 @@ <h1>Source code for gen3.auth</h1><div class="highlight"><pre>
<span class="n">endpoint</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">_client_credentials</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">_client_scopes</span>
<span class="p">)</span>
<span class="k">elif</span> <span class="bp">self</span><span class="o">.</span><span class="n">_refresh_token</span><span class="p">:</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_access_token</span> <span class="o">=</span> <span class="n">get_access_token_with_key</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">_refresh_token</span><span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_access_token</span> <span class="o">=</span> <span class="n">get_access_token_with_key</span><span class="p">(</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_refresh_token</span><span class="p">,</span> <span class="n">endpoint</span>
<span class="p">)</span>
<span class="k">else</span><span class="p">:</span>
<span class="n">logging</span><span class="o">.</span><span class="n">warning</span><span class="p">(</span>
<span class="sa">f</span><span class="s2">&quot;Unable to refresh access token. &quot;</span>
Expand Down
8 changes: 5 additions & 3 deletions gen3/auth.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -65,11 +65,11 @@ def _handle_access_token_response(resp, token_key):
raise Gen3AuthError(err_msg.format(resp.url, json_resp))


def get_access_token_with_key(api_key):
def get_access_token_with_key(api_key, endpoint=None):
"""
Try to fetch an access token given the api key
"""
endpoint = endpoint_from_token(api_key["api_key"])
endpoint = endpoint or endpoint_from_token(api_key["api_key"])
# attempt to get a token from Fence
auth_url = "{}/user/credentials/cdis/access_token".format(endpoint)
resp = requests.post(auth_url, json=api_key)
Expand Down Expand Up @@ -368,7 +368,9 @@ def refresh_access_token(self, endpoint=None):
endpoint, self._client_credentials, self._client_scopes
)
elif self._refresh_token:
self._access_token = get_access_token_with_key(self._refresh_token)
self._access_token = get_access_token_with_key(
self._refresh_token, endpoint
)
else:
logging.warning(
f"Unable to refresh access token. "
Expand Down
Loading