summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authoromnom62 <omnom62@outlook.com>2026-10-03 16:44:59 +1000
committeromnom62 <omnom62@outlook.com>2026-10-03 16:44:59 +1000
commite562acc5a2ac5efc16e1a9d623ca962225ee31f7 (patch)
treea8d2366e0833cf4d8824ffe1ccaf2e35da033e2a /docs
parent6e9fe2c879895ade7c66b4ee199b0bac36f2b2e6 (diff)
downloadrest.vyos-t8989_auth_methods_rework.tar.gz
rest.vyos-t8989_auth_methods_rework.zip
https: T8989: auth_methods AI comments fixedt8989_auth_methods_rework
Diffstat (limited to 'docs')
-rw-r--r--docs/vyos.rest.vyos_httpapi.rst23
1 files changed, 23 insertions, 0 deletions
diff --git a/docs/vyos.rest.vyos_httpapi.rst b/docs/vyos.rest.vyos_httpapi.rst
index befe1a8..608339d 100644
--- a/docs/vyos.rest.vyos_httpapi.rst
+++ b/docs/vyos.rest.vyos_httpapi.rst
@@ -52,6 +52,7 @@ Parameters
<div>env:ANSIBLE_HTTPAPI_API_KEY</div>
<div>env:VYOS_API_KEY</div>
<div>var: ansible_httpapi_api_key</div>
+ <div>var: ansible_vyos_api_key</div>
</td>
<td>
<div>VyOS API key. Required for auth_method <code>key</code>, <code>header</code>, and <code>bearer</code>.</div>
@@ -130,6 +131,28 @@ Parameters
<tr>
<td colspan="1">
<div class="ansibleOptionAnchor" id="parameter-"></div>
+ <b>oidc_timeout</b>
+ <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">integer</span>
+ </div>
+ </td>
+ <td>
+ <b>Default:</b><br/><div style="color: blue">10</div>
+ </td>
+ <td>
+ <div> ini entries:
+ <p>[httpapi]<br>oidc_timeout = 10</p>
+ </div>
+ <div>var: ansible_httpapi_oidc_timeout</div>
+ </td>
+ <td>
+ <div>Timeout, in seconds, for the token request made to the OIDC provider. An unavailable or stalled identity provider would otherwise hang the Ansible task indefinitely.</div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="parameter-"></div>
<b>oidc_token_url</b>
<a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a>
<div style="font-size: small">