{"id":19830565,"url":"https://github.com/ansforge/keycloak-custom-identity-provider-mapper","last_synced_at":"2025-02-28T17:25:26.716Z","repository":{"id":217323311,"uuid":"743566584","full_name":"ansforge/keycloak-custom-identity-provider-mapper","owner":"ansforge","description":"Keycloak OIDC mapper","archived":false,"fork":false,"pushed_at":"2024-10-17T11:43:26.000Z","size":407,"stargazers_count":2,"open_issues_count":0,"forks_count":0,"subscribers_count":6,"default_branch":"main","last_synced_at":"2025-01-11T09:50:00.081Z","etag":null,"topics":["keycloak","mapper","oidc","provider"],"latest_commit_sha":null,"homepage":"","language":"Java","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/ansforge.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2024-01-15T14:07:12.000Z","updated_at":"2024-11-15T22:59:44.000Z","dependencies_parsed_at":"2024-01-15T19:24:59.820Z","dependency_job_id":"6705d559-4c47-4839-a226-cf9a690db5ab","html_url":"https://github.com/ansforge/keycloak-custom-identity-provider-mapper","commit_stats":null,"previous_names":["ansforge/keycloak-custom-identity-provider-mapper"],"tags_count":3,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ansforge%2Fkeycloak-custom-identity-provider-mapper","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ansforge%2Fkeycloak-custom-identity-provider-mapper/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ansforge%2Fkeycloak-custom-identity-provider-mapper/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ansforge%2Fkeycloak-custom-identity-provider-mapper/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/ansforge","download_url":"https://codeload.github.com/ansforge/keycloak-custom-identity-provider-mapper/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":241189974,"owners_count":19924937,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["keycloak","mapper","oidc","provider"],"created_at":"2024-11-12T11:24:11.766Z","updated_at":"2025-02-28T17:25:26.690Z","avatar_url":"https://github.com/ansforge.png","language":"Java","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Keycloak - Custom identity provider mapper\n\nThis extension provides a _Custom Mapper_ for OpenID Connect identity provider. It is a fork of _Advanced Claim to Role Mapper_, adding capability to select claims or nested claims where path includes an array field. Result of the target key is an array of values.\n\n```\nExample :\n{\n  \"claimA\": {\n    \"claimsB\": [\n      {\n        \"claimC\": \"C1\",\n        \"claimD\": \"D1\"\n      },\n      {\n        \"claimC\": \"C2\",\n        \"claimD\": \"D2\"\n      }\n    ]\n  }\n}\n\nKey = claimA.claimsB.claimC\nValue = [ \"C1\", \"D1\" ]\n```\n\nThen, it allows to apply regex on result array.\n\n## Compatibility\n\n- Version `1.0.0` is compatible with Keycloak `22.0.X`.\n- Version `2.0.0` is compatible with Keycloak `23.0.X`.\n- Version `3.0.0` is compatible with Keycloak `25.0.X` (nécessite java 21).\n\n## Install\n\nAs other [Keycloak SPI](https://www.keycloak.org/docs/latest/server_development/index.html#_implementing_spi),\n* put jar file in ```/providers``` folder\n* if Keycloak server il already started, stop it\n* to take into account this new provider, launch following command ```/bin/kc.sh build```\n* and start Keycloak server again ```/bin/kc.sh start```\n\n## Settings\n\nConnect to Keycloak admin console.\nSelect Identity Provider where you want to set up a new mapper :\n![Select Identity Provider](/assets/keycloak-idp-mapper-1.jpg)\nClick on **Add mapper** button and select **Custom Claim to Role** :\n![Add new Identity Provider Mapper](/assets/keycloak-idp-mapper-2.jpg)\nSet up your mapper config :\n![Set Identity Provider Mapper Config](/assets/keycloak-idp-mapper-3.jpg)\n\n## Development\n\n### Build\n\nTo build your local package, execute following command ```mvnw package```\n\n### Container\n\nTo test a provider, set version of your provider (jar file) in .env file :\n```MAPPER_VERSION=2.0.0```\n\nThen launch a Keycloak instance in a Docker container ```docker compose --env-file .env up```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fansforge%2Fkeycloak-custom-identity-provider-mapper","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fansforge%2Fkeycloak-custom-identity-provider-mapper","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fansforge%2Fkeycloak-custom-identity-provider-mapper/lists"}