Browse Source

docs: Allow the verify attribute to be bool or string #479 (#480)

pull/508/head
Daniel Herrmann 12 months ago
committed by GitHub
parent
commit
92f7d7667c
No known key found for this signature in database GPG Key ID: 4AEE18F83AFDEB23
  1. 8
      src/keycloak/connection.py
  2. 8
      src/keycloak/keycloak_admin.py
  3. 6
      src/keycloak/keycloak_openid.py
  4. 4
      src/keycloak/openid_connection.py

8
src/keycloak/connection.py

@ -43,8 +43,8 @@ class ConnectionManager(object):
:type headers: dict :type headers: dict
:param timeout: Timeout to use for requests to the server. :param timeout: Timeout to use for requests to the server.
:type timeout: int :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. :param proxies: The proxies servers requests is sent by.
:type proxies: dict :type proxies: dict
""" """
@ -58,8 +58,8 @@ class ConnectionManager(object):
:type headers: dict :type headers: dict
:param timeout: Timeout to use for requests to the server. :param timeout: Timeout to use for requests to the server.
:type timeout: int :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. :param proxies: The proxies servers requests is sent by.
:type proxies: dict :type proxies: dict
""" """

8
src/keycloak/keycloak_admin.py

@ -63,8 +63,8 @@ class KeycloakAdmin:
:type realm_name: str :type realm_name: str
:param client_id: client id :param client_id: client id
:type client_id: str :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 :param client_secret_key: client secret key
(optional, required only for access type confidential) (optional, required only for access type confidential)
:type client_secret_key: str :type client_secret_key: str
@ -119,8 +119,8 @@ class KeycloakAdmin:
:type realm_name: str :type realm_name: str
:param client_id: client id :param client_id: client id
:type client_id: str :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 :param client_secret_key: client secret key
(optional, required only for access type confidential) (optional, required only for access type confidential)
:type client_secret_key: str :type client_secret_key: str

6
src/keycloak/keycloak_openid.py

@ -68,7 +68,7 @@ class KeycloakOpenID:
:param client_id: client id :param client_id: client id
:param realm_name: realm name :param realm_name: realm name
:param client_secret_key: client secret key :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 custom_headers: dict of custom header to pass to each HTML request
:param proxies: dict of proxies to sent the request by. :param proxies: dict of proxies to sent the request by.
:param timeout: connection timeout in seconds :param timeout: connection timeout in seconds
@ -95,8 +95,8 @@ class KeycloakOpenID:
:type realm_name: str :type realm_name: str
:param client_secret_key: client secret key :param client_secret_key: client secret key
:type client_secret_key: str :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 :param custom_headers: dict of custom header to pass to each HTML request
:type custom_headers: dict :type custom_headers: dict
:param proxies: dict of proxies to sent the request by. :param proxies: dict of proxies to sent the request by.

4
src/keycloak/openid_connection.py

@ -87,8 +87,8 @@ class KeycloakOpenIDConnection(ConnectionManager):
:type realm_name: str :type realm_name: str
:param client_id: client id :param client_id: client id
:type client_id: str :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 :param client_secret_key: client secret key
(optional, required only for access type confidential) (optional, required only for access type confidential)
:type client_secret_key: str :type client_secret_key: str

Loading…
Cancel
Save