Skip to content

Commit 7863467

Browse files
Kevin-BannierKévin BANNIER
authored andcommitted
feat: Add endpoints to get/update management permissions on IdP, and
delete mapper to IdP
1 parent 5957607 commit 7863467

File tree

2 files changed

+70
-1
lines changed

2 files changed

+70
-1
lines changed

src/keycloak/keycloak_admin.py

Lines changed: 69 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@
2929
import copy
3030
import json
3131
from builtins import isinstance
32-
from typing import Optional
32+
from typing import Any, Dict, Optional
3333

3434
import deprecation
3535
from requests_toolbelt import MultipartEncoder
@@ -739,6 +739,23 @@ def update_mapper_in_idp(self, idp_alias, mapper_id, payload):
739739

740740
return raise_error_from_response(data_raw, KeycloakPutError, expected_codes=[204])
741741

742+
def delete_mapper_to_idp(self, idp_alias: str, mapper_id: str) -> Dict[str, Any]:
743+
"""Delete an IDP mapper.
744+
745+
IdentityProviderRepresentation
746+
https://www.keycloak.org/docs-api/22.0.5/rest-api/index.html#_identityprovidermapperrepresentation
747+
748+
:param: idp_alias: alias for Idp to add mapper in
749+
:param: payload: IdentityProviderMapperRepresentation
750+
"""
751+
params_path = {
752+
"realm-name": self.connection.realm_name, # type:ignore
753+
"idp-alias": idp_alias,
754+
"mapper-id": mapper_id,
755+
}
756+
data_raw = self.raw_delete(urls_patterns.URL_ADMIN_IDP_MAPPER_UPDATE.format(**params_path))
757+
return raise_error_from_response(data_raw, KeycloakDeleteError, expected_codes=[204])
758+
742759
def get_idp_mappers(self, idp_alias):
743760
"""Get IDP mappers.
744761
@@ -785,6 +802,57 @@ def delete_idp(self, idp_alias):
785802
data_raw = self.connection.raw_delete(urls_patterns.URL_ADMIN_IDP.format(**params_path))
786803
return raise_error_from_response(data_raw, KeycloakDeleteError, expected_codes=[204])
787804

805+
def get_idp_management_permissions(self, idp_alias: str) -> Dict[str, Any]:
806+
"""
807+
Get management permissions for a client.
808+
809+
ManagementPermissionReference
810+
https://www.keycloak.org/docs-api/22.0.5/rest-api/index.html#_managementpermissionreference
811+
812+
:param: idp_alias: idp alias name
813+
:type idp_alias: str
814+
:return: Keycloak server response
815+
"""
816+
params_path = {
817+
"realm-name": self.connection.realm_name, # type:ignore
818+
"alias": idp_alias,
819+
}
820+
data_raw = self.raw_get(
821+
urls_patterns.URL_ADMIN_IDP_MANAGEMENT_PERMISSIONS.format(**params_path)
822+
)
823+
return raise_error_from_response(data_raw, KeycloakGetError, expected_codes=[200])
824+
825+
def update_idp_management_permissions(
826+
self, idp_alias: str, payload: Dict[str, Any]
827+
) -> Dict[str, Any]:
828+
"""
829+
Update management permissions for a client.
830+
831+
ManagementPermissionReference
832+
https://www.keycloak.org/docs-api/22.0.5/rest-api/index.html#_managementpermissionreference
833+
834+
:param: idp_alias: idp alias name
835+
:type idp_alias: str
836+
:param payload: ManagementPermissionReference
837+
:return: Keycloak server response
838+
839+
840+
Payload example::
841+
842+
payload={
843+
"enabled": true
844+
}
845+
"""
846+
params_path = {
847+
"realm-name": self.connection.realm_name, # type:ignore
848+
"alias": idp_alias,
849+
}
850+
data_raw = self.raw_put(
851+
urls_patterns.URL_ADMIN_IDP_MANAGEMENT_PERMISSIONS.format(**params_path),
852+
data=json.dumps(payload),
853+
)
854+
return raise_error_from_response(data_raw, KeycloakPutError, expected_codes=[200])
855+
788856
def create_user(self, payload, exist_ok=False):
789857
"""Create a new user.
790858

src/keycloak/urls_patterns.py

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -147,6 +147,7 @@
147147
URL_ADMIN_IDP_MAPPERS = "admin/realms/{realm-name}/identity-provider/instances/{idp-alias}/mappers"
148148
URL_ADMIN_IDP_MAPPER_UPDATE = URL_ADMIN_IDP_MAPPERS + "/{mapper-id}"
149149
URL_ADMIN_IDP = "admin/realms/{realm-name}/identity-provider/instances/{alias}"
150+
URL_ADMIN_IDP_MANAGEMENT_PERMISSIONS = URL_ADMIN_IDP + "/management/permissions"
150151
URL_ADMIN_REALM_ROLES_ROLE_BY_NAME = "admin/realms/{realm-name}/roles/{role-name}"
151152
URL_ADMIN_REALM_ROLES_COMPOSITE_REALM_ROLE = (
152153
"admin/realms/{realm-name}/roles/{role-name}/composites"

0 commit comments

Comments
 (0)