Browse Source

docs: missing docstrings

pull/616/head
Richard Nemeth 5 months ago
parent
commit
6cef196217
No known key found for this signature in database GPG Key ID: 21C39470DF3DEC39
  1. 3
      src/keycloak/keycloak_openid.py

3
src/keycloak/keycloak_openid.py

@ -586,9 +586,12 @@ class KeycloakOpenID:
"""Decode and optionally validate a token. """Decode and optionally validate a token.
:param token: The token to verify :param token: The token to verify
:type token: str
:param key: Which key should be used for validation. :param key: Which key should be used for validation.
If not provided, the validation is not performed and the token is implicitly valid. If not provided, the validation is not performed and the token is implicitly valid.
:type key: Union[jwk.JWK, jwk.JWKSet, None]
:param kwargs: Additional keyword arguments for jwcrypto's JWT object :param kwargs: Additional keyword arguments for jwcrypto's JWT object
:type kwargs: dict
:returns: Decoded token :returns: Decoded token
""" """
# keep the function free of IO # keep the function free of IO

Loading…
Cancel
Save