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.

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

updating ESM configuration with identity mapping commands #3642

Merged
merged 16 commits into from
May 14, 2024

Conversation

Shobhajayanna
Copy link
Contributor

Describe your pull request here:

it is to update the ESM configuration with identity mapping commands.

List the file(s) included in this PR:

api-mediation-oidc-authentication.md

After creating the PR, follow the instructions in the comments.

Copy link

github-actions bot commented May 6, 2024

😺 Thank you for creating this PR! To publish your content to Zowe Docs, follow these required steps.

  • Add the label review: doc.
  • Identify your content topic with a label. (Examples: area: apiml, area: cli, area: install and config, etc.)
  • Specify the major Zowe release(s) for your content. (Examples: release: V1, release: V2, release: V3)
    • If adding content that needs to be removed from V3 documentation, add the V3 N/A tag.
  • Select the master branch if your PR updates content that is on the live site. Select docs-staging if your PR updates content for a future release.
  • Notify the Doc Squad about this PR. If you don't know whom should review your content, message the #zowe-doc Slack channel. If you know which Doc Squad writer should approve your content, add that person as a reviewer.

Need help? Contact the Doc Squad in the #zowe-doc Slack channel.

Copy link

github-actions bot commented May 6, 2024

📁 The PR description is missing the file name(s) for the updated content. List all the files included in this PR so this information displays in our Zowe Docs GitHub Slack channel.

If you have addressed this issue already, refresh this page in your browser to remove this comment.

Copy link

github-actions bot commented May 6, 2024

💾 The release label is missing. Add a release: label so your content is published with the correct major Zowe release.

If you have addressed this issue already, refresh this page in your browser to remove this comment.

Copy link

github-actions bot commented May 6, 2024

🔍 The review label is missing. Add a review: label so we can determine who needs to approve this PR.

If you have addressed this issue already, refresh this page in your browser to remove this comment.

Copy link

github-actions bot commented May 6, 2024

📌 The subject area label is missing. Add an area: label so we know what your content is about.

If you have addressed this issue already, refresh this page in your browser to remove this comment.

Copy link

github-actions bot commented May 6, 2024

@github-actions github-actions bot temporarily deployed to pull request May 6, 2024 09:26 Inactive
Comment on lines 88 to 106
- RACF :
RACMAP ID(userid) MAP USERDIDFILTER(NAME('distributed-identity-user-name')) REGISTRY(NAME('distributed-identity-registry-name' )) WITHLABEL('label-name')

SETROPTS RACLIST(IDIDMAP) REFRESH

- ACF2 :
ACF
SET PROFILE(USER) DIVISION(IDMAP)
INSERT userid.ZWEDNMAP IDMAPDN(distributed-identity-user-name) -
IDMAPRN(distributed-identity-registry-name) IDLABEL(label-name)

F ACF2,REBUILD(USR),CLASS(P),DIVISION(IDMAP)
END

- TSS :
TSS ADD(userid) IDMAP(ZWEDNMAP) IDMAPDN('distributed-identity-user-name') -
IDMAPRN('distributed-identity-registry-name') IDLABEL('label-name')

TSS REFRESH
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

See below there are items for RACF, TSS and ACF2 (also remove the CA prefix). These commands should be included in their respective item.

Comment on lines 83 to 85

See the [Identity Federation cli plugin](../../user-guide/cli-idfplugin.md) documentation for details about how to use the plugin tool to set up the mapping in the ESM of your z/OS system.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please rephrase to have first the commands description and then mention the tool as a way to make it easier

@github-actions github-actions bot temporarily deployed to pull request May 6, 2024 13:42 Inactive
@pablocarle pablocarle requested a review from janan07 May 6, 2024 13:56
janan07 and others added 2 commits May 6, 2024 17:03
Signed-off-by: Andrew Jandacek <andrew.jandacek@broadcom.com>
@github-actions github-actions bot temporarily deployed to pull request May 6, 2024 16:01 Inactive
janan07 and others added 2 commits May 7, 2024 13:49
@github-actions github-actions bot temporarily deployed to pull request May 7, 2024 12:35 Inactive
Signed-off-by: Andrew Jandacek <andrew.jandacek@broadcom.com>
Copy link
Collaborator

@janan07 janan07 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Reviewed and edited by doc squad

@github-actions github-actions bot temporarily deployed to pull request May 7, 2024 15:16 Inactive
@@ -57,9 +57,9 @@ Ensure that the following prerequisites are met:
- SAF/ESM is configured with mapping between the mainframe and distributed user identities. For details, see the section [ESM configuration](#esm-configuration) in this topic.
- ZSS must be enabled and properly configured in the Zowe installation.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This needs to be updated, since 2.15 (verify if this is the correct one) ZSS is not mandatory, but it's the default. The alternative is to configure the API ML Gateway to use its internal mapper functionality.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Signed-off-by: Pablo Hernán Carle <pablo.carle@broadcom.com>
- **`distributed-identity-user-name`**
Specifies the user id for distributed-identity-registry
- **`distributed-identity-registry-name`**
Specifies the hostname of the registry
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

is it just the hostname or a full URL?

@github-actions github-actions bot temporarily deployed to pull request May 9, 2024 09:19 Inactive
@github-actions github-actions bot temporarily deployed to pull request May 9, 2024 13:34 Inactive
Signed-off-by: ShobhaJayanna <36433611+Shobhajayanna@users.noreply.github.com>
@github-actions github-actions bot temporarily deployed to pull request May 10, 2024 09:36 Inactive
Signed-off-by: Andrew Jandacek <andrew.jandacek@broadcom.com>
@github-actions github-actions bot temporarily deployed to pull request May 10, 2024 12:37 Inactive
@@ -55,11 +55,11 @@ Ensure that the following prerequisites are met:
- Users who require access to mainframe resources using OIDC authentication have a mainframe identity managed by SAF/ESM.
- Client application users have their distributed identity managed by the OIDC provider. For details, see the section [OIDC provider](#oidc-provider) in this topic.
- SAF/ESM is configured with mapping between the mainframe and distributed user identities. For details, see the section [ESM configuration](#esm-configuration) in this topic.
- ZSS must be enabled and properly configured in the Zowe installation.
- Ensure that the API ML Gateway is configured to use the internal mapper functionality. Alternatively, enable ZSS in the Zowe installation, however using the internal mapper is the recommended method. ZSS is enabled by default.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think this is missing either a link to the internal mapper doc or at least the minimum version of Zowe?

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ok. I'll add his "the mapper feature is available for Zowe release 2.14 and later releases." and this link:
https://docs.zowe.org/stable/user-guide/authenticating-with-client-certificates/#enabling-the-internal-api-ml-mapper

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you

janan07 and others added 2 commits May 13, 2024 15:37
Signed-off-by: Andrew Jandacek <andrew.jandacek@broadcom.com>

Co-authored-by: Pablo Carle <pablocarle@users.noreply.github.com>
Signed-off-by: Andrew Jandacek <andrew.jandacek@broadcom.com>
@github-actions github-actions bot temporarily deployed to pull request May 13, 2024 14:13 Inactive
Signed-off-by: Andrew Jandacek <andrew.jandacek@broadcom.com>
Copy link
Contributor

@pablocarle pablocarle left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you for addressing my comments

Signed-off-by: Andrew Jandacek <andrew.jandacek@broadcom.com>
@github-actions github-actions bot temporarily deployed to pull request May 13, 2024 15:02 Inactive
@github-actions github-actions bot temporarily deployed to pull request May 13, 2024 16:24 Inactive
@Shobhajayanna Shobhajayanna merged commit 0d7fa2f into docs-staging May 14, 2024
4 checks passed
@Shobhajayanna Shobhajayanna deleted the reboot/oidc-mapping-commands branch May 14, 2024 08:03
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants