admin = KeycloakAdmin(
server_url="http://localhost:8080/",
username='example-admin',
password='secret',
realm_name="master",
user_realm_name="only_if_other_realm_than_master")from keycloak import KeycloakAdmin
from keycloak import KeycloakOpenIDConnection
keycloak_connection = KeycloakOpenIDConnection(
server_url="http://localhost:8080/",
username='example-admin',
password='secret',
realm_name="master",
user_realm_name="only_if_other_realm_than_master",
client_id="my_client",
client_secret_key="client-secret",
verify=True)
keycloak_admin = KeycloakAdmin(connection=keycloak_connection)new_user = keycloak_admin.create_user({"email": "example@example.com",
"username": "example@example.com",
"enabled": True,
"firstName": "Example",
"lastName": "Example"})The exist_ok currently defaults to True for backwards compatibility reasons.
new_user = keycloak_admin.create_user({"email": "example@example.com",
"username": "example@example.com",
"enabled": True,
"firstName": "Example",
"lastName": "Example"},
exist_ok=False)new_user = keycloak_admin.create_user({"email": "example@example.com",
"username": "example@example.com",
"enabled": True,
"firstName": "Example",
"lastName": "Example",
"credentials": [{"value": "secret","type": "password",}]})new_user = keycloak_admin.create_user({"email": "example@example.fr",
"username": "example@example.fr",
"enabled": True,
"firstName": "Example",
"lastName": "Example",
"attributes": {
"locale": ["fr"]
}})count_users = keycloak_admin.users_count()users = keycloak_admin.get_users({})user_id_keycloak = keycloak_admin.get_user_id("username-keycloak")user = keycloak_admin.get_user("user-id-keycloak")response = keycloak_admin.update_user(user_id="user-id-keycloak",
payload={'firstName': 'Example Update'})response = keycloak_admin.set_user_password(user_id="user-id-keycloak", password="secret", temporary=True)credentials = keycloak_admin.get_credentials(user_id='user_id')credential = keycloak_admin.get_credential(user_id='user_id', credential_id='credential_id')response = keycloak_admin.delete_credential(user_id='user_id', credential_id='credential_id')response = keycloak_admin.delete_user(user_id="user-id-keycloak")consents = keycloak_admin.consents_user(user_id="user-id-keycloak")response = keycloak_admin.send_update_account(user_id="user-id-keycloak",
payload=['UPDATE_PASSWORD'])response = keycloak_admin.send_verify_email(user_id="user-id-keycloak")sessions = keycloak_admin.get_sessions(user_id="user-id-keycloak")