Skip to content

Commit

Permalink
Update _security/access-control/authentication-tokens.md
Browse files Browse the repository at this point in the history 
Co-authored-by: kolchfa-aws <[email protected]>
Signed-off-by: Stephen Crawford <[email protected]>
  • Loading branch information
@stephen-crawford @kolchfa-aws
stephen-crawford and kolchfa-aws authored Nov 14, 2023
1 parent b65267e commit 8be7a23
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion _security/access-control/authentication-tokens.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -66,7 +66,7 @@ You can access the `POST /_plugins/_security/api/generateonbehalfoftoken` API en

To access this API endpoint, the request body should contain three API parameters:

* description: This allows the use to articulate the purpose for requesting this token, providing clarity and transparency.
* `description`: This parameter allows the user to articulate the purpose for requesting this token, providing clarity and transparency.
* service (optional): This parameter is directed to the audience claim of the on-behalf-of token. It offers users the opportunity to designate the target service for which they intend to use the token. Although this is an optional parameter, if not specified, the default value is set to "self-issued".
* durationSeconds (optional): This parameter allows users to customize the token's expiration time according to its anticipated usage. However, the maximum duration is capped at 600 seconds to maintain security. If not specified, the default duration is set to 300 seconds.

Check failure on line 71 in _security/access-control/authentication-tokens.md

View workflow job for this annotation

GitHub Actions / style-job 

[vale] reported by reviewdog 🐶
[OpenSearch.Spelling] Error: durationSeconds. If you are referencing a setting, variable, format, function, or repository, surround it with tic marks.

Raw Output:
{"message": "[OpenSearch.Spelling] Error: durationSeconds. If you are referencing a setting, variable, format, function, or repository, surround it with tic marks.", "location": {"path": "_security/access-control/authentication-tokens.md", "range": {"start": {"line": 71, "column": 3}}}, "severity": "ERROR"}
* Here is an example of requesting an on-behalf-of token with lifespan of 3 mins as user '“admin” for testing purpose:

Check failure on line 72 in _security/access-control/authentication-tokens.md

View workflow job for this annotation

GitHub Actions / style-job 

[vale] reported by reviewdog 🐶
[OpenSearch.Spelling] Error: mins. If you are referencing a setting, variable, format, function, or repository, surround it with tic marks.

Raw Output:
{"message": "[OpenSearch.Spelling] Error: mins. If you are referencing a setting, variable, format, function, or repository, surround it with tic marks.", "location": {"path": "_security/access-control/authentication-tokens.md", "range": {"start": {"line": 72, "column": 77}}}, "severity": "ERROR"}
Expand Down

0 comments on commit 8be7a23

Please sign in to comment.