如何为Keycloak Realm设置别名并将其加入访问令牌？

完全可以通过客户端范围实现需求，具体步骤如下：

1. 预先设置Realm的显示名称作为别名 #

进入目标Realm的设置页面，在「显示名称」字段填入你需要的别名（比如STB、CCD），保存更改。

2. 创建专属客户端范围 #

• 登录Keycloak管理控制台，左侧导航栏选择「客户端范围」，点击「创建」
• 输入客户端范围名称（比如realm-alias-scope），点击「保存」进入详情页

3. 添加Realm别名映射器 #

• 切换到「映射器」标签页，点击「创建」
• 映射器类型选择「脚本映射器」，然后填写以下配置：
  • 名称：自定义（比如realm-alias-mapper）
  • 脚本类型：选择「Token Mapper」
  • 脚本内容：

    // 获取当前Realm的显示名称作为别名
    const realmAlias = realm.getDisplayName();
    // 将别名添加到访问令牌的自定义字段中，字段名可按需修改
    AccessToken.getClaims().put("realm_alias", realmAlias);
    

  • 勾选「添加到访问令牌」（如果需要也可勾选「添加到ID令牌」）
  • 点击「保存」完成映射器配置

4. 将客户端范围关联到目标客户端 #

• 进入需要获取该别名的客户端详情页，切换到「客户端范围」标签页
• 在「可用客户端范围」列表中找到刚创建的realm-alias-scope，点击「添加选定」将其移到「已添加的客户端范围」

5. 验证结果 #

发起授权流程获取访问令牌，用JWT解码工具查看令牌内容，就能看到realm_alias字段，其值就是你设置的Realm别名。

内容的提问来源于stack exchange，提问作者vaib