rename to keycloak-subject-id-attribute-mapper and other literals cha…

…nges

.github/workflows/releases.yml

@@ -40,7 +40,7 @@ jobs:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
         with:
           upload_url: ${{ steps.create_release.outputs.upload_url }} # This pulls from the CREATE RELEASE step above, referencing it's ID to get its outputs object, which include a `upload_url`. See this blog post for more info: https://jasonet.co/posts/new-features-of-github-actions/#passing-data-to-future-steps
-          asset_path: target/keycloak-idp-subjectId-mapper.jar
-          asset_name: keycloak-idp-subjectId-mapper.jar
+          asset_path: target/keycloak-subject-id-attribute-mapper.jar
+          asset_name: keycloak-subject-id-attribute-mapper.jar
           asset_content_type: application/java-archive
 

CHANGELOG.md

@@ -1,11 +1,12 @@
 # Changelog
-All notable changes in keycloak-idp-subjectId-mapper will be documented in this file.
+All notable changes in keycloak-subject-id-attribute-mapper will be documented in this file.
 
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
 It is based on Keycloak version 22.
 
 ## [1.0.0] - 2024-10-22
+
 ### Added
 - Subject ID Mapper implementation

README.md

@@ -1,5 +1,7 @@
-# keycloak-idp-subjectId-mapper
-A pluggable Subject Id IdP mapper for keycloak. To be used in eosc installations 
+# keycloak-subject-id-attribute-mapper
+An Identity Provider (IdP) attribute mapper for Keycloak designed to generate a unique Subject Identifier. 
+The identifier is constructed from two components: a “unique ID” and a “scope,” which are concatenated using an "@" symbol (ASCII 64) as a delimiter. 
+By default, the generated identifier is mapped to the user's username, but this mapping can be customised through the mapper configuration settings
 
 ### Installation instructions:
 

src/main/java/org/keycloak/broker/provider/SubjectIdIdPMapper.java

@@ -53,15 +53,15 @@ public class SubjectIdIdPMapper extends AbstractIdentityProviderMapper {
         property = new ProviderConfigProperty();
         property.setName(USER_ATTRIBUTE);
         property.setLabel("Subject Id Attribute Name");
-        property.setHelpText("User attribute name to store the Subject Identifier for the user. Defaults to 'username'");
+        property.setHelpText("User attribute name to store the Subject Identifier for the user. Defaults to 'username'.");
         property.setDefaultValue(USERNAME);
         property.setType(ProviderConfigProperty.STRING_TYPE);
         configProperties.add(property);
 
         property = new ProviderConfigProperty();
         property.setName(SCOPE);
         property.setLabel("Scope");
-        property.setHelpText("Append a @scope value.");
+        property.setHelpText("Append a '@' + scope value. Defaults to 'example.org'.");
         property.setType(ProviderConfigProperty.STRING_TYPE);
         configProperties.add(property);
 
@@ -120,7 +120,7 @@ public void updateBrokeredUser(KeycloakSession session, RealmModel realm, UserMo
 
     @Override
     public String getHelpText() {
-        return "Generate a new Subject Identifier attribute according to OASIS Subject-ID to be used as a unique identifier for the user. The mapper works only in import sync mode. Any other sync mode will be ignored";
+        return "Generates a Subject Identifier with a random unique ID and a configurable scope, separated by '@'. Defaults to the 'username' attribute. Works only in 'import' sync mode; other modes are ignored.";
     }