diff options
| author | omnom62 <omnom62@outlook.com> | 2026-09-04 14:05:03 +1000 |
|---|---|---|
| committer | omnom62 <omnom62@outlook.com> | 2026-09-26 08:42:24 +1000 |
| commit | 74d308657a0fe3fd653fcb24aeec84a3dbfe7951 (patch) | |
| tree | 0babb160b4849da191ce13f14ab694fd339c4b9d /docs | |
| parent | bcad2c69cbe8656fd4d743f822858f05223169c9 (diff) | |
| download | rest.vyos-74d308657a0fe3fd653fcb24aeec84a3dbfe7951.tar.gz rest.vyos-74d308657a0fe3fd653fcb24aeec84a3dbfe7951.zip | |
T8989: new auth methods
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/vyos.rest.vyos_httpapi.rst | 67 |
1 files changed, 66 insertions, 1 deletions
diff --git a/docs/vyos.rest.vyos_httpapi.rst b/docs/vyos.rest.vyos_httpapi.rst index 1a5e613..e9e8ce6 100644 --- a/docs/vyos.rest.vyos_httpapi.rst +++ b/docs/vyos.rest.vyos_httpapi.rst @@ -142,7 +142,6 @@ Parameters </td> <td> <div>Full URL of the OAuth2/OIDC token endpoint.</div> - <div>E.g. <code>https://keycloak.example.com/realms/vyos/protocol/openid-connect/token</code>.</div> <div>Required when <code>auth_method=oidc</code>.</div> </td> </tr> @@ -161,6 +160,72 @@ Notes +Examples +-------- + +.. code-block:: yaml + + # inventory.yml - form-field API key (default, backward-compatible) + all: + hosts: + vyos01: + ansible_host: 192.168.1.1 + ansible_connection: ansible.netcommon.httpapi + ansible_network_os: vyos.rest.vyos + ansible_httpapi_use_ssl: true + ansible_httpapi_validate_certs: false + ansible_httpapi_api_key: mysecretkey + + # inventory.yml - X-API-Key header + all: + hosts: + vyos01: + ansible_host: 192.168.1.1 + ansible_connection: ansible.netcommon.httpapi + ansible_network_os: vyos.rest.vyos + ansible_httpapi_use_ssl: true + ansible_httpapi_validate_certs: false + ansible_httpapi_api_key: mysecretkey + ansible_vyos_auth_method: header + + # inventory.yml - Bearer token (JWT) + all: + hosts: + vyos01: + ansible_host: 192.168.1.1 + ansible_connection: ansible.netcommon.httpapi + ansible_network_os: vyos.rest.vyos + ansible_httpapi_use_ssl: true + ansible_httpapi_validate_certs: false + ansible_httpapi_api_key: mysecretkey + ansible_vyos_auth_method: bearer + + # inventory.yml - mTLS client certificate + all: + hosts: + vyos01: + ansible_host: 192.168.1.1 + ansible_connection: ansible.netcommon.httpapi + ansible_network_os: vyos.rest.vyos + ansible_httpapi_use_ssl: true + ansible_httpapi_validate_certs: false + ansible_vyos_auth_method: mtls + ansible_httpapi_client_cert: /etc/ansible/certs/client.pem + ansible_httpapi_client_key: /etc/ansible/certs/client.key + + # inventory.yml - OIDC (Keycloak client credentials) + all: + hosts: + vyos01: + ansible_host: 192.168.1.1 + ansible_connection: ansible.netcommon.httpapi + ansible_network_os: vyos.rest.vyos + ansible_httpapi_use_ssl: true + ansible_httpapi_validate_certs: false + ansible_vyos_auth_method: oidc + ansible_vyos_oidc_token_url: https://keycloak.example.com/realms/vyos/protocol/openid-connect/token + ansible_vyos_oidc_client_id: vyos-api + ansible_vyos_oidc_client_secret: mysecret |