Skip to content

Commit 0fd1cd6

Browse files
committed
docs: fixed docs for get_client_role
1 parent b37edc8 commit 0fd1cd6

1 file changed

Lines changed: 6 additions & 13 deletions

File tree

src/keycloak/keycloak_admin.py

Lines changed: 6 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -2129,9 +2129,7 @@ def get_client_roles(self, client_id, brief_representation=True):
21292129
return raise_error_from_response(data_raw, KeycloakGetError)
21302130

21312131
def get_client_role(self, client_id, role_name):
2132-
"""Get client role id by name.
2133-
2134-
This is required for further actions with this role.
2132+
"""Get client role by name.
21352133
21362134
RoleRepresentation
21372135
https://www.keycloak.org/docs-api/24.0.2/rest-api/index.html#_rolerepresentation
@@ -2140,8 +2138,8 @@ def get_client_role(self, client_id, role_name):
21402138
:type client_id: str
21412139
:param role_name: role's name (not id!)
21422140
:type role_name: str
2143-
:return: role_id
2144-
:rtype: str
2141+
:return: Role object
2142+
:rtype: dict
21452143
"""
21462144
params_path = {
21472145
"realm-name": self.connection.realm_name,
@@ -6453,19 +6451,14 @@ async def a_get_client_roles(self, client_id, brief_representation=True):
64536451
return raise_error_from_response(data_raw, KeycloakGetError)
64546452

64556453
async def a_get_client_role(self, client_id, role_name):
6456-
"""Get client role id by name asynchronously.
6457-
6458-
This is required for further actions with this role.
6459-
6460-
RoleRepresentation
6461-
https://www.keycloak.org/docs-api/24.0.2/rest-api/index.html#_rolerepresentation
6454+
"""Get client role by name asynchronously.
64626455
64636456
:param client_id: id of client (not client-id)
64646457
:type client_id: str
64656458
:param role_name: role's name (not id!)
64666459
:type role_name: str
6467-
:return: role_id
6468-
:rtype: str
6460+
:return: Role object
6461+
:rtype: dict
64696462
"""
64706463
params_path = {
64716464
"realm-name": self.connection.realm_name,

0 commit comments

Comments
 (0)