keycloak.openid_connection

Keycloak OpenID Connection Manager module.

The module contains mainly the implementation of KeycloakOpenIDConnection class. This is an extension of the ConnectionManager class, and handles the automatic refresh of openid tokens when required.

Classes

KeycloakOpenIDConnection

A class to help with OpenID connections which can auto refresh tokens.

Module Contents

class keycloak.openid_connection.KeycloakOpenIDConnection(server_url, grant_type=None, username=None, password=None, token=None, totp=None, realm_name='master', client_id='admin-cli', verify=True, client_secret_key=None, custom_headers=None, user_realm_name=None, timeout=60, cert=None, max_retries=1)

Bases: keycloak.connection.ConnectionManager

A class to help with OpenID connections which can auto refresh tokens.

Parameters:

object (_type_) – _description_

_server_url = None

_grant_type = None

_username = None

_password = None

_totp = None

_realm_name = None

_client_id = None

_verify = None

_client_secret_key = None

_connection = None

_custom_headers = None

_user_realm_name = None

_expires_at = None

_keycloak_openid = None

token_lifetime_fraction = 0.9

headers

Return header request to the server.

Returns:

Request headers

Return type:

dict

property server_url

Get server url.

Returns:

Keycloak server url

Return type:

str

property grant_type

Get grant type.

Returns:

Grant type

Return type:

str

property username

Get username.

Returns:

Admin username

Return type:

str

property password

Get password.

Returns:

Admin password

Return type:

str

property token

Get token.

Returns:

Access and refresh token

Return type:

dict

property totp

Get totp.

Returns:

TOTP

Return type:

str

property realm_name

Get realm name.

Returns:

Realm name

Return type:

str

property client_id

Get client id.

Returns:

Client id

Return type:

str

verify = True

Return verify in use for request to the server.

Returns:

Verify indicator

Return type:

bool

property client_secret_key

Get client secret key.

Returns:

Client secret key

Return type:

str

property user_realm_name

Get user realm name.

Returns:

User realm name

Return type:

str

timeout = 60

Return timeout in use for request to the server.

Returns:

Timeout

Return type:

int

property custom_headers

Get custom headers.

Returns:

Custom headers

Return type:

dict

cert = None

Return client certificates in use for request to the server.

Returns:

Client certificate

Return type:

Union[str,Tuple[str,str]]

property expires_at

Get token expiry time.

Returns:

Datetime at which the current token will expire

Return type:

datetime

property keycloak_openid: keycloak.keycloak_openid.KeycloakOpenID

Get the KeycloakOpenID object.

The KeycloakOpenID is used to refresh tokens

Returns:

KeycloakOpenID

Return type:

KeycloakOpenID

get_token()

Get admin token.

The admin token is then set in the token attribute.

refresh_token()

Refresh the token.

Raises:

KeycloakPostError – In case the refresh token request failed.

_refresh_if_required()

raw_get(*args, **kwargs)

Call connection.raw_get.

If auto_refresh is set for get and access_token is expired, it will refresh the token and try get once more.

Parameters:

• args (tuple) – Additional arguments

• kwargs (dict) – Additional keyword arguments

Returns:

Response

Return type:

Response

raw_post(*args, **kwargs)

Call connection.raw_post.

If auto_refresh is set for post and access_token is expired, it will refresh the token and try post once more.

Parameters:

• args (tuple) – Additional arguments

• kwargs (dict) – Additional keyword arguments

Returns:

Response

Return type:

Response

raw_put(*args, **kwargs)

Call connection.raw_put.

If auto_refresh is set for put and access_token is expired, it will refresh the token and try put once more.

Parameters:

• args (tuple) – Additional arguments

• kwargs (dict) – Additional keyword arguments

Returns:

Response

Return type:

Response

raw_delete(*args, **kwargs)

Call connection.raw_delete.

If auto_refresh is set for delete and access_token is expired, it will refresh the token and try delete once more.

Parameters:

• args (tuple) – Additional arguments

• kwargs (dict) – Additional keyword arguments

Returns:

Response

Return type:

Response

async a_get_token()

Get admin token.

The admin token is then set in the token attribute.

async a_refresh_token()

Refresh the token.

Raises:

KeycloakPostError – In case the refresh token request failed.

async a__refresh_if_required()

Refresh the token if it is expired.

async a_raw_get(*args, **kwargs)

Call connection.raw_get.

If auto_refresh is set for get and access_token is expired, it will refresh the token and try get once more.

Parameters:

• args (tuple) – Additional arguments

• kwargs (dict) – Additional keyword arguments

Returns:

Response

Return type:

Response

async a_raw_post(*args, **kwargs)

Call connection.raw_post.

If auto_refresh is set for post and access_token is expired, it will refresh the token and try post once more.

Parameters:

• args (tuple) – Additional arguments

• kwargs (dict) – Additional keyword arguments

Returns:

Response

Return type:

Response

async a_raw_put(*args, **kwargs)

Call connection.raw_put.

If auto_refresh is set for put and access_token is expired, it will refresh the token and try put once more.

Parameters:

• args (tuple) – Additional arguments

• kwargs (dict) – Additional keyword arguments

Returns:

Response

Return type:

Response

async a_raw_delete(*args, **kwargs)

Call connection.raw_delete.

If auto_refresh is set for delete and access_token is expired, it will refresh the token and try delete once more.

Parameters:

• args (tuple) – Additional arguments

• kwargs (dict) – Additional keyword arguments

Returns:

Response

Return type:

Response