Package: adamatics-keycloak
Adamatics Keycloakadamatics-keycloakis a Python package providing access to the Keycloak API.This is a forked version of the python-keycloak library (https://github.com/marcospereirampj/python-keycloak).
This fork tries to expand upon the functionality and provide more stability and updates to the package.This package is mainly maintained byAdamaticscompany.InstallationVia Pypi Package:$ pip install adamatics-keycloakManually$ python setup.py installDependenciesadamatics-keycloak depends on:Python 3requestspython-joseurllib3Test and Build Dependenciestoxpytestpytest-covwheelBug reportsPlease report bugs and feature requests athttps://github.com/adamatics/adamatics-keycloak/issuesContributorsAgriness TeamMarcos PereiraMartin DevlinShon T. UrbasMarkus SpanierRemco KranenburgArminnjordrJosha InglisAlexEwan JoneLukas MartiniAdamaticsUsagefromkeycloakimportKeycloakOpenID# Configure clientkeycloak_openid=KeycloakOpenID(server_url="http://localhost:8080/auth/",client_id="example_client",realm_name="example_realm",client_secret_key="secret")# Get WellKnowconfig_well_know=keycloak_openid.well_know()# Get Tokentoken=keycloak_openid.token("user","password")token=keycloak_openid.token("user","password",totp="012345")# Get Userinfouserinfo=keycloak_openid.userinfo(token['access_token'])# Refresh tokentoken=keycloak_openid.refresh_token(token['refresh_token'])# Logoutkeycloak_openid.logout(token['refresh_token'])# Get Certscerts=keycloak_openid.certs()# Get RPT (Entitlement)token=keycloak_openid.token("user","password")rpt=keycloak_openid.entitlement(token['access_token'],"resource_id")# Instropect RPTtoken_rpt_info=keycloak_openid.introspect(keycloak_openid.introspect(token['access_token'],rpt=rpt['rpt'],token_type_hint="requesting_party_token"))# Introspect Tokentoken_info=keycloak_openid.introspect(token['access_token'])# Decode TokenKEYCLOAK_PUBLIC_KEY="-----BEGIN PUBLIC KEY-----\n"+keycloak_openid.public_key()+"\n-----END PUBLIC KEY-----"options={"verify_signature":True,"verify_aud":True,"verify_exp":True}token_info=keycloak_openid.decode_token(token['access_token'],key=KEYCLOAK_PUBLIC_KEY,options=options)# Get permissions by tokentoken=keycloak_openid.token("user","password")keycloak_openid.load_authorization_config("example-authz-config.json")policies=keycloak_openid.get_policies(token['access_token'],method_token_info='decode',key=KEYCLOAK_PUBLIC_KEY)permissions=keycloak_openid.get_permissions(token['access_token'],method_token_info='introspect')# KEYCLOAK ADMINfromkeycloakimportKeycloakAdminkeycloak_admin=KeycloakAdmin(server_url="http://localhost:8080/auth/",username='example-admin',password='secret',realm_name="master",user_realm_name="only_if_other_realm_than_master",client_secret_key="client-secret",verify=True)# Add usernew_user=keycloak_admin.create_user({"email":"example@example.com","username":"example@example.com","enabled":True,"firstName":"Example","lastName":"Example"})# Add user and raise exception if username already exists# exist_ok currently defaults to True for backwards compatibility reasonsnew_user=keycloak_admin.create_user({"email":"example@example.com","username":"example@example.com","enabled":True,"firstName":"Example","lastName":"Example"},exist_ok=False)# Add user and set passwordnew_user=keycloak_admin.create_user({"email":"example@example.com","username":"example@example.com","enabled":True,"firstName":"Example","lastName":"Example","credentials":[{"value":"secret","type":"password",}]})# Add user and specify a localenew_user=keycloak_admin.create_user({"email":"example@example.fr","username":"example@example.fr","enabled":True,"firstName":"Example","lastName":"Example","attributes":{"locale":["fr"]})# User countercount_users=keycloak_admin.users_count()# Get users Returns a list of users, filtered according to query parametersusers=keycloak_admin.get_users({})# Get user ID from nameuser_id_keycloak=keycloak_admin.get_user_id("example@example.com")# Get Useruser=keycloak_admin.get_user("user-id-keycloak")# Update Userresponse=keycloak_admin.update_user(user_id="user-id-keycloak",payload={'firstName':'Example Update'})# Update User Passwordresponse=keycloak_admin.set_user_password(user_id="user-id-keycloak",password="secret",temporary=True)# Get User Credentialscredentials=keycloak_admin.get_credentials(user_id='user_id')# Get User Credential by IDcredential=keycloak_admin.get_credential(user_id='user_id',credential_id='credential_id')# Delete User Credentialresponse=keycloak_admin.delete_credential(user_id='user_id',credential_id='credential_id')# Delete Userresponse=keycloak_admin.delete_user(user_id="user-id-keycloak")# Get consents granted by the userconsents=keycloak_admin.consents_user(user_id="user-id-keycloak")# Send User Actionresponse=keycloak_admin.send_update_account(user_id="user-id-keycloak",payload=json.dumps(['UPDATE_PASSWORD']))# Send Verify Emailresponse=keycloak_admin.send_verify_email(user_id="user-id-keycloak")# Get sessions associated with the usersessions=keycloak_admin.get_sessions(user_id="user-id-keycloak")# Get themes, social providers, auth providers, and event listeners available on this serverserver_info=keycloak_admin.get_server_info()# Get clients belonging to the realm Returns a list of clients belonging to the realmclients=keycloak_admin.get_clients()# Get client - id (not client-id) from client by nameclient_id=keycloak_admin.get_client_id("my-client")# Get representation of the client - id of client (not client-id)client=keycloak_admin.get_client(client_id="client_id")# Get all roles for the realm or clientrealm_roles=keycloak_admin.get_realm_roles()# Get all roles for the clientclient_roles=keycloak_admin.get_client_roles(client_id="client_id")# Get client rolerole=keycloak_admin.get_client_role(client_id="client_id",role_name="role_name")# Warning: Deprecated# Get client role id from namerole_id=keycloak_admin.get_client_role_id(client_id="client_id",role_name="test")# Create client rolekeycloak_admin.create_client_role(client_role_id='client_id',{'name':'roleName','clientRole':True})# Assign client role to user. Note that BOTH role_name and role_id appear to be required.keycloak_admin.assign_client_role(client_id="client_id",user_id="user_id",role_id="role_id",role_name="test")# Retrieve client roles of a user.keycloak_admin.get_client_roles_of_user(user_id="user_id",client_id="client_id")# Retrieve available client roles of a user.keycloak_admin.get_available_client_roles_of_user(user_id="user_id",client_id="client_id")# Retrieve composite client roles of a user.keycloak_admin.get_composite_client_roles_of_user(user_id="user_id",client_id="client_id")# Delete client roles of a user.keycloak_admin.delete_client_roles_of_user(client_id="client_id",user_id="user_id",roles={"id":"role-id"})keycloak_admin.delete_client_roles_of_user(client_id="client_id",user_id="user_id",roles=[{"id":"role-id_1"},{"id":"role-id_2"}])# Get all client authorization resourcesclient_resources=get_client_authz_resources(client_id="client_id")# Get all client authorization scopesclient_scopes=get_client_authz_scopes(client_id="client_id")# Get all client authorization permissionsclient_permissions=get_client_authz_permissions(client_id="client_id")# Get all client authorization policiesclient_policies=get_client_authz_policies(client_id="client_id")# Create new groupgroup=keycloak_admin.create_group({"name":"Example Group"})# Get all groupsgroups=keycloak_admin.get_groups()# Get groupgroup=keycloak_admin.get_group(group_id='group_id')# Get group by namegroup=keycloak_admin.get_group_by_path(path='/group/subgroup',search_in_subgroups=True)# Function to trigger user sync from providersync_users(storage_id="storage_di",action="action")# Get client role id from namerole_id=keycloak_admin.get_client_role_id(client_id=client_id,role_name="test")# Get all roles for the realm or clientrealm_roles=keycloak_admin.get_roles()# Assign client role to user. Note that BOTH role_name and role_id appear to be required.keycloak_admin.assign_client_role(client_id=client_id,user_id=user_id,role_id=role_id,role_name="test")# Assign realm roles to userkeycloak_admin.assign_realm_roles(user_id=user_id,roles=realm_roles)# Get all ID Providersidps=keycloak_admin.get_idps()# Create a new Realmkeycloak_admin.create_realm(payload={"realm":"demo"},skip_exists=False)