| Name | python-keycloak-async JSON |
| Version |
2.17.1
JSON |
| download |
| home_page | |
| Summary | python-keycloak-async is a Python package providing access to the Keycloak API. |
| upload_time | 2023-05-16 03:01:51 |
| maintainer | |
| docs_url | None |
| author | Quang Phan |
| requires_python | >=3.9,<4.0 |
| license | MIT |
| keywords |
keycloak
asyncio
openid
oidc
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# Python Keycloak Async
For review- see https://github.com/quangpq/python-keycloak-async
**python-keycloak-async** is a Python package providing access to the Keycloak API.
## Installation
### Via Pypi Package:
`$ pip install python-keycloak-async`
### Manually
`$ python setup.py install`
## Dependencies
python-keycloak-async depends on:
- Python 3
- [httpx](https://www.python-httpx.org/)
- [aiofiles](https://github.com/Tinche/aiofiles)
- [python-jose](http://python-jose.readthedocs.io/en/latest/)
### Tests Dependencies
- [tox](https://tox.readthedocs.io/)
- [pytest](https://docs.pytest.org/en/latest/)
- [pytest-asyncio](https://pytest-asyncio.readthedocs.io/en/latest/)
- [pytest-cov](https://github.com/pytest-dev/pytest-cov)
- [wheel](https://github.com/pypa/wheel)
## Bug reports
Please report bugs and feature requests at
https://github.com/quangpq/python-keycloak-async/issues
## Contributors
- [Agriness Team](http://www.agriness.com/pt/)
- [Marcos Pereira](marcospereira.mpj@gmail.com)
- [Martin Devlin](https://bitbucket.org/devlinmpearson/)
- [Shon T. Urbas](https://bitbucket.org/surbas/)
- [Markus Spanier](https://bitbucket.org/spanierm/)
- [Remco Kranenburg](https://bitbucket.org/Remco47/)
- [Armin](https://bitbucket.org/arminfelder/)
- [njordr](https://bitbucket.org/njordr/)
- [Josha Inglis](https://bitbucket.org/joshainglis/)
- [Alex](https://bitbucket.org/alex_zel/)
- [Ewan Jone](https://bitbucket.org/kisamoto/)
- [Lukas Martini](https://github.com/lutoma)
- [Adamatics](https://www.adamatics.com)
## Usage
```python
from keycloak import KeycloakOpenID
# Configure client
keycloak_openid = KeycloakOpenID(server_url="http://localhost:8080/auth/",
client_id="example_client",
realm_name="example_realm",
client_secret_key="secret")
# Close connection
await keycloak_openid.aclose()
# or using context manager
async with KeycloakOpenID(
server_url=f"http://localhost:8080/",
realm_name="example_client",
client_id="example_realm",
client_secret_key="secret",
) as keycloak_openid:
pass
# Get WellKnown
config_well_known = await keycloak_openid.well_known()
# Get Code With Oauth Authorization Request
auth_url = keycloak_openid.auth_url(
redirect_uri="your_call_back_url",
scope="email",
state="your_state_info")
# Get Access Token With Code
access_token = keycloak_openid.token(
grant_type='authorization_code',
code='the_code_you_get_from_auth_url_callback',
redirect_uri="your_call_back_url")
# Get Token
token = await keycloak_openid.token("user", "password")
token = await keycloak_openid.token("user", "password", totp="012345")
# Get token using Token Exchange
token = await keycloak_openid.exchange_token(token['access_token'], "my_client", "other_client", "some_user")
# Get Userinfo
userinfo = await keycloak_openid.userinfo(token['access_token'])
# Refresh token
token = await keycloak_openid.refresh_token(token['refresh_token'])
# Logout
await keycloak_openid.logout(token['refresh_token'])
# Get Certs
certs = await keycloak_openid.certs()
# Get RPT (Entitlement)
token = await keycloak_openid.token("user", "password")
rpt = await keycloak_openid.entitlement(token['access_token'], "resource_id")
# Introspect RPT
token_rpt_info = await keycloak_openid.introspect(token['access_token'],
rpt=rpt['rpt'],
token_type_hint="requesting_party_token")
# Introspect Token
token_info = await keycloak_openid.introspect(token['access_token'])
# Decode Token
KEYCLOAK_PUBLIC_KEY = "-----BEGIN PUBLIC KEY-----\n" + await 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 token
token = await keycloak_openid.token("user", "password")
await keycloak_openid.load_authorization_config("example-authz-config.json")
policies = await keycloak_openid.get_policies(token['access_token'], method_token_info='decode', key=KEYCLOAK_PUBLIC_KEY)
permissions = await keycloak_openid.get_permissions(token['access_token'], method_token_info='introspect')
# Get UMA-permissions by token
token = await keycloak_openid.token("user", "password")
permissions = await keycloak_openid.uma_permissions(token['access_token'])
# Get UMA-permissions by token with specific resource and scope requested
token = await keycloak_openid.token("user", "password")
permissions = await keycloak_openid.uma_permissions(token['access_token'], permissions="Resource#Scope")
# Get auth status for a specific resource and scope by token
token = await keycloak_openid.token("user", "password")
auth_status = await keycloak_openid.has_uma_access(token['access_token'], "Resource#Scope")
# KEYCLOAK ADMIN
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)
# Fetch admin token
await keycloak_admin.init_token()
# Close connection
await keycloak_admin.aclose()
# or using context manager
async with KeycloakAdmin(connection=keycloak_connection) as keycloak_admin:
pass
# Add user
new_user = await 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 reasons
new_user = await 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 password
new_user = await 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 locale
new_user = await keycloak_admin.create_user({"email": "example@example.fr",
"username": "example@example.fr",
"enabled": True,
"firstName": "Example",
"lastName": "Example",
"attributes": {
"locale": ["fr"]
}})
# User counter
count_users = await keycloak_admin.users_count()
# Get users Returns a list of users, filtered according to query parameters
users = await keycloak_admin.get_users({})
# Get user ID from username
user_id = await keycloak_admin.get_user_id("username-keycloak")
# Get User
user = await keycloak_admin.get_user("user-id-keycloak")
# Update User
response = await keycloak_admin.update_user(user_id="user-id-keycloak",
payload={'firstName': 'Example Update'})
# Update User Password
response = await keycloak_admin.set_user_password(user_id="user-id-keycloak", password="secret", temporary=True)
# Get User Credentials
credentials = await keycloak_admin.get_credentials(user_id='user_id')
# Get User Credential by ID
credential = await keycloak_admin.get_credential(user_id='user_id', credential_id='credential_id')
# Delete User Credential
response = await keycloak_admin.delete_credential(user_id='user_id', credential_id='credential_id')
# Delete User
response = await keycloak_admin.delete_user(user_id="user-id-keycloak")
# Get consents granted by the user
consents = await keycloak_admin.user_consents(user_id="user-id-keycloak")
# Send User Action
response = await keycloak_admin.send_update_account(user_id="user-id-keycloak",
payload=['UPDATE_PASSWORD'])
# Send Verify Email
response = await keycloak_admin.send_verify_email(user_id="user-id-keycloak")
# Get sessions associated with the user
sessions = await keycloak_admin.get_sessions(user_id="user-id-keycloak")
# Get themes, social providers, auth providers, and event listeners available on this server
server_info = await keycloak_admin.get_server_info()
# Get clients belonging to the realm Returns a list of clients belonging to the realm
clients = await keycloak_admin.get_clients()
# Get client - id (not client-id) from client by name
client_id = await keycloak_admin.get_client_id("my-client")
# Get representation of the client - id of client (not client-id)
client = await keycloak_admin.get_client(client_id="client_id")
# Get all roles for the realm or client
realm_roles = await keycloak_admin.get_realm_roles()
# Get all roles for the client
client_roles = await keycloak_admin.get_client_roles(client_id="client_id")
# Get client role
role = await keycloak_admin.get_client_role(client_id="client_id", role_name="role_name")
# Warning: Deprecated
# Get client role id from name
role_id = await keycloak_admin.get_client_role_id(client_id="client_id", role_name="test")
# Create client role
await keycloak_admin.create_client_role(client_role_id='client_id', payload={'name': 'roleName', 'clientRole': True})
# Assign client role to user. Note that BOTH role_name and role_id appear to be required.
await 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.
await keycloak_admin.get_client_roles_of_user(user_id="user_id", client_id="client_id")
# Retrieve available client roles of a user.
await keycloak_admin.get_available_client_roles_of_user(user_id="user_id", client_id="client_id")
# Retrieve composite client roles of a user.
await keycloak_admin.get_composite_client_roles_of_user(user_id="user_id", client_id="client_id")
# Delete client roles of a user.
await keycloak_admin.delete_client_roles_of_user(client_id="client_id", user_id="user_id", roles={"id": "role-id"})
await 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 the client authorization settings
client_authz_settings = await keycloak_admin.get_client_authz_settings(client_id="client_id")
# Get all client authorization resources
client_resources = await keycloak_admin.get_client_authz_resources(client_id="client_id")
# Get all client authorization scopes
client_scopes = await keycloak_admin.get_client_authz_scopes(client_id="client_id")
# Get all client authorization permissions
client_permissions = await keycloak_admin.get_client_authz_permissions(client_id="client_id")
# Get all client authorization policies
client_policies = await keycloak_admin.get_client_authz_policies(client_id="client_id")
# Create new group
group = await keycloak_admin.create_group({"name": "Example Group"})
# Get all groups
groups = await keycloak_admin.get_groups()
# Get group
group = await keycloak_admin.get_group(group_id='group_id')
# Get group by name
group = await keycloak_admin.get_group_by_path(path='/group/subgroup', search_in_subgroups=True)
# Function to trigger user sync from provider
await keycloak_admin.sync_users(storage_id="storage_di", action="action")
# Get client role id from name
role_id = await keycloak_admin.get_client_role_id(client_id=client_id, role_name="test")
# Assign client role to user. Note that BOTH role_name and role_id appear to be required.
await keycloak_admin.assign_client_role(client_id=client_id, user_id=user_id, role_id=role_id, role_name="test")
# Assign realm roles to user
await keycloak_admin.assign_realm_roles(user_id=user_id, roles=realm_roles)
# Assign realm roles to client's scope
await keycloak_admin.assign_realm_roles_to_client_scope(client_id=client_id, roles=realm_roles)
# Get realm roles assigned to client's scope
await keycloak_admin.get_realm_roles_of_client_scope(client_id=client_id)
# Remove realm roles assigned to client's scope
await keycloak_admin.delete_realm_roles_of_client_scope(client_id=client_id, roles=realm_roles)
another_client_id = await keycloak_admin.get_client_id("my-client-2")
# Assign client roles to client's scope
await keycloak_admin.assign_client_roles_to_client_scope(client_id=another_client_id, client_roles_owner_id=client_id,
roles=client_roles)
# Get client roles assigned to client's scope
await keycloak_admin.get_client_roles_of_client_scope(client_id=another_client_id, client_roles_owner_id=client_id)
# Remove client roles assigned to client's scope
await keycloak_admin.delete_client_roles_of_client_scope(client_id=another_client_id, client_roles_owner_id=client_id,
roles=client_roles)
# Get all ID Providers
idps = await keycloak_admin.get_idps()
# Create a new Realm
await keycloak_admin.create_realm(payload={"realm": "demo"}, skip_exists=False)
# Changing Realm
keycloak_admin = KeycloakAdmin(realm_name="main", ...)
await keycloak_admin.get_users() # Get user in main realm
keycloak_admin.realm_name = "demo" # Change realm to 'demo'
await keycloak_admin.get_users() # Get users in realm 'demo'
await keycloak_admin.create_user(...) # Creates a new user in 'demo'
# KEYCLOAK UMA
from keycloak import KeycloakOpenIDConnection
from keycloak import KeycloakUMA
keycloak_connection = KeycloakOpenIDConnection(
server_url="http://localhost:8080/",
realm_name="master",
client_id="my_client",
client_secret_key="client-secret")
keycloak_uma = KeycloakUMA(connection=keycloak_connection)
# Fetch admin token
await keycloak_uma.init_token()
# Close connection
await keycloak_uma.aclose()
# or using context manager
async with KeycloakUMA(connection=keycloak_connection) as keycloak_uma:
pass
# Create a resource set
resource_set = await keycloak_uma.resource_set_create({
"name": "example_resource",
"scopes": ["example:read", "example:write"],
"type": "urn:example"})
# List resource sets
resource_sets = [x async for x in keycloak_uma.resource_set_list()]
# get resource set
latest_resource = await keycloak_uma.resource_set_read(resource_set["_id"])
# update resource set
latest_resource["name"] = "New Resource Name"
await keycloak_uma.resource_set_update(resource_set["_id"], latest_resource)
# delete resource set
await keycloak_uma.resource_set_delete(resource_id=resource_set["_id"])
```
Raw data
{
"_id": null,
"home_page": "",
"name": "python-keycloak-async",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.9,<4.0",
"maintainer_email": "",
"keywords": "keycloak,asyncio,openid,oidc",
"author": "Quang Phan",
"author_email": "quangpq.uit@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/db/5c/da8288220c7cf53e7a077f6a17a1bfe4e1a1869e4b441a4c0f57917cf3f2/python_keycloak_async-2.17.1.tar.gz",
"platform": null,
"description": "# Python Keycloak Async\n\nFor review- see https://github.com/quangpq/python-keycloak-async\n\n**python-keycloak-async** is a Python package providing access to the Keycloak API.\n\n## Installation\n\n### Via Pypi Package:\n\n`$ pip install python-keycloak-async`\n\n### Manually\n\n`$ python setup.py install`\n\n## Dependencies\n\npython-keycloak-async depends on:\n\n- Python 3\n- [httpx](https://www.python-httpx.org/)\n- [aiofiles](https://github.com/Tinche/aiofiles)\n- [python-jose](http://python-jose.readthedocs.io/en/latest/)\n\n### Tests Dependencies\n\n- [tox](https://tox.readthedocs.io/)\n- [pytest](https://docs.pytest.org/en/latest/)\n- [pytest-asyncio](https://pytest-asyncio.readthedocs.io/en/latest/)\n- [pytest-cov](https://github.com/pytest-dev/pytest-cov)\n- [wheel](https://github.com/pypa/wheel)\n\n## Bug reports\n\nPlease report bugs and feature requests at\nhttps://github.com/quangpq/python-keycloak-async/issues\n\n## Contributors\n\n- [Agriness Team](http://www.agriness.com/pt/)\n- [Marcos Pereira](marcospereira.mpj@gmail.com)\n- [Martin Devlin](https://bitbucket.org/devlinmpearson/)\n- [Shon T. Urbas](https://bitbucket.org/surbas/)\n- [Markus Spanier](https://bitbucket.org/spanierm/)\n- [Remco Kranenburg](https://bitbucket.org/Remco47/)\n- [Armin](https://bitbucket.org/arminfelder/)\n- [njordr](https://bitbucket.org/njordr/)\n- [Josha Inglis](https://bitbucket.org/joshainglis/)\n- [Alex](https://bitbucket.org/alex_zel/)\n- [Ewan Jone](https://bitbucket.org/kisamoto/)\n- [Lukas Martini](https://github.com/lutoma)\n- [Adamatics](https://www.adamatics.com)\n\n## Usage\n\n```python\nfrom keycloak import KeycloakOpenID\n\n# Configure client\nkeycloak_openid = KeycloakOpenID(server_url=\"http://localhost:8080/auth/\",\n client_id=\"example_client\",\n realm_name=\"example_realm\",\n client_secret_key=\"secret\")\n# Close connection\nawait keycloak_openid.aclose()\n# or using context manager\nasync with KeycloakOpenID(\n server_url=f\"http://localhost:8080/\",\n realm_name=\"example_client\",\n client_id=\"example_realm\",\n client_secret_key=\"secret\",\n) as keycloak_openid:\n pass\n\n# Get WellKnown\nconfig_well_known = await keycloak_openid.well_known()\n\n# Get Code With Oauth Authorization Request\nauth_url = keycloak_openid.auth_url(\n redirect_uri=\"your_call_back_url\",\n scope=\"email\",\n state=\"your_state_info\")\n\n# Get Access Token With Code\naccess_token = keycloak_openid.token(\n grant_type='authorization_code',\n code='the_code_you_get_from_auth_url_callback',\n redirect_uri=\"your_call_back_url\")\n\n# Get Token\ntoken = await keycloak_openid.token(\"user\", \"password\")\ntoken = await keycloak_openid.token(\"user\", \"password\", totp=\"012345\")\n\n# Get token using Token Exchange\ntoken = await keycloak_openid.exchange_token(token['access_token'], \"my_client\", \"other_client\", \"some_user\")\n\n# Get Userinfo\nuserinfo = await keycloak_openid.userinfo(token['access_token'])\n\n# Refresh token\ntoken = await keycloak_openid.refresh_token(token['refresh_token'])\n\n# Logout\nawait keycloak_openid.logout(token['refresh_token'])\n\n# Get Certs\ncerts = await keycloak_openid.certs()\n\n# Get RPT (Entitlement)\ntoken = await keycloak_openid.token(\"user\", \"password\")\nrpt = await keycloak_openid.entitlement(token['access_token'], \"resource_id\")\n\n# Introspect RPT\ntoken_rpt_info = await keycloak_openid.introspect(token['access_token'],\n rpt=rpt['rpt'],\n token_type_hint=\"requesting_party_token\")\n\n# Introspect Token\ntoken_info = await keycloak_openid.introspect(token['access_token'])\n\n# Decode Token\nKEYCLOAK_PUBLIC_KEY = \"-----BEGIN PUBLIC KEY-----\\n\" + await keycloak_openid.public_key() + \"\\n-----END PUBLIC KEY-----\"\noptions = {\"verify_signature\": True, \"verify_aud\": True, \"verify_exp\": True}\ntoken_info = keycloak_openid.decode_token(token['access_token'], key=KEYCLOAK_PUBLIC_KEY, options=options)\n\n# Get permissions by token\ntoken = await keycloak_openid.token(\"user\", \"password\")\nawait keycloak_openid.load_authorization_config(\"example-authz-config.json\")\npolicies = await keycloak_openid.get_policies(token['access_token'], method_token_info='decode', key=KEYCLOAK_PUBLIC_KEY)\npermissions = await keycloak_openid.get_permissions(token['access_token'], method_token_info='introspect')\n\n# Get UMA-permissions by token\ntoken = await keycloak_openid.token(\"user\", \"password\")\npermissions = await keycloak_openid.uma_permissions(token['access_token'])\n\n# Get UMA-permissions by token with specific resource and scope requested\ntoken = await keycloak_openid.token(\"user\", \"password\")\npermissions = await keycloak_openid.uma_permissions(token['access_token'], permissions=\"Resource#Scope\")\n\n# Get auth status for a specific resource and scope by token\ntoken = await keycloak_openid.token(\"user\", \"password\")\nauth_status = await keycloak_openid.has_uma_access(token['access_token'], \"Resource#Scope\")\n\n# KEYCLOAK ADMIN\n\nfrom keycloak import KeycloakAdmin\nfrom keycloak import KeycloakOpenIDConnection\n\nkeycloak_connection = KeycloakOpenIDConnection(\n server_url=\"http://localhost:8080/\",\n username='example-admin',\n password='secret',\n realm_name=\"master\",\n user_realm_name=\"only_if_other_realm_than_master\",\n client_id=\"my_client\",\n client_secret_key=\"client-secret\",\n verify=True)\n\nkeycloak_admin = KeycloakAdmin(connection=keycloak_connection)\n# Fetch admin token\nawait keycloak_admin.init_token()\n# Close connection\nawait keycloak_admin.aclose()\n# or using context manager\nasync with KeycloakAdmin(connection=keycloak_connection) as keycloak_admin:\n pass\n\n# Add user\nnew_user = await keycloak_admin.create_user({\"email\": \"example@example.com\",\n \"username\": \"example@example.com\",\n \"enabled\": True,\n \"firstName\": \"Example\",\n \"lastName\": \"Example\"})\n\n# Add user and raise exception if username already exists\n# exist_ok currently defaults to True for backwards compatibility reasons\nnew_user = await keycloak_admin.create_user({\"email\": \"example@example.com\",\n \"username\": \"example@example.com\",\n \"enabled\": True,\n \"firstName\": \"Example\",\n \"lastName\": \"Example\"},\n exist_ok=False)\n\n# Add user and set password\nnew_user = await keycloak_admin.create_user({\"email\": \"example@example.com\",\n \"username\": \"example@example.com\",\n \"enabled\": True,\n \"firstName\": \"Example\",\n \"lastName\": \"Example\",\n \"credentials\": [{\"value\": \"secret\", \"type\": \"password\", }]})\n\n# Add user and specify a locale\nnew_user = await keycloak_admin.create_user({\"email\": \"example@example.fr\",\n \"username\": \"example@example.fr\",\n \"enabled\": True,\n \"firstName\": \"Example\",\n \"lastName\": \"Example\",\n \"attributes\": {\n \"locale\": [\"fr\"]\n }})\n\n# User counter\ncount_users = await keycloak_admin.users_count()\n\n# Get users Returns a list of users, filtered according to query parameters\nusers = await keycloak_admin.get_users({})\n\n# Get user ID from username\nuser_id = await keycloak_admin.get_user_id(\"username-keycloak\")\n\n# Get User\nuser = await keycloak_admin.get_user(\"user-id-keycloak\")\n\n# Update User\nresponse = await keycloak_admin.update_user(user_id=\"user-id-keycloak\",\n payload={'firstName': 'Example Update'})\n\n# Update User Password\nresponse = await keycloak_admin.set_user_password(user_id=\"user-id-keycloak\", password=\"secret\", temporary=True)\n\n# Get User Credentials\ncredentials = await keycloak_admin.get_credentials(user_id='user_id')\n\n# Get User Credential by ID\ncredential = await keycloak_admin.get_credential(user_id='user_id', credential_id='credential_id')\n\n# Delete User Credential\nresponse = await keycloak_admin.delete_credential(user_id='user_id', credential_id='credential_id')\n\n# Delete User\nresponse = await keycloak_admin.delete_user(user_id=\"user-id-keycloak\")\n\n# Get consents granted by the user\nconsents = await keycloak_admin.user_consents(user_id=\"user-id-keycloak\")\n\n# Send User Action\nresponse = await keycloak_admin.send_update_account(user_id=\"user-id-keycloak\",\n payload=['UPDATE_PASSWORD'])\n\n# Send Verify Email\nresponse = await keycloak_admin.send_verify_email(user_id=\"user-id-keycloak\")\n\n# Get sessions associated with the user\nsessions = await keycloak_admin.get_sessions(user_id=\"user-id-keycloak\")\n\n# Get themes, social providers, auth providers, and event listeners available on this server\nserver_info = await keycloak_admin.get_server_info()\n\n# Get clients belonging to the realm Returns a list of clients belonging to the realm\nclients = await keycloak_admin.get_clients()\n\n# Get client - id (not client-id) from client by name\nclient_id = await keycloak_admin.get_client_id(\"my-client\")\n\n# Get representation of the client - id of client (not client-id)\nclient = await keycloak_admin.get_client(client_id=\"client_id\")\n\n# Get all roles for the realm or client\nrealm_roles = await keycloak_admin.get_realm_roles()\n\n# Get all roles for the client\nclient_roles = await keycloak_admin.get_client_roles(client_id=\"client_id\")\n\n# Get client role\nrole = await keycloak_admin.get_client_role(client_id=\"client_id\", role_name=\"role_name\")\n\n# Warning: Deprecated\n# Get client role id from name\nrole_id = await keycloak_admin.get_client_role_id(client_id=\"client_id\", role_name=\"test\")\n\n# Create client role\nawait keycloak_admin.create_client_role(client_role_id='client_id', payload={'name': 'roleName', 'clientRole': True})\n\n# Assign client role to user. Note that BOTH role_name and role_id appear to be required.\nawait keycloak_admin.assign_client_role(client_id=\"client_id\", user_id=\"user_id\", role_id=\"role_id\", role_name=\"test\")\n\n# Retrieve client roles of a user.\nawait keycloak_admin.get_client_roles_of_user(user_id=\"user_id\", client_id=\"client_id\")\n\n# Retrieve available client roles of a user.\nawait keycloak_admin.get_available_client_roles_of_user(user_id=\"user_id\", client_id=\"client_id\")\n\n# Retrieve composite client roles of a user.\nawait keycloak_admin.get_composite_client_roles_of_user(user_id=\"user_id\", client_id=\"client_id\")\n\n# Delete client roles of a user.\nawait keycloak_admin.delete_client_roles_of_user(client_id=\"client_id\", user_id=\"user_id\", roles={\"id\": \"role-id\"})\nawait keycloak_admin.delete_client_roles_of_user(client_id=\"client_id\", user_id=\"user_id\",\n roles=[{\"id\": \"role-id_1\"}, {\"id\": \"role-id_2\"}])\n\n# Get the client authorization settings\nclient_authz_settings = await keycloak_admin.get_client_authz_settings(client_id=\"client_id\")\n\n# Get all client authorization resources\nclient_resources = await keycloak_admin.get_client_authz_resources(client_id=\"client_id\")\n\n# Get all client authorization scopes\nclient_scopes = await keycloak_admin.get_client_authz_scopes(client_id=\"client_id\")\n\n# Get all client authorization permissions\nclient_permissions = await keycloak_admin.get_client_authz_permissions(client_id=\"client_id\")\n\n# Get all client authorization policies\nclient_policies = await keycloak_admin.get_client_authz_policies(client_id=\"client_id\")\n\n# Create new group\ngroup = await keycloak_admin.create_group({\"name\": \"Example Group\"})\n\n# Get all groups\ngroups = await keycloak_admin.get_groups()\n\n# Get group\ngroup = await keycloak_admin.get_group(group_id='group_id')\n\n# Get group by name\ngroup = await keycloak_admin.get_group_by_path(path='/group/subgroup', search_in_subgroups=True)\n\n# Function to trigger user sync from provider\nawait keycloak_admin.sync_users(storage_id=\"storage_di\", action=\"action\")\n\n# Get client role id from name\nrole_id = await keycloak_admin.get_client_role_id(client_id=client_id, role_name=\"test\")\n\n# Assign client role to user. Note that BOTH role_name and role_id appear to be required.\nawait keycloak_admin.assign_client_role(client_id=client_id, user_id=user_id, role_id=role_id, role_name=\"test\")\n\n# Assign realm roles to user\nawait keycloak_admin.assign_realm_roles(user_id=user_id, roles=realm_roles)\n\n# Assign realm roles to client's scope\nawait keycloak_admin.assign_realm_roles_to_client_scope(client_id=client_id, roles=realm_roles)\n\n# Get realm roles assigned to client's scope\nawait keycloak_admin.get_realm_roles_of_client_scope(client_id=client_id)\n\n# Remove realm roles assigned to client's scope\nawait keycloak_admin.delete_realm_roles_of_client_scope(client_id=client_id, roles=realm_roles)\n\nanother_client_id = await keycloak_admin.get_client_id(\"my-client-2\")\n\n# Assign client roles to client's scope\nawait keycloak_admin.assign_client_roles_to_client_scope(client_id=another_client_id, client_roles_owner_id=client_id,\n roles=client_roles)\n\n# Get client roles assigned to client's scope\nawait keycloak_admin.get_client_roles_of_client_scope(client_id=another_client_id, client_roles_owner_id=client_id)\n\n# Remove client roles assigned to client's scope\nawait keycloak_admin.delete_client_roles_of_client_scope(client_id=another_client_id, client_roles_owner_id=client_id,\n roles=client_roles)\n\n# Get all ID Providers\nidps = await keycloak_admin.get_idps()\n\n# Create a new Realm\nawait keycloak_admin.create_realm(payload={\"realm\": \"demo\"}, skip_exists=False)\n\n# Changing Realm\nkeycloak_admin = KeycloakAdmin(realm_name=\"main\", ...)\nawait keycloak_admin.get_users() # Get user in main realm\nkeycloak_admin.realm_name = \"demo\" # Change realm to 'demo'\nawait keycloak_admin.get_users() # Get users in realm 'demo'\nawait keycloak_admin.create_user(...) # Creates a new user in 'demo'\n\n# KEYCLOAK UMA\n\nfrom keycloak import KeycloakOpenIDConnection\nfrom keycloak import KeycloakUMA\n\nkeycloak_connection = KeycloakOpenIDConnection(\n server_url=\"http://localhost:8080/\",\n realm_name=\"master\",\n client_id=\"my_client\",\n client_secret_key=\"client-secret\")\n\nkeycloak_uma = KeycloakUMA(connection=keycloak_connection)\n# Fetch admin token\nawait keycloak_uma.init_token()\n# Close connection\nawait keycloak_uma.aclose()\n# or using context manager\nasync with KeycloakUMA(connection=keycloak_connection) as keycloak_uma:\n pass\n\n# Create a resource set\nresource_set = await keycloak_uma.resource_set_create({\n \"name\": \"example_resource\",\n \"scopes\": [\"example:read\", \"example:write\"],\n \"type\": \"urn:example\"})\n\n# List resource sets\nresource_sets = [x async for x in keycloak_uma.resource_set_list()]\n\n# get resource set\nlatest_resource = await keycloak_uma.resource_set_read(resource_set[\"_id\"])\n\n# update resource set\nlatest_resource[\"name\"] = \"New Resource Name\"\nawait keycloak_uma.resource_set_update(resource_set[\"_id\"], latest_resource)\n\n# delete resource set\nawait keycloak_uma.resource_set_delete(resource_id=resource_set[\"_id\"])\n```\n\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "python-keycloak-async is a Python package providing access to the Keycloak API.",
"version": "2.17.1",
"project_urls": {
"Documentation": "https://github.com/quangpq/python-keycloak-async",
"Issue tracker": "https://github.com/quangpq/python-keycloak-async/issues"
},
"split_keywords": [
"keycloak",
"asyncio",
"openid",
"oidc"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "590c6783f13394e5836967e6f8b33685b050649a964968df6ef6178a1e8d744e",
"md5": "0e3f34ef45455d0d7118732177eae549",
"sha256": "9f965e32f54a774700c760af26dcb2662d11c5003dbf10d0d2e2ec03c8f93a27"
},
"downloads": -1,
"filename": "python_keycloak_async-2.17.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "0e3f34ef45455d0d7118732177eae549",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.9,<4.0",
"size": 57456,
"upload_time": "2023-05-16T03:01:49",
"upload_time_iso_8601": "2023-05-16T03:01:49.138876Z",
"url": "https://files.pythonhosted.org/packages/59/0c/6783f13394e5836967e6f8b33685b050649a964968df6ef6178a1e8d744e/python_keycloak_async-2.17.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "db5cda8288220c7cf53e7a077f6a17a1bfe4e1a1869e4b441a4c0f57917cf3f2",
"md5": "22c72350dd5c6f648aace0cd64718810",
"sha256": "0715d8dcbed9c1a59e5f5f98ffdf2959a06bda9559b9657ec6cfa5ae09b3eb0e"
},
"downloads": -1,
"filename": "python_keycloak_async-2.17.1.tar.gz",
"has_sig": false,
"md5_digest": "22c72350dd5c6f648aace0cd64718810",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.9,<4.0",
"size": 45337,
"upload_time": "2023-05-16T03:01:51",
"upload_time_iso_8601": "2023-05-16T03:01:51.639552Z",
"url": "https://files.pythonhosted.org/packages/db/5c/da8288220c7cf53e7a077f6a17a1bfe4e1a1869e4b441a4c0f57917cf3f2/python_keycloak_async-2.17.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-05-16 03:01:51",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "quangpq",
"github_project": "python-keycloak-async",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"tox": true,
"lcname": "python-keycloak-async"
}
