Skip to content

Commit e650798

Browse files
mi-akrammi-akram
authored
Merge pull request #494 from hmrc/API-7483-b
API-7483 - PKCE documentation updates
2 parents 3c0b7fd + e5a0a57 commit e650798

File tree

1 file changed

+11
-11
lines changed

1 file changed

+11
-11
lines changed

‎app/uk/gov/hmrc/apidocumentation/views/AuthorisationUserRestrictedEndpointsView.scala.html‎

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -175,11 +175,11 @@ <h5 id="auth-endpoint-example" class="govuk-heading-s">Example</h5>
175175
</tr>
176176
<tr class="govuk-table__row">
177177
<td class="govuk-table__cell"><code class="code--slim">code_challenge</code> (optional)</td>
178-
<td class="govuk-table__cell">The <a class="govuk-link" href="https://oauth.net/2/pkce/">PKCE</a> <code class="code--slim">code_challenge</code> used to ensure that the subsequently-issued access token is not intercepted.</td>
178+
<td class="govuk-table__cell">The <a class="govuk-link" href="https://oauth.net/2/pkce/">PKCE</a> <code class="code--slim">code_challenge</code> is used to ensure that the subsequently-issued access token is not intercepted. This is mandatory if <code class="code--slim">code_challenge_method</code> is provided.</td>
179179
</tr>
180180
<tr class="govuk-table__row">
181181
<td class="govuk-table__cell"><code class="code--slim">code_challenge_method</code> (optional)</td>
182-
<td class="govuk-table__cell">The <a class="govuk-link" href="https://oauth.net/2/pkce/">PKCE</a> <code class="code--slim">code_challenge_method</code> used to transform the code_verifier to the code_challenge. This must have a value of <code class="code--slim">S256</code>.</td>
182+
<td class="govuk-table__cell">The <a class="govuk-link" href="https://oauth.net/2/pkce/">PKCE</a> <code class="code--slim">code_challenge_method</code> is used to transform the code_verifier to the code_challenge. This must have a value of <code class="code--slim">S256</code>. This is mandatory if <code class="code--slim">code_challenge</code> is provided.</td>
183183
</tr>
184184
</tbody>
185185
</table>
@@ -260,25 +260,25 @@ <h5 class="govuk-heading-s faded-text">Error scenarios</h5>
260260
<td class="govuk-table__cell"><code class="code--slim">client_secret should NOT be present</code></td>
261261
</tr>
262262
<tr class="govuk-table__row">
263-
<td class="govuk-table__cell">code_challenge cannot be empty</td>
263+
<td class="govuk-table__cell">PKCE Code Challenge cannot be empty</td>
264264
<td class="govuk-table__cell"><code class="code--slim">400</code> (Bad Request)</td>
265265
<td class="govuk-table__cell"><code class="code--slim">invalid_request</code></td>
266266
<td class="govuk-table__cell"><code class="code--slim">code_challenge if present, cannot be empty</code></td>
267267
</tr>
268268
<tr class="govuk-table__row">
269-
<td class="govuk-table__cell">code_challenge_method, must be S256</td>
269+
<td class="govuk-table__cell">PKCE Code Challenge Method, must be S256</td>
270270
<td class="govuk-table__cell"><code class="code--slim">400</code> (Bad Request)</td>
271271
<td class="govuk-table__cell"><code class="code--slim">invalid_request</code></td>
272272
<td class="govuk-table__cell"><code class="code--slim">code_challenge_method, if present, must be S256</code></td>
273273
</tr>
274274
<tr class="govuk-table__row">
275-
<td class="govuk-table__cell">code_challenge_method should be present when code_challenge is present</td>
275+
<td class="govuk-table__cell">PKCE Code Challenge Method should be present when Code Challenge is present</td>
276276
<td class="govuk-table__cell"><code class="code--slim">400</code> (Bad Request)</td>
277277
<td class="govuk-table__cell"><code class="code--slim">invalid_request</code></td>
278278
<td class="govuk-table__cell"><code class="code--slim">code_challenge_method should be present when code_challenge is present</code></td>
279279
</tr>
280280
<tr class="govuk-table__row">
281-
<td class="govuk-table__cell">code_challenge should be present when code_challenge_method is present</td>
281+
<td class="govuk-table__cell">PKCE Code Challenge should be present when Code Challenge Method is present</td>
282282
<td class="govuk-table__cell"><code class="code--slim">400</code> (Bad Request)</td>
283283
<td class="govuk-table__cell"><code class="code--slim">invalid_request</code></td>
284284
<td class="govuk-table__cell"><code class="code--slim">code_challenge should be present when code_challenge_method is present</code></td>
@@ -421,7 +421,7 @@ <h5 class="govuk-heading-s faded-text">Example request</h5>
421421
</tr>
422422
<tr class="govuk-table__row">
423423
<td class="govuk-table__cell"><code class="code--slim">code_verifier</code> (optional)</td>
424-
<td class="govuk-table__cell">This is mandatory if <code class="code--slim">code_challenge</code> was provided in the call to <code class="code--slim">/authorize.</code></td>
424+
<td class="govuk-table__cell">The <a class="govuk-link" href="https://oauth.net/2/pkce/">PKCE</a> <code class="code--slim">code_verifier</code> is mandatory if <code class="code--slim">code_challenge</code> was provided in the call to <code class="code--slim">/authorize</code>.</td>
425425
</tr>
426426
</tbody>
427427
</table>
@@ -524,25 +524,25 @@ <h5 class="govuk-heading-s faded-text">Error scenarios</h5>
524524
<td class="govuk-table__cell"><code class="code--slim">code is invalid</code></td>
525525
</tr>
526526
<tr class="govuk-table__row">
527-
<td class="govuk-table__cell">PKCE code_verifier wasn't expected as no code_challenge was provided when requesting an authorization code</td>
527+
<td class="govuk-table__cell">PKCE Code Verifier wasn't expected as no Code Challenge was provided when requesting an authorization code</td>
528528
<td class="govuk-table__cell"><code class="code--slim">400</code> (Bad Request)</td>
529529
<td class="govuk-table__cell"><code class="code--slim">invalid_request</code></td>
530530
<td class="govuk-table__cell"><code class="code--slim">code_verifier is not expected</code></td>
531531
</tr>
532532
<tr class="govuk-table__row">
533-
<td class="govuk-table__cell">PKCE code_verifier was expected but none was supplied</td>
533+
<td class="govuk-table__cell">PKCE Code Verifier was expected but none was supplied</td>
534534
<td class="govuk-table__cell"><code class="code--slim">400</code> (Bad Request)</td>
535535
<td class="govuk-table__cell"><code class="code--slim">invalid_request</code></td>
536536
<td class="govuk-table__cell"><code class="code--slim">code_verifier is expected when code_challenge was supplied</code></td>
537537
</tr>
538538
<tr class="govuk-table__row">
539-
<td class="govuk-table__cell">PKCE code_verifier is made up of fewer than 43, more than 128, or invalid characters</td>
539+
<td class="govuk-table__cell">PKCE Code Verifier is made up of fewer than 43, more than 128, or invalid characters</td>
540540
<td class="govuk-table__cell"><code class="code--slim">400</code> (Bad Request)</td>
541541
<td class="govuk-table__cell"><code class="code--slim">invalid_request</code></td>
542542
<td class="govuk-table__cell"><code class="code--slim">code_verifier must contain valid characters of length between 43 and 128</code></td>
543543
</tr>
544544
<tr class="govuk-table__row">
545-
<td class="govuk-table__cell">PKCE code_verifier does not correlate to code_challenge</td>
545+
<td class="govuk-table__cell">PKCE Code Verifier does not correlate to Code Challenge</td>
546546
<td class="govuk-table__cell"><code class="code--slim">400</code> (Bad Request)</td>
547547
<td class="govuk-table__cell"><code class="code--slim">invalid_grant</code></td>
548548
<td class="govuk-table__cell"><code class="code--slim">code_verifier is invalid</code></td>

0 commit comments

Comments
 (0)