Browse Source

docs: fixed docs for get_client_role

pull/627/head
Richard Nemeth 1 week ago
parent
commit
0fd1cd663a
No known key found for this signature in database GPG Key ID: 21C39470DF3DEC39
  1. 19
      src/keycloak/keycloak_admin.py

19
src/keycloak/keycloak_admin.py

@ -2129,9 +2129,7 @@ class KeycloakAdmin:
return raise_error_from_response(data_raw, KeycloakGetError) return raise_error_from_response(data_raw, KeycloakGetError)
def get_client_role(self, client_id, role_name): def get_client_role(self, client_id, role_name):
"""Get client role id by name.
This is required for further actions with this role.
"""Get client role by name.
RoleRepresentation RoleRepresentation
https://www.keycloak.org/docs-api/24.0.2/rest-api/index.html#_rolerepresentation https://www.keycloak.org/docs-api/24.0.2/rest-api/index.html#_rolerepresentation
@ -2140,8 +2138,8 @@ class KeycloakAdmin:
:type client_id: str :type client_id: str
:param role_name: role's name (not id!) :param role_name: role's name (not id!)
:type role_name: str :type role_name: str
:return: role_id
:rtype: str
:return: Role object
:rtype: dict
""" """
params_path = { params_path = {
"realm-name": self.connection.realm_name, "realm-name": self.connection.realm_name,
@ -6453,19 +6451,14 @@ class KeycloakAdmin:
return raise_error_from_response(data_raw, KeycloakGetError) return raise_error_from_response(data_raw, KeycloakGetError)
async def a_get_client_role(self, client_id, role_name): async def a_get_client_role(self, client_id, role_name):
"""Get client role id by name asynchronously.
This is required for further actions with this role.
RoleRepresentation
https://www.keycloak.org/docs-api/24.0.2/rest-api/index.html#_rolerepresentation
"""Get client role by name asynchronously.
:param client_id: id of client (not client-id) :param client_id: id of client (not client-id)
:type client_id: str :type client_id: str
:param role_name: role's name (not id!) :param role_name: role's name (not id!)
:type role_name: str :type role_name: str
:return: role_id
:rtype: str
:return: Role object
:rtype: dict
""" """
params_path = { params_path = {
"realm-name": self.connection.realm_name, "realm-name": self.connection.realm_name,

Loading…
Cancel
Save