Skip to content

Commit

Permalink
Merge pull request #3977 from zowe/fix/cookie-name-config
Browse files Browse the repository at this point in the history
Add missing details for APIML cookie config
  • Loading branch information
janan07 authored Nov 14, 2024
2 parents fd25678 + b34fca1 commit 0789c24
Show file tree
Hide file tree
Showing 5 changed files with 40 additions and 25 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -8,11 +8,14 @@ To prevent overwriting of the default cookie name in the case of multiple Zowe i

Follow this procedure to configure a unique cookie name for the instances:

1. Open the `zowe.yaml` configuration file.
2. Find or add the property `components.gateway.apiml.security.auth.uniqueCookie`, and set it to `true`. A unique cookie name is generated as `apimlAuthenticationToken.cookieIdentifier`.
1. Open the Zowe YAML configuration file.
2. Find or add the property `components.gateway.apiml.security.auth.uniqueCookie`, and set it to `true`.
3. Find the property `zowe.cookieIdentifier` and set it to any word or number that you wish to identify your Zowe instance.
4. Restart Zowe.

This sets a suffix for the API Gateway's cookie name based upon the value of `zowe.cookieIdentifier`.

**Example:**
If this parameter is set to `true`, and the cookieIdentifier is `1`, the name of the cookie transforms to `apimlAuthenticationToken.1`.
If this property is not set to `true`, the cookie name remains `apimlAuthenticationToken` by default.
If the `components.gateway.apiml.security.auth.uniqueCookie` parameter is set to `true` and `zowe.cookieIdentifier` is `1`, the cookie name is `apimlAuthenticationToken.1`.
If this property is not set to `true`, the cookie name remains the default value `apimlAuthenticationToken`.

3. Restart Zowe.
Original file line number Diff line number Diff line change
Expand Up @@ -8,11 +8,14 @@ To prevent overwriting of the default cookie name in the case of multiple Zowe i

Follow this procedure to configure a unique cookie name for the instances:

1. Open the `zowe.yaml` configuration file.
2. Find or add the property `components.gateway.apiml.security.auth.uniqueCookie`, and set it to `true`. A unique cookie name is generated as `apimlAuthenticationToken.cookieIdentifier`.
1. Open the Zowe YAML configuration file.
2. Find or add the property `components.gateway.apiml.security.auth.uniqueCookie`, and set it to `true`.
3. Find the property `zowe.cookieIdentifier` and set it to any word or number that you wish to identify your Zowe instance.
4. Restart Zowe.

This sets a suffix for the API Gateway's cookie name based upon the value of `zowe.cookieIdentifier`.

**Example:**
If this parameter is set to `true`, and the cookieIdentifier is `1`, the name of the cookie transforms to `apimlAuthenticationToken.1`.
If this property is not set to `true`, the cookie name remains `apimlAuthenticationToken` by default.
If the `components.gateway.apiml.security.auth.uniqueCookie` parameter is set to `true` and `zowe.cookieIdentifier` is `1`, the cookie name is `apimlAuthenticationToken.1`.
If this property is not set to `true`, the cookie name remains the default value `apimlAuthenticationToken`.

3. Restart Zowe.
Original file line number Diff line number Diff line change
Expand Up @@ -8,11 +8,14 @@ To prevent overwriting of the default cookie name in the case of multiple Zowe i

Follow this procedure to configure a unique cookie name for the instances:

1. Open the `zowe.yaml` configuration file.
2. Find or add the property `components.gateway.apiml.security.auth.uniqueCookie`, and set it to `true`. A unique cookie name is generated as `apimlAuthenticationToken.cookieIdentifier`.
1. Open the Zowe YAML configuration file.
2. Find or add the property `components.gateway.apiml.security.auth.uniqueCookie`, and set it to `true`.
3. Find the property `zowe.cookieIdentifier` and set it to any word or number that you wish to identify your Zowe instance.
4. Restart Zowe.

This sets a suffix for the API Gateway's cookie name based upon the value of `zowe.cookieIdentifier`.

**Example:**
If this parameter is set to `true`, and the cookieIdentifier is `1`, the name of the cookie transforms to `apimlAuthenticationToken.1`.
If this property is not set to `true`, the cookie name remains `apimlAuthenticationToken` by default.
If the `components.gateway.apiml.security.auth.uniqueCookie` parameter is set to `true` and `zowe.cookieIdentifier` is `1`, the cookie name is `apimlAuthenticationToken.1`.
If this property is not set to `true`, the cookie name remains the default value `apimlAuthenticationToken`.

3. Restart Zowe.
Original file line number Diff line number Diff line change
Expand Up @@ -8,11 +8,14 @@ To prevent overwriting of the default cookie name in the case of multiple Zowe i

Follow this procedure to configure a unique cookie name for the instances:

1. Open the `zowe.yaml` configuration file.
2. Find or add the property `components.gateway.apiml.security.auth.uniqueCookie`, and set it to `true`. A unique cookie name is generated as `apimlAuthenticationToken.cookieIdentifier`.
1. Open the Zowe YAML configuration file.
2. Find or add the property `components.gateway.apiml.security.auth.uniqueCookie`, and set it to `true`.
3. Find the property `zowe.cookieIdentifier` and set it to any word or number that you wish to identify your Zowe instance.
4. Restart Zowe.

This sets a suffix for the API Gateway's cookie name based upon the value of `zowe.cookieIdentifier`.

**Example:**
If this parameter is set to `true`, and the cookieIdentifier is `1`, the name of the cookie transforms to `apimlAuthenticationToken.1`.
If this property is not set to `true`, the cookie name remains `apimlAuthenticationToken` by default.
If the `components.gateway.apiml.security.auth.uniqueCookie` parameter is set to `true` and `zowe.cookieIdentifier` is `1`, the cookie name is `apimlAuthenticationToken.1`.
If this property is not set to `true`, the cookie name remains the default value `apimlAuthenticationToken`.

3. Restart Zowe.
Original file line number Diff line number Diff line change
Expand Up @@ -8,11 +8,14 @@ To prevent overwriting of the default cookie name in the case of multiple Zowe i

Follow this procedure to configure a unique cookie name for the instances:

1. Open the `zowe.yaml` configuration file.
2. Find or add the property `components.gateway.apiml.security.auth.uniqueCookie`, and set it to `true`. A unique cookie name is generated as `apimlAuthenticationToken.cookieIdentifier`.
1. Open the Zowe YAML configuration file.
2. Find or add the property `components.gateway.apiml.security.auth.uniqueCookie`, and set it to `true`.
3. Find the property `zowe.cookieIdentifier` and set it to any word or number that you wish to identify your Zowe instance.
4. Restart Zowe.

This sets a suffix for the API Gateway's cookie name based upon the value of `zowe.cookieIdentifier`.

**Example:**
If this parameter is set to `true`, and the cookieIdentifier is `1`, the name of the cookie transforms to `apimlAuthenticationToken.1`.
If this property is not set to `true`, the cookie name remains `apimlAuthenticationToken` by default.
If the `components.gateway.apiml.security.auth.uniqueCookie` parameter is set to `true` and `zowe.cookieIdentifier` is `1`, the cookie name is `apimlAuthenticationToken.1`.
If this property is not set to `true`, the cookie name remains the default value `apimlAuthenticationToken`.

3. Restart Zowe.

0 comments on commit 0789c24

Please sign in to comment.