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 для извлечения конкретных утверждений из JWT и помещения их в заголовки ответа, отправляемые клиенту. Эта возможность особенно полезна для передачи сервером сведений об аутентификации или авторизации клиенту после успешной проверки JWT. Утверждения, которые необходимо извлечь, указываются в виде списка имён утверждений, разделённых пробелом, что позволяет гибко контролировать информацию, передаваемую в заголовках ответа.

Когда NGINX обрабатывает запрос, он проверяет JWT в соответствии с настройками конфигурации. После валидации JWT директива auth_jwt_extract_response_claims позволяет извлечь указанные утверждения, которые затем становятся доступными в виде заголовков ответа. Эта директива предоставляет простой механизм, обеспечивающий возврат релевантных утверждений клиенту, что может быть полезно для различных операций на стороне клиента, таких как обновление интерфейса или взаимодействие с API.

В целом, эта директива расширяет функциональность JWT, позволяя серверу выборочно предоставлять определённые утверждения в ответе, что важно для поддержания аутентификации без сохранения состояния и улучшения взаимодействия клиента и сервера.

Пример конфига

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

Убедитесь, что указанные claims присутствуют в JWT; в противном случае они не будут извлечены.

Остерегайтесь ограничений размера заголовков; слишком много claims может привести к слишком большим ответам.

Принимающие клиенты должны быть готовы правильно обрабатывать указанные заголовки ответа.

← Ко всем директивам