Mirror
/
python-keycloak
mirror of https://github.com/marcospereirampj/python-keycloak.git
1
0
Fork 1
Code Issues Projects Releases Wiki Activity
Browse Source

docs: uma additions and fixes

pull/415/head
nuwang 3 years ago
parent
a0f3aaa2d2
commit
0cb41e3d01
2 changed files with 75 additions and 38 deletions
Whitespace
Show all changes Ignore whitespace when comparing lines Ignore changes in amount of whitespace Ignore changes in whitespace at EOL
Split View
Diff Options
Show Stats Download Patch File Download Diff File
  1. 53
      README.md
  2. 60
      src/keycloak/keycloak_admin.py

53
README.md
View File

@ -69,7 +69,7 @@ keycloak_openid = KeycloakOpenID(server_url="http://localhost:8080/auth/",
realm_name="example_realm",
client_secret_key="secret")
# Get WellKnow
# Get WellKnown
config_well_known = keycloak_openid.well_known()
# Get Code With Oauth Authorization Request
@ -142,14 +142,19 @@ auth_status = keycloak_openid.has_uma_access(token['access_token'], "Resource#Sc
# KEYCLOAK ADMIN
from keycloak import KeycloakAdmin
from keycloak import KeycloakOpenIDConnectionManager
keycloak_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)
keycloak_connection = KeycloakOpenIDConnectionManager(
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)
# Add user
new_user = keycloak_admin.create_user({"email": "example@example.com",
@ -344,4 +349,36 @@ keycloak_admin.get_users() # Get user in main realm
keycloak_admin.realm_name = "demo" # Change realm to 'demo'
keycloak_admin.get_users() # Get users in realm 'demo'
keycloak_admin.create_user(...) # Creates a new user in 'demo'
# KEYCLOAK UMA
from keycloak import KeycloakOpenIDConnectionManager
from keycloak import KeycloakUMA
keycloak_connection = KeycloakOpenIDConnectionManager(
server_url="http://localhost:8080/",
realm_name="master",
client_id="my_client",
client_secret_key="client-secret")
keycloak_uma = KeycloakUMA(connection=keycloak_connection)
# Create a resource set
resource_set = keycloak_uma.resource_set_create({
"name": "example_resource",
"scopes": ["example:read", "example:write"],
"type": "urn:example"})
# List resource sets
resource_sets = uma.resource_set_list()
# get resource set
latest_resource = uma.resource_set_read(resource_set["_id"])
# update resource set
latest_resource["name"] = "New Resource Name"
uma.resource_set_update(resource_set["_id"], latest_resource)
# delete resource set
uma.resource_set_delete(resource_id=resource_set["_id"])
```

60
src/keycloak/keycloak_admin.py
View File

@ -156,7 +156,7 @@ class KeycloakAdmin:
deprecated_in="2.13.0",
removed_in="3.0.0",
current_version=__version__,
details="Use the self.connection.server_url property instead",
details="Use the connection.server_url property instead",
)
def server_url(self):
"""Get server url.
@ -171,7 +171,7 @@ class KeycloakAdmin:
deprecated_in="2.13.0",
removed_in="3.0.0",
current_version=__version__,
details="Use the self.connection.server_url property instead",
details="Use the connection.server_url property instead",
)
def server_url(self, value):
self.connection.server_url = value
@ -181,7 +181,7 @@ class KeycloakAdmin:
deprecated_in="2.13.0",
removed_in="3.0.0",
current_version=__version__,
details="Use the self.connection.realm_name property instead",
details="Use the connection.realm_name property instead",
)
def realm_name(self):
"""Get realm name.
@ -196,7 +196,7 @@ class KeycloakAdmin:
deprecated_in="2.13.0",
removed_in="3.0.0",
current_version=__version__,
details="Use the self.connection.realm_name property instead",
details="Use the connection.realm_name property instead",
)
def realm_name(self, value):
self.connection.realm_name = value
@ -219,7 +219,7 @@ class KeycloakAdmin:
deprecated_in="2.13.0",
removed_in="3.0.0",
current_version=__version__,
details="Use the self.connection.client_id property instead",
details="Use the connection.client_id property instead",
)
def client_id(self):
"""Get client id.
@ -234,7 +234,7 @@ class KeycloakAdmin:
deprecated_in="2.13.0",
removed_in="3.0.0",
current_version=__version__,
details="Use the self.connection.client_id property instead",
details="Use the connection.client_id property instead",
)
def client_id(self, value):
self.connection.client_id = value
@ -244,7 +244,7 @@ class KeycloakAdmin:
deprecated_in="2.13.0",
removed_in="3.0.0",
current_version=__version__,
details="Use the self.connection.client_secret_key property instead",
details="Use the connection.client_secret_key property instead",
)
def client_secret_key(self):
"""Get client secret key.
@ -259,7 +259,7 @@ class KeycloakAdmin:
deprecated_in="2.13.0",
removed_in="3.0.0",
current_version=__version__,
details="Use the self.connection.client_secret_key property instead",
details="Use the connection.client_secret_key property instead",
)
def client_secret_key(self, value):
self.connection.client_secret_key = value
@ -269,7 +269,7 @@ class KeycloakAdmin:
deprecated_in="2.13.0",
removed_in="3.0.0",
current_version=__version__,
details="Use the self.connection.verify property instead",
details="Use the connection.verify property instead",
)
def verify(self):
"""Get verify.
@ -284,7 +284,7 @@ class KeycloakAdmin:
deprecated_in="2.13.0",
removed_in="3.0.0",
current_version=__version__,
details="Use the self.connection.verify property instead",
details="Use the connection.verify property instead",
)
def verify(self, value):
self.connection.verify = value
@ -294,7 +294,7 @@ class KeycloakAdmin:
deprecated_in="2.13.0",
removed_in="3.0.0",
current_version=__version__,
details="Use the self.connection.username property instead",
details="Use the connection.username property instead",
)
def username(self):
"""Get username.
@ -309,7 +309,7 @@ class KeycloakAdmin:
deprecated_in="2.13.0",
removed_in="3.0.0",
current_version=__version__,
details="Use the self.connection.username property instead",
details="Use the connection.username property instead",
)
def username(self, value):
self.connection.username = value
@ -319,7 +319,7 @@ class KeycloakAdmin:
deprecated_in="2.13.0",
removed_in="3.0.0",
current_version=__version__,
details="Use the self.connection.password property instead",
details="Use the connection.password property instead",
)
def password(self):
"""Get password.
@ -334,7 +334,7 @@ class KeycloakAdmin:
deprecated_in="2.13.0",
removed_in="3.0.0",
current_version=__version__,
details="Use the self.connection.password property instead",
details="Use the connection.password property instead",
)
def password(self, value):
self.connection.password = value
@ -344,7 +344,7 @@ class KeycloakAdmin:
deprecated_in="2.13.0",
removed_in="3.0.0",
current_version=__version__,
details="Use the self.connection.totp property instead",
details="Use the connection.totp property instead",
)
def totp(self):
"""Get totp.
@ -359,7 +359,7 @@ class KeycloakAdmin:
deprecated_in="2.13.0",
removed_in="3.0.0",
current_version=__version__,
details="Use the self.connection.totp property instead",
details="Use the connection.totp property instead",
)
def totp(self, value):
self.connection.totp = value
@ -369,7 +369,7 @@ class KeycloakAdmin:
deprecated_in="2.13.0",
removed_in="3.0.0",
current_version=__version__,
details="Use the self.connection.token property instead",
details="Use the connection.token property instead",
)
def token(self):
"""Get token.
@ -384,7 +384,7 @@ class KeycloakAdmin:
deprecated_in="2.13.0",
removed_in="3.0.0",
current_version=__version__,
details="Use the self.connection.token property instead",
details="Use the connection.token property instead",
)
def token(self, value):
self.connection.token = value
@ -394,7 +394,7 @@ class KeycloakAdmin:
deprecated_in="2.13.0",
removed_in="3.0.0",
current_version=__version__,
details="Use the self.connection.user_realm_name property instead",
details="Use the connection.user_realm_name property instead",
)
def user_realm_name(self):
"""Get user realm name.
@ -409,7 +409,7 @@ class KeycloakAdmin:
deprecated_in="2.13.0",
removed_in="3.0.0",
current_version=__version__,
details="Use the self.connection.user_realm_name property instead",
details="Use the connection.user_realm_name property instead",
)
def user_realm_name(self, value):
self.connection.user_realm_name = value
@ -419,7 +419,7 @@ class KeycloakAdmin:
deprecated_in="2.13.0",
removed_in="3.0.0",
current_version=__version__,
details="Use the self.connection.custom_headers property instead",
details="Use the connection.custom_headers property instead",
)
def custom_headers(self):
"""Get custom headers.
@ -434,7 +434,7 @@ class KeycloakAdmin:
deprecated_in="2.13.0",
removed_in="3.0.0",
current_version=__version__,
details="Use the self.connection.custom_headers property instead",
details="Use the connection.custom_headers property instead",
)
def custom_headers(self, value):
self.connection.custom_headers = value
@ -444,7 +444,7 @@ class KeycloakAdmin:
deprecated_in="2.13.0",
removed_in="3.0.0",
current_version=__version__,
details="Use the self.connection.auto_refresh_token property instead",
details="Use the connection.auto_refresh_token property instead",
)
def auto_refresh_token(self):
"""Get auto refresh token.
@ -459,7 +459,7 @@ class KeycloakAdmin:
deprecated_in="2.13.0",
removed_in="3.0.0",
current_version=__version__,
details="Use the self.connection.custom_headers property instead",
details="Use the connection.custom_headers property instead",
)
def auto_refresh_token(self, value):
self._auto_refresh_token = value or []
@ -3571,7 +3571,7 @@ class KeycloakAdmin:
deprecated_in="2.13.0",
removed_in="3.0.0",
current_version=__version__,
details="Use the self.connection.raw_get function instead",
details="Use the connection.raw_get function instead",
)
def raw_get(self, *args, **kwargs):
"""Call connection.raw_get.
@ -3592,7 +3592,7 @@ class KeycloakAdmin:
deprecated_in="2.13.0",
removed_in="3.0.0",
current_version=__version__,
details="Use the self.connection.raw_post function instead",
details="Use the connection.raw_post function instead",
)
def raw_post(self, *args, **kwargs):
"""Call connection.raw_post.
@ -3613,7 +3613,7 @@ class KeycloakAdmin:
deprecated_in="2.13.0",
removed_in="3.0.0",
current_version=__version__,
details="Use the self.connection.raw_put function instead",
details="Use the connection.raw_put function instead",
)
def raw_put(self, *args, **kwargs):
"""Call connection.raw_put.
@ -3634,7 +3634,7 @@ class KeycloakAdmin:
deprecated_in="2.13.0",
removed_in="3.0.0",
current_version=__version__,
details="Use the self.connection.raw_delete function instead",
details="Use the connection.raw_delete function instead",
)
def raw_delete(self, *args, **kwargs):
"""Call connection.raw_delete.
@ -3655,7 +3655,7 @@ class KeycloakAdmin:
deprecated_in="2.13.0",
removed_in="3.0.0",
current_version=__version__,
details="Use the self.connection.get_token function instead",
details="Use the connection.get_token function instead",
)
def get_token(self):
"""Get admin token.
@ -3671,7 +3671,7 @@ class KeycloakAdmin:
deprecated_in="2.13.0",
removed_in="3.0.0",
current_version=__version__,
details="Use the self.connection.refresh_token function instead",
details="Use the connection.refresh_token function instead",
)
def refresh_token(self):
"""Refresh the token.

Write Preview
Loading…
Cancel
Save