You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
The authorization endpoint handles authentication and authorization of a user.
91
-
To present the Login.gov authorization page to a user, direct them to the
92
-
<code class="language-plaintext highlighter-rouge">/openid_connect/authorize</code>. View an example for <strong>private_key_jwt</strong> or <strong>PKCE</strong> in the side panel.
<a href="{% link _pages/oidc/authorization/pkce.md %}#authorization">PKCE</a>
101
-
</li>
102
-
</ul>
103
-
<div class="grid-row dev-doc-row">
104
-
<div class="grid-col-5">
105
-
<h4 id="acr_values">acr_values</h4>
106
-
</div>
107
-
<div class="grid-col-7">
108
-
<p>
109
-
The Authentication Context Class Reference requests can be used to specify the type of service level or the AAL (Authentication Assurance Level) for the user. These and the <code class="language-plaintext highlighter-rouge">scope</code> determine which <a class="usa-link" href="{{ '/attributes/' | prepend: site.baseurl }}">user attributes</a> will be available in the <a class="usa-link" href="{{ '/oidc/user-info/#user-info-response' | prepend: site.baseurl }}">user info response</a>.
110
-
</p>
111
-
<p>
112
-
Multiple values can be joined with a space (before being URI-escaped in the final URL).
113
-
</p>
114
-
</div>
89
+
<p>
90
+
The authorization endpoint handles authentication and authorization of a user.
91
+
To present the Login.gov authorization page to a user, direct them to the
92
+
<code class="language-plaintext highlighter-rouge">/openid_connect/authorize</code>. View an example for <strong>private_key_jwt</strong> or <strong>PKCE</strong> in the side panel.
{% include accordion.html content=deprecated_values accordion_id="deprecated_accordion" title="Deprecated Service Values" id="deprecated_values" %}
121
-
</dl>
107
+
<div class="grid-col-7">
108
+
<p>
109
+
The Authentication Context Class Reference requests can be used to specify the type of service level or the AAL (Authentication Assurance Level) for the user. These and the <code class="language-plaintext highlighter-rouge">scope</code> determine which <a class="usa-link" href="{{ '/attributes/' | prepend: site.baseurl }}">user attributes</a> will be available in the <a class="usa-link" href="{{ '/oidc/user-info/#user-info-response' | prepend: site.baseurl }}">user info response</a>.
110
+
</p>
111
+
<p>
112
+
Multiple values can be joined with a space (before being URI-escaped in the final URL).
113
+
</p>
114
+
</div>
115
+
</div>
116
+
<div class="grid-row dev-doc-row">
117
+
<dl class="usa-accordion">
118
+
{% include accordion.html content=service_levels accordion_id="service_level_accordion" title="Type of Service Level" id="service_level" %}
{% include accordion.html content=deprecated_values accordion_id="deprecated_accordion" title="Deprecated Service Values" id="deprecated_values" %}
121
+
</dl>
122
+
</div>
123
+
<div class="grid-row dev-doc-row">
124
+
<div class="grid-col-5">
125
+
<h4>client_id</h4>
126
+
</div>
127
+
<div class="grid-col-7">
128
+
<p>Also known as the issuer, this is the unique identifier for the client. This will be registered with the Login.gov IdP in advance.</p>
129
+
</div>
130
+
</div>
131
+
<div class="grid-row dev-doc-row">
132
+
<div class="grid-col-5">
133
+
<h4 id="prompt">prompt</h4>
134
+
</div>
135
+
<div class="grid-col-7">
136
+
<p>This must be <code class="language-plaintext highlighter-rouge">select_account</code></p>
122
137
</div>
123
-
<div class="grid-row dev-doc-row">
138
+
</div>
139
+
<div class="grid-row dev-doc-row">
140
+
<div class="grid-col-5">
141
+
<h4 class="clearfix">response_type</h4>
142
+
</div>
143
+
<div class="grid-col-7">
144
+
<p>This must be <code class="language-plaintext highlighter-rouge">code</code></p>
145
+
</div>
146
+
</div>
147
+
<div class="grid-row dev-doc-row">
148
+
<div class="grid-col-5">
149
+
<h4 class="clearfix">redirect_uri</h4>
150
+
</div>
151
+
<div class="grid-col-7">
152
+
<p>The URI Login.gov will redirect to after a successful authorization.</p>
153
+
</div>
154
+
</div>
155
+
<div class="dev-doc-row">
156
+
<div class="grid-row">
124
157
<div class="grid-col-5">
125
-
<h4>client_id</h4>
158
+
<h4 class="clearfix">scope</h4>
126
159
</div>
127
160
<div class="grid-col-7">
128
-
<p>Also known as the issuer, this is the unique identifier for the client. This will be registered with the Login.gov IdP in advance.</p>
161
+
<p>A space-separated string of the scopes being requested. (Keep in mind the blank space “ “ should be encoded with “+”.) The authorization page will display the list of attributes being requested from the user. Applications should aim to request the fewest <a class="usa-link" href="{{ '/attributes/' | prepend: site.baseurl }}">user attributes</a> and smallest scope needed.</p>
162
+
<p>OIDC requests MUST contain the <code>openid</code> scope value.</p>
129
163
</div>
130
164
</div>
131
-
<div class="grid-row dev-doc-row">
165
+
<div class="grid-row">
166
+
<dl class="usa-accordion padding-top-2">
167
+
{% include accordion.html content=scope_possible_values accordion_id="scope_accordion" id="scope_possible_values" title="Possible Values" %}
168
+
</dl>
169
+
</div>
170
+
</div>
171
+
<div class="dev-doc-row">
172
+
<div class="grid-row">
132
173
<div class="grid-col-5">
133
-
<h4 id="prompt">prompt</h4>
174
+
<h4 class="clearfix">state</h4>
134
175
</div>
135
176
<div class="grid-col-7">
136
-
<p>This must be <code class="language-plaintext highlighter-rouge">select_account</code></p>
177
+
<p>A unique value, at least 22 characters in length, used for maintaining state between the request and the callback. This value will be returned to the client on a successful authorization.</p>
137
178
</div>
138
179
</div>
139
-
<div class="grid-row dev-doc-row">
180
+
</div>
181
+
<div class="dev-doc-row">
182
+
<div class="grid-row">
140
183
<div class="grid-col-5">
141
-
<h4 class="clearfix">response_type</h4>
184
+
<h4 class="clearfix">nonce</h4>
142
185
</div>
143
186
<div class="grid-col-7">
144
-
<p>This must be <code class="language-plaintext highlighter-rouge">code</code></p>
187
+
<p>A unique value, at least 22 characters in length, used to verify the integrity
188
+
of the <code class="language-plaintext highlighter-rouge">id_token</code> and mitigate
<p>This value should include per-session state and be unguessable by attackers. This value will be present in the
191
+
<code class="language-plaintext highlighter-rouge">id_token</code> of the <a class="usa-link" href="{{ '/oidc/token/#token-response' | prepend: site.baseurl }}">token endpoint response</a>,
192
+
where clients will verify that the nonce claim value is equal to the value of the nonce parameter sent in the authentication request.</p>
193
+
<p> Read more about <a class="usa-link usa-link--external" href="https://openid.net/specs/openid-connect-core-1_0.html#NonceNotes">nonce implementation</a> in the spec.</p>
<p>The URI Login.gov will redirect to after a successful authorization.</p>
153
-
</div>
154
-
</div>
155
-
<div class="dev-doc-row">
156
-
<div class="grid-row">
157
-
<div class="grid-col-5">
158
-
<h4 class="clearfix">scope</h4>
159
-
</div>
160
-
<div class="grid-col-7">
161
-
<p>A space-separated string of the scopes being requested. (Keep in mind the blank space “ “ should be encoded with “+”.) The authorization page will display the list of attributes being requested from the user. Applications should aim to request the fewest <a class="usa-link" href="{{ '/attributes/' | prepend: site.baseurl }}">user attributes</a> and smallest scope needed.</p>
162
-
<p>OIDC requests MUST contain the <code>openid</code> scope value.</p>
163
-
</div>
164
-
</div>
165
-
<div class="grid-row">
166
-
<dl class="usa-accordion padding-top-2">
167
-
{% include accordion.html content=scope_possible_values accordion_id="scope_accordion" id="scope_possible_values" title="Possible Values" %}
168
-
</dl>
169
-
</div>
170
-
</div>
171
-
<div class="dev-doc-row">
172
-
<div class="grid-row">
173
-
<div class="grid-col-5">
174
-
<h4 class="clearfix">state</h4>
175
-
</div>
176
-
<div class="grid-col-7">
177
-
<p>A unique value, at least 22 characters in length, used for maintaining state between the request and the callback. This value will be returned to the client on a successful authorization.</p>
178
-
</div>
203
+
<p>If you know that a user would prefer one of our alternative language translations (currently Spanish or French), you can include the <code class="language-plaintext highlighter-rouge">locale</code> parameter to specify the language Login.gov should use (either <code class="text-lowercase">ES</code> for Spanish or <code class="text-lowercase">FR</code> for French).</p>
179
204
</div>
180
205
</div>
181
-
<div class="dev-doc-row">
182
-
<div class="grid-row">
183
-
<div class="grid-col-5">
184
-
<h4 class="clearfix">nonce</h4>
185
-
</div>
186
-
<div class="grid-col-7">
187
-
<p>A unique value, at least 22 characters in length, used to verify the integrity
188
-
of the <code class="language-plaintext highlighter-rouge">id_token</code> and mitigate
<p>This value should include per-session state and be unguessable by attackers. This value will be present in the
191
-
<code class="language-plaintext highlighter-rouge">id_token</code> of the <a class="usa-link" href="{{ '/oidc/token/#token-response' | prepend: site.baseurl }}">token endpoint response</a>,
192
-
where clients will verify that the nonce claim value is equal to the value of the nonce parameter sent in the authentication request.</p>
193
-
<p> Read more about <a class="usa-link usa-link--external" href="https://openid.net/specs/openid-connect-core-1_0.html#NonceNotes">nonce implementation</a> in the spec.</p>
<p>If you know that a user would prefer one of our alternative language translations (currently Spanish or French), you can include the <code class="language-plaintext highlighter-rouge">locale</code> parameter to specify the language Login.gov should use (either <code class="text-lowercase">ES</code> for Spanish or <code class="text-lowercase">FR</code> for French).</p>
0 commit comments