nginx-site: xml/en/docs/http/ngx_http_auth_jwt

annotate xml/en/docs/http/ngx_http_auth_jwt_module.xml @ 1831:b5e416ace4bf

Corrected style and variables description in auth_jwt.

author	Yaroslav Zhuravlev <yar@nginx.com>
date	Tue, 25 Oct 2016 15:01:47 +0300
parents	a7974b8d2a23
children	a58b35cc0823

rev	line source
1763 a7974b8d2a23 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1 <?xml version="1.0"?>
a7974b8d2a23 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2
a7974b8d2a23 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3 <!--
a7974b8d2a23 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	4 Copyright (C) Nginx, Inc.
a7974b8d2a23 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	5 -->
a7974b8d2a23 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	6
a7974b8d2a23 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	7 <!DOCTYPE module SYSTEM "../../../../dtd/module.dtd">
a7974b8d2a23 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	8
a7974b8d2a23 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	9 <module name="Module ngx_http_auth_jwt_module"
a7974b8d2a23 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	10 link="/en/docs/http/ngx_http_auth_jwt_module.html"
a7974b8d2a23 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	11 lang="en"
1831 b5e416ace4bf Corrected style and variables description in auth_jwt. Yaroslav Zhuravlev <yar@nginx.com> parents: 1763 diff changeset	12 rev="2">
1763 a7974b8d2a23 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	13
a7974b8d2a23 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	14 <section id="summary">
a7974b8d2a23 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	15
a7974b8d2a23 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	16 <para>
a7974b8d2a23 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	17 The <literal>ngx_http_auth_jwt_module</literal> module (1.11.3)
a7974b8d2a23 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	18 implements client authorization by validating the provided
a7974b8d2a23 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	19 <link url="https://tools.ietf.org/html/rfc7519">JSON Web Token</link> (JWT)
a7974b8d2a23 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	20 using the specified keys.
a7974b8d2a23 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	21 JWT claims must be encoded in a
a7974b8d2a23 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	22 <link url="https://tools.ietf.org/html/rfc7515">JSON Web Signature</link> (JWS)
a7974b8d2a23 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	23 structure.
a7974b8d2a23 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	24 The module can be used for
a7974b8d2a23 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	25 <link url="http://openid.net/specs/openid-connect-core-1_0.html">OpenID Connect</link>
a7974b8d2a23 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	26 authentication.
a7974b8d2a23 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	27 </para>
a7974b8d2a23 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	28
a7974b8d2a23 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	29 <para>
a7974b8d2a23 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	30 The module may be combined with
a7974b8d2a23 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	31 other access modules, such as
a7974b8d2a23 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	32 <link doc="ngx_http_access_module.xml">ngx_http_access_module</link>,
a7974b8d2a23 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	33 <link doc="ngx_http_auth_basic_module.xml">ngx_http_auth_basic_module</link>,
a7974b8d2a23 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	34 and
a7974b8d2a23 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	35 <link doc="ngx_http_auth_request_module.xml">ngx_http_auth_request_module</link>,
a7974b8d2a23 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	36 via the <link doc="ngx_http_core_module.xml" id="satisfy"/> directive.
a7974b8d2a23 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	37 </para>
a7974b8d2a23 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	38
a7974b8d2a23 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	39 <para>
a7974b8d2a23 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	40 <note>
a7974b8d2a23 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	41 This module is available as part of our
a7974b8d2a23 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	42 <commercial_version>commercial subscription</commercial_version>.
a7974b8d2a23 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	43 </note>
a7974b8d2a23 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	44 </para>
a7974b8d2a23 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	45
a7974b8d2a23 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	46 </section>
a7974b8d2a23 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	47
a7974b8d2a23 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	48
a7974b8d2a23 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	49 <section id="example" name="Example Configuration">
a7974b8d2a23 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	50
a7974b8d2a23 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	51 <para>
a7974b8d2a23 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	52 <example>
a7974b8d2a23 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	53 location / {
a7974b8d2a23 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	54 auth_jwt "closed site";
a7974b8d2a23 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	55 auth_jwt_key_file conf/keys.json;
a7974b8d2a23 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	56 }
a7974b8d2a23 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	57 </example>
a7974b8d2a23 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	58 </para>
a7974b8d2a23 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	59
a7974b8d2a23 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	60 </section>
a7974b8d2a23 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	61
a7974b8d2a23 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	62
a7974b8d2a23 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	63 <section id="directives" name="Directives">
a7974b8d2a23 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	64
a7974b8d2a23 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	65 <directive name="auth_jwt">
1831 b5e416ace4bf Corrected style and variables description in auth_jwt. Yaroslav Zhuravlev <yar@nginx.com> parents: 1763 diff changeset	66 <syntax>
b5e416ace4bf Corrected style and variables description in auth_jwt. Yaroslav Zhuravlev <yar@nginx.com> parents: 1763 diff changeset	67 <value>string</value>
b5e416ace4bf Corrected style and variables description in auth_jwt. Yaroslav Zhuravlev <yar@nginx.com> parents: 1763 diff changeset	68 [<literal>token=</literal><value>$variable</value>] \|
b5e416ace4bf Corrected style and variables description in auth_jwt. Yaroslav Zhuravlev <yar@nginx.com> parents: 1763 diff changeset	69 <literal>off</literal></syntax>
1763 a7974b8d2a23 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	70 <default>off</default>
a7974b8d2a23 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	71 <context>http</context>
a7974b8d2a23 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	72 <context>server</context>
a7974b8d2a23 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	73 <context>location</context>
a7974b8d2a23 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	74
a7974b8d2a23 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	75 <para>
a7974b8d2a23 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	76 Enables validation of JSON Web Token.
a7974b8d2a23 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	77 The specified <value>string</value> is used as a <literal>realm</literal>.
a7974b8d2a23 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	78 Parameter value can contain variables.
a7974b8d2a23 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	79 </para>
a7974b8d2a23 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	80
a7974b8d2a23 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	81 <para>
1831 b5e416ace4bf Corrected style and variables description in auth_jwt. Yaroslav Zhuravlev <yar@nginx.com> parents: 1763 diff changeset	82 The optional <literal>token</literal> parameter specifies a variable
1763 a7974b8d2a23 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	83 that contains JSON Web Token.
a7974b8d2a23 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	84 By default, JWT is passed in the <header>Authorization</header> header
a7974b8d2a23 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	85 as a
a7974b8d2a23 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	86 <link url="https://tools.ietf.org/html/rfc6750">Bearer Token</link>.
a7974b8d2a23 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	87 JWT may be also passed as a cookie or a part of a query string:
a7974b8d2a23 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	88 <example>
a7974b8d2a23 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	89 auth_jwt "closed site" token=$cookie_auth_token;
a7974b8d2a23 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	90 </example>
a7974b8d2a23 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	91 </para>
a7974b8d2a23 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	92
a7974b8d2a23 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	93 <para>
a7974b8d2a23 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	94 The special value <literal>off</literal> cancels the effect
a7974b8d2a23 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	95 of the <literal>auth_jwt</literal> directive
a7974b8d2a23 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	96 inherited from the previous configuration level.
a7974b8d2a23 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	97 </para>
a7974b8d2a23 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	98
a7974b8d2a23 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	99 </directive>
a7974b8d2a23 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	100
a7974b8d2a23 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	101
a7974b8d2a23 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	102 <directive name="auth_jwt_key_file">
a7974b8d2a23 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	103 <syntax><value>file</value></syntax>
a7974b8d2a23 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	104 <default/>
a7974b8d2a23 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	105 <context>http</context>
a7974b8d2a23 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	106 <context>server</context>
a7974b8d2a23 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	107 <context>location</context>
a7974b8d2a23 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	108
a7974b8d2a23 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	109 <para>
a7974b8d2a23 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	110 Specifies a <value>file</value> in
a7974b8d2a23 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	111 <link url="https://tools.ietf.org/html/rfc7517#section-5">JSON Web Key Set</link>
a7974b8d2a23 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	112 format for validating JWT signature.
a7974b8d2a23 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	113 Parameter value can contain variables.
a7974b8d2a23 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	114 </para>
a7974b8d2a23 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	115
a7974b8d2a23 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	116 </directive>
a7974b8d2a23 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	117
a7974b8d2a23 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	118 </section>
a7974b8d2a23 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	119
1831 b5e416ace4bf Corrected style and variables description in auth_jwt. Yaroslav Zhuravlev <yar@nginx.com> parents: 1763 diff changeset	120
1763 a7974b8d2a23 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	121 <section id="variables" name="Embedded Variables">
a7974b8d2a23 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	122
a7974b8d2a23 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	123 <para>
a7974b8d2a23 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	124 The <literal>ngx_http_auth_jwt_module</literal> module
a7974b8d2a23 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	125 supports embedded variables.
a7974b8d2a23 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	126 </para>
a7974b8d2a23 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	127
a7974b8d2a23 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	128 <para>
a7974b8d2a23 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	129 Variables that return
a7974b8d2a23 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	130 <link url="https://tools.ietf.org/html/rfc7519#section-4">JWT claims</link>:
a7974b8d2a23 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	131
1831 b5e416ace4bf Corrected style and variables description in auth_jwt. Yaroslav Zhuravlev <yar@nginx.com> parents: 1763 diff changeset	132 <list type="tag" compact="yes">
1763 a7974b8d2a23 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	133 <tag-name id="var_jwt_claim_aud"><var>$jwt_claim_aud</var></tag-name>
a7974b8d2a23 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	134 <tag-desc>
1831 b5e416ace4bf Corrected style and variables description in auth_jwt. Yaroslav Zhuravlev <yar@nginx.com> parents: 1763 diff changeset	135 audience
1763 a7974b8d2a23 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	136 </tag-desc>
a7974b8d2a23 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	137
a7974b8d2a23 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	138 <tag-name id="var_jwt_claim_email"><var>$jwt_claim_email</var></tag-name>
a7974b8d2a23 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	139 <tag-desc>
1831 b5e416ace4bf Corrected style and variables description in auth_jwt. Yaroslav Zhuravlev <yar@nginx.com> parents: 1763 diff changeset	140 email
1763 a7974b8d2a23 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	141 </tag-desc>
a7974b8d2a23 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	142
a7974b8d2a23 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	143 <tag-name id="var_jwt_claim_exp"><var>$jwt_claim_exp</var></tag-name>
a7974b8d2a23 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	144 <tag-desc>
1831 b5e416ace4bf Corrected style and variables description in auth_jwt. Yaroslav Zhuravlev <yar@nginx.com> parents: 1763 diff changeset	145 expiration time
1763 a7974b8d2a23 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	146 </tag-desc>
a7974b8d2a23 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	147
a7974b8d2a23 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	148 <tag-name id="var_jwt_claim_iat"><var>$jwt_claim_iat</var></tag-name>
a7974b8d2a23 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	149 <tag-desc>
1831 b5e416ace4bf Corrected style and variables description in auth_jwt. Yaroslav Zhuravlev <yar@nginx.com> parents: 1763 diff changeset	150 issued at
1763 a7974b8d2a23 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	151 </tag-desc>
a7974b8d2a23 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	152
a7974b8d2a23 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	153 <tag-name id="var_jwt_claim_iss"><var>$jwt_claim_iss</var></tag-name>
a7974b8d2a23 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	154 <tag-desc>
1831 b5e416ace4bf Corrected style and variables description in auth_jwt. Yaroslav Zhuravlev <yar@nginx.com> parents: 1763 diff changeset	155 issuer
1763 a7974b8d2a23 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	156 </tag-desc>
a7974b8d2a23 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	157
a7974b8d2a23 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	158 <tag-name id="var_jwt_claim_jti"><var>$jwt_claim_jti</var></tag-name>
a7974b8d2a23 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	159 <tag-desc>
1831 b5e416ace4bf Corrected style and variables description in auth_jwt. Yaroslav Zhuravlev <yar@nginx.com> parents: 1763 diff changeset	160 JWT ID
1763 a7974b8d2a23 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	161 </tag-desc>
a7974b8d2a23 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	162
a7974b8d2a23 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	163 <tag-name id="var_jwt_claim_nbf"><var>$jwt_claim_nbf</var></tag-name>
a7974b8d2a23 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	164 <tag-desc>
1831 b5e416ace4bf Corrected style and variables description in auth_jwt. Yaroslav Zhuravlev <yar@nginx.com> parents: 1763 diff changeset	165 not-before
1763 a7974b8d2a23 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	166 </tag-desc>
a7974b8d2a23 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	167
a7974b8d2a23 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	168 <tag-name id="var_jwt_claim_sub"><var>$jwt_claim_sub</var></tag-name>
a7974b8d2a23 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	169 <tag-desc>
1831 b5e416ace4bf Corrected style and variables description in auth_jwt. Yaroslav Zhuravlev <yar@nginx.com> parents: 1763 diff changeset	170 subject
1763 a7974b8d2a23 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	171 </tag-desc>
a7974b8d2a23 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	172 </list>
a7974b8d2a23 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	173 </para>
a7974b8d2a23 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	174
a7974b8d2a23 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	175 <para>
a7974b8d2a23 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	176 Variables that return parameters of
a7974b8d2a23 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	177 <link url="https://tools.ietf.org/html/rfc7515#section-4">JOSE header</link>:
a7974b8d2a23 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	178
1831 b5e416ace4bf Corrected style and variables description in auth_jwt. Yaroslav Zhuravlev <yar@nginx.com> parents: 1763 diff changeset	179 <list type="tag" compact="yes">
1763 a7974b8d2a23 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	180 <tag-name id="var_jwt_header_alg"><var>$jwt_header_alg</var></tag-name>
a7974b8d2a23 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	181 <tag-desc>
1831 b5e416ace4bf Corrected style and variables description in auth_jwt. Yaroslav Zhuravlev <yar@nginx.com> parents: 1763 diff changeset	182 algorithm
1763 a7974b8d2a23 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	183 </tag-desc>
a7974b8d2a23 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	184
a7974b8d2a23 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	185 <tag-name id="var_jwt_header_cty"><var>$jwt_header_cty</var></tag-name>
a7974b8d2a23 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	186 <tag-desc>
1831 b5e416ace4bf Corrected style and variables description in auth_jwt. Yaroslav Zhuravlev <yar@nginx.com> parents: 1763 diff changeset	187 content type
1763 a7974b8d2a23 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	188 </tag-desc>
a7974b8d2a23 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	189
a7974b8d2a23 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	190 <tag-name id="var_jwt_header_enc"><var>$jwt_header_enc</var></tag-name>
a7974b8d2a23 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	191 <tag-desc>
1831 b5e416ace4bf Corrected style and variables description in auth_jwt. Yaroslav Zhuravlev <yar@nginx.com> parents: 1763 diff changeset	192 encryption algorithm
1763 a7974b8d2a23 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	193 </tag-desc>
a7974b8d2a23 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	194
a7974b8d2a23 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	195 <tag-name id="var_jwt_header_kid"><var>$jwt_header_kid</var></tag-name>
a7974b8d2a23 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	196 <tag-desc>
1831 b5e416ace4bf Corrected style and variables description in auth_jwt. Yaroslav Zhuravlev <yar@nginx.com> parents: 1763 diff changeset	197 key ID
1763 a7974b8d2a23 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	198 </tag-desc>
a7974b8d2a23 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	199
a7974b8d2a23 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	200 <tag-name id="var_jwt_header_typ"><var>$jwt_header_typ</var></tag-name>
a7974b8d2a23 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	201 <tag-desc>
1831 b5e416ace4bf Corrected style and variables description in auth_jwt. Yaroslav Zhuravlev <yar@nginx.com> parents: 1763 diff changeset	202 type
1763 a7974b8d2a23 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	203 </tag-desc>
a7974b8d2a23 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	204
a7974b8d2a23 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	205 </list>
a7974b8d2a23 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	206 </para>
a7974b8d2a23 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	207
a7974b8d2a23 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	208 </section>
a7974b8d2a23 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	209
a7974b8d2a23 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	210 </module>

Mercurial > hg > nginx-site

annotate xml/en/docs/http/ngx_http_auth_jwt_module.xml @ 1831:b5e416ace4bf