Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Document configuration for the expiration of the JWT token #1384

Merged
merged 4 commits into from
Aug 31, 2020
Merged

Document configuration for the expiration of the JWT token #1384

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
96ba237
Add expirationInSeconds configuration parameter
balhar-jakub Aug 28, 2020
95d8a9a
Refactor apiml.security.auth.tokenProperties.expirationInSeconds
janan07 Aug 28, 2020
0d45140
Add the slash to the end of the configuration.
balhar-jakub Aug 31, 2020
3ad7b7d
Merge branch 'docs-staging' into rip/GH615/ltpa_expiration
balhar-jakub Aug 31, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
25 changes: 25 additions & 0 deletions docs/user-guide/api-mediation/api-gateway-configuration.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -48,6 +48,31 @@ the following procedure to switch to SAF.

Authentication requests now utilize SAF as the authentication provider. API ML can run without zOSMF present on the system.

### apiml.security.auth.tokenProperties.expirationInSeconds

This property is relevant only when the JWT token is generated by the API Mediation Layer. API ML generation of the JWT token occurs in the following cases:

* z/OSMF is only available as an older version which does not support JWT tokens
* The SAF provider is used

To use a custom configuration for z/OSMF which changes the expiration of LTPA token, it is necessary to also set the expiration in this parameter.

**Note:** The default value is 8 hours which mimicks the 8 hour default expiration of the LTPA token in z/OSMF.

**Follow these steps:**

1. Open the file `<Zowe install directory>/components/api-mediation/bin/start.sh`.
2. Find the line that contains the `-cp ${ROOT_DIR}"/components/api-mediation/gateway-service.jar":/usr/include/java_classes/IRRRacf.jar`.
3. Before this line, add on a new line in the following format
```
-Dapiml.security.auth.tokenProperties.expirationInSeconds={expirationTimeInSeconds} \
```
where:

* `{expirationTimeInSeconds}` refers to the specific time before expiration

3. Restart Zowe&trade.

## Retry policy

In default configuration, retry for all requests is disabled, with one exception: the server retries `GET` requests that finish with status code `503`.
Expand Down