如何在Keycloak中创建脚本映射器?

时间:2018-09-26 12:56:59

标签: java keycloak

我需要在Keycloak中创建“脚本映射器”类型的协议映射器。该脚本应获取用户属性,检查其大小,并将其放在令牌上。我没有找到有关如何创建脚本的文档或示例。从我收集的点点滴滴来看,我想我的脚本需要看起来像这样:

var value = user.getAttribute("myAttribute");
if (value.length > LIMIT) {
    value = value.substring(0,LIMIT);
}
token.setOtherClaims("myAttribute",value);
  • 这是对的吗?我组成了user.getAttribute(“ myAttribute”)。是否有文档来源可以找到如何获取Keycloak用户属性?
  • 脚本是否需要返回任何内容? 任何帮助都将受到欢迎。

2 个答案:

答案 0 :(得分:6)

我需要此功能,但在我刚安装的10.0.2中找不到此“脚本映射器”。事实证明,默认情况下未启用它,如此处的文档所示:https://www.keycloak.org/docs/latest/server_installation/#profiles

要启用它,您可以:

  • 使用standalone/configuration/profile.properties创建文件feature.scripts=enabled

  • 使用bin/standalone.sh|bat -Dkeycloak.profile.feature.scripts=enabled启动服务器

the source code看来

public boolean isSupported() {
    return Profile.isFeatureEnabled(Profile.Feature.SCRIPTS) && Profile.isFeatureEnabled(Profile.Feature.UPLOAD_SCRIPTS);
}

upload_scripts应该同样启用

我希望它将对某人有所帮助

答案 1 :(得分:5)

可以通过查看以下{@ {3}}

的密钥隐藏源来理解脚本映射器的魔力。

该脚本可以通过使用此类exports变量返回某些内容

exports = "Claim Value"

不同的类型:

这是一个示例脚本:

// you can set standard fields in token
token.setAcr("test value");

// you can set claims in the token
token.getOtherClaims().put("claimName", "claim value");

// work with variables and return multivalued token value
var ArrayList = Java.type("java.util.ArrayList");
var roles = new ArrayList();
var client = keycloakSession.getContext().getClient();
var forEach = Array.prototype.forEach;
forEach.call(user.getClientRoleMappings(client).toArray(), function(roleModel) {
  roles.add(roleModel.getName());
});

exports = roles;

希望有帮助!