keycloak.exceptions

Keycloak custom exceptions module.

Attributes

HTTP_OK
HTTP_CREATED
HTTP_ACCEPTED
HTTP_NO_CONTENT
HTTP_BAD_REQUEST
HTTP_UNAUTHORIZED
HTTP_FORBIDDEN
HTTP_NOT_FOUND
HTTP_NOT_ALLOWED
HTTP_CONFLICT

Exceptions

KeycloakError	Base class for custom Keycloak errors.
KeycloakAuthenticationError	Keycloak authentication error exception.
KeycloakConnectionError	Keycloak connection error exception.
KeycloakOperationError	Keycloak operation error exception.
KeycloakDeprecationError	Keycloak deprecation error exception.
KeycloakGetError	Keycloak request get error exception.
KeycloakPostError	Keycloak request post error exception.
KeycloakPutError	Keycloak request put error exception.
KeycloakDeleteError	Keycloak request delete error exception.
KeycloakSecretNotFound	Keycloak secret not found exception.
KeycloakRPTNotFound	Keycloak RPT not found exception.
KeycloakAuthorizationConfigError	Keycloak authorization config exception.
KeycloakInvalidTokenError	Keycloak invalid token exception.
KeycloakPermissionFormatError	Keycloak permission format exception.
PermissionDefinitionError	Keycloak permission definition exception.

Functions

raise_error_from_response(→ bytes | dict | list)

Raise an exception for the response.

Module Contents

keycloak.exceptions.HTTP_OK = 200

keycloak.exceptions.HTTP_CREATED = 201

keycloak.exceptions.HTTP_ACCEPTED = 202

keycloak.exceptions.HTTP_NO_CONTENT = 204

keycloak.exceptions.HTTP_BAD_REQUEST = 400

keycloak.exceptions.HTTP_UNAUTHORIZED = 401

keycloak.exceptions.HTTP_FORBIDDEN = 403

keycloak.exceptions.HTTP_NOT_FOUND = 404

keycloak.exceptions.HTTP_NOT_ALLOWED = 405

keycloak.exceptions.HTTP_CONFLICT = 409

exception keycloak.exceptions.KeycloakError(error_message: str = '', response_code: int | None = None, response_body: bytes | None = None)

Bases: Exception

Base class for custom Keycloak errors.

Parameters:

• error_message (str) – The error message

• response_code (int) – The response status code

response_code = None

response_body = None

error_message = ''

__str__() → str

Str method.

Returns:

String representation of the object

Return type:

str

exception keycloak.exceptions.KeycloakAuthenticationError(error_message: str = '', response_code: int | None = None, response_body: bytes | None = None)

Bases: KeycloakError

Keycloak authentication error exception.

exception keycloak.exceptions.KeycloakConnectionError(error_message: str = '', response_code: int | None = None, response_body: bytes | None = None)

Bases: KeycloakError

Keycloak connection error exception.

exception keycloak.exceptions.KeycloakOperationError(error_message: str = '', response_code: int | None = None, response_body: bytes | None = None)

Bases: KeycloakError

Keycloak operation error exception.

exception keycloak.exceptions.KeycloakDeprecationError(error_message: str = '', response_code: int | None = None, response_body: bytes | None = None)

Bases: KeycloakError

Keycloak deprecation error exception.

exception keycloak.exceptions.KeycloakGetError(error_message: str = '', response_code: int | None = None, response_body: bytes | None = None)

Bases: KeycloakOperationError

Keycloak request get error exception.

exception keycloak.exceptions.KeycloakPostError(error_message: str = '', response_code: int | None = None, response_body: bytes | None = None)

Bases: KeycloakOperationError

Keycloak request post error exception.

exception keycloak.exceptions.KeycloakPutError(error_message: str = '', response_code: int | None = None, response_body: bytes | None = None)

Bases: KeycloakOperationError

Keycloak request put error exception.

exception keycloak.exceptions.KeycloakDeleteError(error_message: str = '', response_code: int | None = None, response_body: bytes | None = None)

Bases: KeycloakOperationError

Keycloak request delete error exception.

exception keycloak.exceptions.KeycloakSecretNotFound(error_message: str = '', response_code: int | None = None, response_body: bytes | None = None)

Bases: KeycloakOperationError

Keycloak secret not found exception.

exception keycloak.exceptions.KeycloakRPTNotFound(error_message: str = '', response_code: int | None = None, response_body: bytes | None = None)

Bases: KeycloakOperationError

Keycloak RPT not found exception.

exception keycloak.exceptions.KeycloakAuthorizationConfigError(error_message: str = '', response_code: int | None = None, response_body: bytes | None = None)

Bases: KeycloakOperationError

Keycloak authorization config exception.

exception keycloak.exceptions.KeycloakInvalidTokenError(error_message: str = '', response_code: int | None = None, response_body: bytes | None = None)

Bases: KeycloakOperationError

Keycloak invalid token exception.

exception keycloak.exceptions.KeycloakPermissionFormatError(error_message: str = '', response_code: int | None = None, response_body: bytes | None = None)

Bases: KeycloakOperationError

Keycloak permission format exception.

exception keycloak.exceptions.PermissionDefinitionError

Bases: Exception

Keycloak permission definition exception.

keycloak.exceptions.raise_error_from_response(response: requests.Response | httpx.Response, error: dict | Exception, expected_codes: list[int] | None = None, skip_exists: bool = False) → bytes | dict | list

Raise an exception for the response.

Parameters:

• response (Response) – The response object

• error (dict or Exception) – Error object to raise

• expected_codes (Sequence[int]) – Set of expected codes, which should not raise the exception

• skip_exists (bool) – Indicates whether the response on already existing object should be ignored

Returns:

Content of the response message

Type:

bytes or dict

Raises:

KeycloakError – In case of unexpected status codes