auth_jwt_extract_response_claims

`auth_jwt_extract_response_claims` 指令从 JWT 中提取指定的声明并将其添加到响应头中。

语法auth_jwt_extract_response_claims claim_name1 claim_name2 ...;
默认值none
上下文http, server, location
参数1+

说明

auth_jwt_extract_response_claims 指令用于 NGINX,从 JSON Web Token (JWT) 中提取特定的声明,并将其放入发送回客户端的响应头中。该功能在 JWT 验证成功后,便于将服务器端的身份验证或授权细节传递给客户端。需要提取的声明通过以空格分隔的声明名称列表来指定,从而可对在响应头中共享的信息进行精细控制。

当 NGINX 处理请求时,会根据配置设置验证 JWT。一旦 JWT 通过验证,auth_jwt_extract_response_claims 指令就可以提取指定的声明,并将其作为响应头暴露出来。该指令提供了一种简单的机制,确保相关声明被返回给客户端,这对客户端执行诸如 UI 更新或 API 交互等操作非常有用。

总之,该指令通过使服务器能够在响应中有选择地提供特定声明来增强 JWT 的功能,这对于维护无状态身份验证和改善客户端与服务器的交互可能至关重要。

配置示例

location /api {
    auth_jwt_enabled on;
    auth_jwt_extract_response_claims sub email;
}

确保在 JWT 中指定的声明存在;否则将无法提取它们。

注意响应头大小限制;声明过多可能导致响应过大。

接收客户端应准备好正确处理指定的响应头。

← 返回所有指令