diff xml/en/docs/http/ngx_http_auth_jwt_module.xml @ 1925:a58b35cc0823

Updated docs for the upcoming NGINX Plus release.
author Ruslan Ermilov <ru@nginx.com>
date Wed, 08 Mar 2017 18:05:46 +0300
parents b5e416ace4bf
children fee7627f6a5a
line wrap: on
line diff
--- a/xml/en/docs/http/ngx_http_auth_jwt_module.xml	Mon Mar 06 17:01:22 2017 +0300
+++ b/xml/en/docs/http/ngx_http_auth_jwt_module.xml	Wed Mar 08 18:05:46 2017 +0300
@@ -9,7 +9,7 @@
 <module name="Module ngx_http_auth_jwt_module"
         link="/en/docs/http/ngx_http_auth_jwt_module.html"
         lang="en"
-        rev="2">
+        rev="3">
 
 <section id="summary">
 
@@ -99,6 +99,34 @@
 </directive>
 
 
+<directive name="auth_jwt_header_set">
+<syntax><value>$variable</value> <value>name</value></syntax>
+<default/>
+<context>http</context>
+<appeared-in>1.11.10</appeared-in>
+
+<para>
+Sets the <value>variable</value> to the given
+JOSE header parameter <value>name</value>.
+</para>
+
+</directive>
+
+
+<directive name="auth_jwt_claim_set">
+<syntax><value>$variable</value> <value>name</value></syntax>
+<default/>
+<context>http</context>
+<appeared-in>1.11.10</appeared-in>
+
+<para>
+Sets the <value>variable</value> to the given
+JWT claim parameter <value>name</value>.
+</para>
+
+</directive>
+
+
 <directive name="auth_jwt_key_file">
 <syntax><value>file</value></syntax>
 <default/>
@@ -122,84 +150,21 @@
 
 <para>
 The <literal>ngx_http_auth_jwt_module</literal> module
-supports embedded variables.
+supports embedded variables:
 </para>
 
 <para>
-Variables that return
-<link url="https://tools.ietf.org/html/rfc7519#section-4">JWT claims</link>:
-
 <list type="tag" compact="yes">
-<tag-name id="var_jwt_claim_aud"><var>$jwt_claim_aud</var></tag-name>
-<tag-desc>
-audience
-</tag-desc>
-
-<tag-name id="var_jwt_claim_email"><var>$jwt_claim_email</var></tag-name>
-<tag-desc>
-email
-</tag-desc>
-
-<tag-name id="var_jwt_claim_exp"><var>$jwt_claim_exp</var></tag-name>
+<tag-name id="var_jwt_header_"><var>$jwt_header_</var><value>name</value></tag-name>
 <tag-desc>
-expiration time
-</tag-desc>
-
-<tag-name id="var_jwt_claim_iat"><var>$jwt_claim_iat</var></tag-name>
-<tag-desc>
-issued at
-</tag-desc>
-
-<tag-name id="var_jwt_claim_iss"><var>$jwt_claim_iss</var></tag-name>
-<tag-desc>
-issuer
-</tag-desc>
-
-<tag-name id="var_jwt_claim_jti"><var>$jwt_claim_jti</var></tag-name>
-<tag-desc>
-JWT ID
+returns the value of a specified
+<link url="https://tools.ietf.org/html/rfc7515#section-4">JOSE header</link>
 </tag-desc>
 
-<tag-name id="var_jwt_claim_nbf"><var>$jwt_claim_nbf</var></tag-name>
-<tag-desc>
-not-before
-</tag-desc>
-
-<tag-name id="var_jwt_claim_sub"><var>$jwt_claim_sub</var></tag-name>
-<tag-desc>
-subject
-</tag-desc>
-</list>
-</para>
-
-<para>
-Variables that return parameters of
-<link url="https://tools.ietf.org/html/rfc7515#section-4">JOSE header</link>:
-
-<list type="tag" compact="yes">
-<tag-name id="var_jwt_header_alg"><var>$jwt_header_alg</var></tag-name>
+<tag-name id="var_jwt_claim_"><var>$jwt_claim_</var><value>name</value></tag-name>
 <tag-desc>
-algorithm
-</tag-desc>
-
-<tag-name id="var_jwt_header_cty"><var>$jwt_header_cty</var></tag-name>
-<tag-desc>
-content type
-</tag-desc>
-
-<tag-name id="var_jwt_header_enc"><var>$jwt_header_enc</var></tag-name>
-<tag-desc>
-encryption algorithm
-</tag-desc>
-
-<tag-name id="var_jwt_header_kid"><var>$jwt_header_kid</var></tag-name>
-<tag-desc>
-key ID
-</tag-desc>
-
-<tag-name id="var_jwt_header_typ"><var>$jwt_header_typ</var></tag-name>
-<tag-desc>
-type
+returns the value of a specified
+<link url="https://tools.ietf.org/html/rfc7519#section-4">JWT claim</link>
 </tag-desc>
 
 </list>