Auth0登录流程：如何将username字段添加到idToken中

解决方案 #

你写的PostLogin Action代码逻辑本身没有问题，没有生效基本是以下几个原因导致的，按顺序排查即可：

• 确认Action已正确挂载到登录流
  写完代码点击保存后，需要回到Actions > Flows > Login面板，把你创建的自定义Action从左侧的「Custom」分类拖到执行流程中，确保它排在其他会修改token声明的Action之前，最后点击页面顶部的Apply按钮才会正式生效，漏了这一步代码永远不会执行。
• 确认username属性的取值路径正确
  不同的用户数据源存储用户名的字段不一样，你可以在Action代码中加入日志打印用户完整属性，确认取值路径：

  exports.onExecutePostLogin = async (event, api) => {
    // 打印完整用户对象，可在对应身份认证平台的监控日志面板中查看输出
    console.log('user object:', JSON.stringify(event.user))
    const username = event.user.username || event.user.nickname || event.user.user_metadata?.username
    api.idToken.setCustomClaim("username", username);
    api.accessToken.setCustomClaim("username", username);
  };
  

  如果你的用户名存储在app_metadata或者user_metadata中，需要对应修改取值路径。
• 确认接口请求的scope配置正确
  调用/oauth/token接口时必须携带openid scope才会返回idToken，如果你配置了自定义声明需要依赖特定scope，也要确保该scope已在客户端配置中开放，且请求时已经携带。
• 排除缓存干扰
  测试时需要完全退出现有账号，走全新的登录流程获取新的token，不要使用之前缓存的 refresh token 刷新获取旧token，旧token不会触发PostLogin流程重新生成声明。
• 验证token本身
  拿到返回的idToken后可以用任意JWT解码工具直接解码，确认是token本身没有携带username字段，还是你的应用侧解析逻辑漏处理了该字段。

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