Skip to content

Updated authenticating-with-client-certificates.md#4868

Open
ArooshLele wants to merge 9 commits intomasterfrom
MVD-7348_Add_a_note_on_DIGTNMAP_page
Open

Updated authenticating-with-client-certificates.md#4868
ArooshLele wants to merge 9 commits intomasterfrom
MVD-7348_Add_a_note_on_DIGTNMAP_page

Conversation

@ArooshLele
Copy link
Collaborator

List the file(s) included in this PR: authenticating-with-client-certificates.md

Describe your pull request here:
A note is added.
The proposed note may be specific for a customer, based on the feedback from that customer. At this stage, it is unknown whether the note is fully factually correct and valid for all customers. If the note needs to include more information, please add SMEs to this Pull Request. They could provide a feedback.
Thank you,
CC: @ArooshLele @gauravs-20

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

Signed-off-by: arooshlele <alele@rocketsoftware.com>
@ArooshLele ArooshLele self-assigned this Dec 22, 2025
@ArooshLele ArooshLele added area: docs Documentation issue or issues that have documentation impact area: apiml This issue is related to Zowe API Mediation Layer area: misc This issue is a miscelleneous doc requirement not for a specific component or area release: V3 Zowe V3 content review: doc Needs review by Doc Squad member review: sme Needs review by an SME labels Dec 22, 2025
@github-actions
Copy link

😺 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.

@github-actions
Copy link

github-actions bot commented Dec 22, 2025

@github-actions github-actions bot temporarily deployed to pull request December 22, 2025 10:55 Inactive
:::

:::note
API ML currently only supports `DIGTNMAP` for certificate-to-user mapping.
Copy link
Contributor

Choose a reason for hiding this comment

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

This is only if disabling the internal mapper, but with internal mapper enabled it supports both mapping and adding the certificate to the user:

https://github.com/zowe/docs-site/pull/4868/changes#diff-aeab6f0cab716353a01b0056f8553738d3b9f5a4242f82bdc67b2641f03acd22R115

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

@pablocarle Thanks for your feedback.

The following is a draft of the reworded note.
Please let me know whether it is correct or whether any information is to be added.
Thanks in advance!

Note:
If the internal mapper is disabled, then API ML only supports DIGTNMAP for certificate-to-user mapping.
If the internal mapper is enabled, then API ML supports the following:

@github-actions github-actions bot temporarily deployed to pull request January 16, 2026 13:39 Inactive
@github-actions github-actions bot temporarily deployed to pull request January 28, 2026 13:45 Inactive
@ArooshLele
Copy link
Collaborator Author

Hello Pablo @pablocarle,
Please review the lines from line 74 to line 77.
The text to be reviewed is:
Note:
If the internal mapper is disabled, then API ML only supports DIGTNMAP for certificate-to-user mapping.
If the internal mapper is enabled, then API ML supports the following:

  • DIGTNMAP for certificate-to-user mapping.
  • Adding the certificate to the user.

CC: @gauravs-20 @ArooshLele @1000TurquoisePogs @hrishikesh-nalawade

@github-actions github-actions bot temporarily deployed to pull request February 12, 2026 12:40 Inactive
Comment on lines 73 to 81
If the internal mapper is disabled, then API ML only supports DIGTNMAP for certificate-to-user mapping.
If the internal mapper is enabled, then API ML supports the following:
- DIGTNMAP for certificate-to-user mapping.
- Adding the certificate to the user.
:::

:::note
API ML currently only supports `DIGTNMAP` for certificate-to-user mapping.
:::
Copy link
Contributor

Choose a reason for hiding this comment

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

This is backwards, the default in v3 is internal mapper:

Internal mapper: supports DIGTNMAP and adding the cert to the user.
ZSS mapper: only supports adding the certificate to the user.

The note says that API ML only supports DIGTNMAP, but this is not true. In the default internal mapper, both are supported.

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

The statement is updated.

@github-actions github-actions bot temporarily deployed to pull request February 13, 2026 10:07 Inactive
Signed-off-by: ArooshLele <alele@rocketsoftware.com>
@github-actions github-actions bot temporarily deployed to pull request February 13, 2026 10:42 Inactive
```

:::tip
:::NOTE
Copy link
Contributor

Choose a reason for hiding this comment

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

is this correct in upper case?

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

is this correct in upper case?

The text is edited. It is now in the lower case.

:::NOTE
In API Mediation Layer, the Internal mapper is enabled by default. The API Mediation Layer hence supports `DIGTNMAP` and adding the certificate to the user, whereas the
`ZSS` mapper only supports adding the certificate to the user.
To disable the API ML mapper, ensure that you set the parameter `components.gateway.apiml.security.useInternalMapper` to `false`.
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 statement should be removed, as it could be confusing, the guide is already written to recommend not changing the default

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

I think this statement should be removed, as it could be confusing, the guide is already written to recommend not changing the default

Noted. The statement [To disable the API ML mapper, ensure that you set the parameter components.gateway.apiml.security.useInternalMapper to false.] is removed.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

area: apiml This issue is related to Zowe API Mediation Layer area: docs Documentation issue or issues that have documentation impact area: misc This issue is a miscelleneous doc requirement not for a specific component or area release: V3 Zowe V3 content review: doc Needs review by Doc Squad member review: sme Needs review by an SME

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants