From 92f7d7667c888326576bf7b81fdcfab5fc3398f9 Mon Sep 17 00:00:00 2001 From: Daniel Herrmann Date: Mon, 13 Nov 2023 12:54:00 +0100 Subject: [PATCH] docs: Allow the verify attribute to be bool or string #479 (#480) --- src/keycloak/connection.py | 8 ++++---- src/keycloak/keycloak_admin.py | 8 ++++---- src/keycloak/keycloak_openid.py | 6 +++--- src/keycloak/openid_connection.py | 4 ++-- 4 files changed, 13 insertions(+), 13 deletions(-) diff --git a/src/keycloak/connection.py b/src/keycloak/connection.py index 3134676..63918fe 100644 --- a/src/keycloak/connection.py +++ b/src/keycloak/connection.py @@ -43,8 +43,8 @@ class ConnectionManager(object): :type headers: dict :param timeout: Timeout to use for requests to the server. :type timeout: int - :param verify: Verify server SSL. - :type verify: bool + :param verify: Boolean value to enable or disable certificate validation or a string containing a path to a CA bundle to use + :type verify: Union[bool,str] :param proxies: The proxies servers requests is sent by. :type proxies: dict """ @@ -58,8 +58,8 @@ class ConnectionManager(object): :type headers: dict :param timeout: Timeout to use for requests to the server. :type timeout: int - :param verify: Verify server SSL. - :type verify: bool + :param verify: Boolean value to enable or disable certificate validation or a string containing a path to a CA bundle to use + :type verify: Union[bool,str] :param proxies: The proxies servers requests is sent by. :type proxies: dict """ diff --git a/src/keycloak/keycloak_admin.py b/src/keycloak/keycloak_admin.py index 5518d43..2c31e29 100644 --- a/src/keycloak/keycloak_admin.py +++ b/src/keycloak/keycloak_admin.py @@ -63,8 +63,8 @@ class KeycloakAdmin: :type realm_name: str :param client_id: client id :type client_id: str - :param verify: True if want check connection SSL - :type verify: bool + :param verify: Boolean value to enable or disable certificate validation or a string containing a path to a CA bundle to use + :type verify: Union[bool,str] :param client_secret_key: client secret key (optional, required only for access type confidential) :type client_secret_key: str @@ -119,8 +119,8 @@ class KeycloakAdmin: :type realm_name: str :param client_id: client id :type client_id: str - :param verify: True if want check connection SSL - :type verify: bool + :param verify: Boolean value to enable or disable certificate validation or a string containing a path to a CA bundle to use + :type verify: Union[bool,str] :param client_secret_key: client secret key (optional, required only for access type confidential) :type client_secret_key: str diff --git a/src/keycloak/keycloak_openid.py b/src/keycloak/keycloak_openid.py index 550b12f..c359980 100644 --- a/src/keycloak/keycloak_openid.py +++ b/src/keycloak/keycloak_openid.py @@ -68,7 +68,7 @@ class KeycloakOpenID: :param client_id: client id :param realm_name: realm name :param client_secret_key: client secret key - :param verify: True if want check connection SSL + :param verify: Boolean value to enable or disable certificate validation or a string containing a path to a CA bundle to use :param custom_headers: dict of custom header to pass to each HTML request :param proxies: dict of proxies to sent the request by. :param timeout: connection timeout in seconds @@ -95,8 +95,8 @@ class KeycloakOpenID: :type realm_name: str :param client_secret_key: client secret key :type client_secret_key: str - :param verify: True if want check connection SSL - :type verify: bool + :param verify: Boolean value to enable or disable certificate validation or a string containing a path to a CA bundle to use + :type verify: Union[bool,str] :param custom_headers: dict of custom header to pass to each HTML request :type custom_headers: dict :param proxies: dict of proxies to sent the request by. diff --git a/src/keycloak/openid_connection.py b/src/keycloak/openid_connection.py index 9963ade..c7141fe 100644 --- a/src/keycloak/openid_connection.py +++ b/src/keycloak/openid_connection.py @@ -87,8 +87,8 @@ class KeycloakOpenIDConnection(ConnectionManager): :type realm_name: str :param client_id: client id :type client_id: str - :param verify: True if want check connection SSL - :type verify: bool + :param verify: Boolean value to enable or disable certificate validation or a string containing a path to a CA bundle to use + :type verify: Union[bool,str] :param client_secret_key: client secret key (optional, required only for access type confidential) :type client_secret_key: str