Skip to content

SDK: Add support for allowedLoginMethod - #2895

Open
pujal0909 wants to merge 16 commits into
masterfrom
add-allowed-Login-Method
Open

pujal0909 wants to merge 16 commits into
masterfrom
add-allowed-Login-Method

Conversation

@pujal0909

@pujal0909 pujal0909 commented Sep 15, 2026

Copy link
Copy Markdown
Contributor

What It Does

As an administrator of Team Config files at my site, I would like the ability to indicate which authentication principals users should be prompted to submit when they're logging into services so they are are entering the credentials which are compliant with my site requirements and backend configuration.

  • Added a new property to Team Config as a sibling of authOrder that will allow users to set a preferred login method (allowedLoginMethod)
  • Added AuthOrder to team config schema
  • Included changelog to rebuild schema after these updates
  • Updated isUsingApiml() and added getApimlDecision following design doc spec to the SDKallowedLoginMethod is the first conditional / check within the getApimlDecision heuristic
  • Anywhere SSO/non-SSO is checked within the SDKs, switched to isUsingApiml.

How to Test

See each scenario listed pass in unit tests

Review Checklist
I certify that I have:

  • updated the changelog
  • manually tested my changes
  • added/updated automated unit/integration tests
  • created/ran system tests (provide build number if applicable)
  • followed the contribution guidelines

Additional Comments

Signed-off-by: Pujal <pujal.gandhi@broadcom.com>
@github-project-automation github-project-automation Bot moved this to New Issues in Zowe CLI Squad Sep 15, 2026
@zowe-robot zowe-robot moved this from New Issues to In Progress in Zowe CLI Squad Sep 15, 2026
@codecov

codecov Bot commented Sep 15, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 92.19%. Comparing base (64c2bfc) to head (ffd85d9).
⚠️ Report is 1 commits behind head on master.

Additional details and impacted files
@@           Coverage Diff           @@
##           master    #2895   +/-   ##
=======================================
  Coverage   92.18%   92.19%           
=======================================
  Files         657      658    +1     
  Lines       20610    20636   +26     
  Branches     4570     4574    +4     
=======================================
+ Hits        18999    19025   +26     
  Misses       1607     1607           
  Partials        4        4           

☔ View full report in Codecov by Harness.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

Signed-off-by: Pujal <pujal.gandhi@broadcom.com>
@github-actions

github-actions Bot commented Sep 15, 2026

Copy link
Copy Markdown

Signed-off-by: Pujal <pujal.gandhi@broadcom.com>
@pujal0909 pujal0909 changed the title AllowedLoginMethod SDK: Add support for allowedLoginMethod Sep 16, 2026
Signed-off-by: Pujal <pujal.gandhi@broadcom.com>
@pujal0909 pujal0909 linked an issue Sep 16, 2026 that may be closed by this pull request
Signed-off-by: Pujal <pujal.gandhi@broadcom.com>
Signed-off-by: Pujal <pujal.gandhi@broadcom.com>
Signed-off-by: Pujal <pujal.gandhi@broadcom.com>
Signed-off-by: Pujal <pujal.gandhi@broadcom.com>
Signed-off-by: Pujal <pujal.gandhi@broadcom.com>
Signed-off-by: Pujal <pujal.gandhi@broadcom.com>
@pujal0909
pujal0909 marked this pull request as ready for review September 16, 2026 20:09
@zowe-robot zowe-robot moved this from In Progress to Review/QA in Zowe CLI Squad Sep 16, 2026
@pujal0909
pujal0909 requested a review from anaxceron September 16, 2026 20:09
@github-actions

Copy link
Copy Markdown

📅 Suggested merge-by date: 9/30/2026

traeok
traeok previously requested changes Sep 17, 2026

@traeok traeok left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Thanks for working on this Pujal! I think the snapshots are failing due to a merge commit that left behind conflict markers across multiple files. See my comment below.

Signed-off-by: Pujal <pujal.gandhi@broadcom.com>

@anaxceron anaxceron left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Requesting some minor edits

Comment thread packages/core/CHANGELOG.md Outdated
Comment thread packages/core/CHANGELOG.md Outdated
Comment thread packages/core/CHANGELOG.md Outdated
Comment thread packages/zosmf/CHANGELOG.md Outdated
Signed-off-by: Pujal <pujal.gandhi@broadcom.com>
@pujal0909
pujal0909 requested a review from traeok September 17, 2026 14:19
pujal0909 and others added 4 commits September 17, 2026 10:19
Co-authored-by: anaxceron <ana.ceron@broadcom.com>
Signed-off-by: Pujal Gandhi <71276682+pujal0909@users.noreply.github.com>
Co-authored-by: anaxceron <ana.ceron@broadcom.com>
Signed-off-by: Pujal Gandhi <71276682+pujal0909@users.noreply.github.com>
Co-authored-by: anaxceron <ana.ceron@broadcom.com>
Signed-off-by: Pujal Gandhi <71276682+pujal0909@users.noreply.github.com>
Co-authored-by: anaxceron <ana.ceron@broadcom.com>
Signed-off-by: Pujal Gandhi <71276682+pujal0909@users.noreply.github.com>
@pujal0909
pujal0909 requested a review from anaxceron September 17, 2026 14:25
@traeok

traeok commented Sep 17, 2026

Copy link
Copy Markdown
Member

Kicked off a round of system tests for your PR, job number 2656 👍

@sonarqubecloud

Copy link
Copy Markdown

@traeok
traeok dismissed their stale review September 17, 2026 18:45

Requested changes have been implemented; system tests in job 2656 are all passing

@traeok traeok left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Thanks for working on this Pujal! I left a suggestion but it may be out of scope - I noticed the definition for authOrder was just added so I wanted to mention it while those changes were new. Aside from that, I think the changes should be good to merge

*/
public static readonly BASE_OPTION_AUTH_ORDER: ICommandOptionDefinition = {
name: "auth-order",
description: "A comma separated list of authentication types, in order of precedence, " +

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

I like that we provide the allowable values and an explanation of the default for the new allowedLoginMethod option. In a similar fashion, should we provide the allowed values in this description of authOrder for clarity?

@@ -2,6 +2,9 @@

All notable changes to the Zowe z/OSMF SDK package will be documented in this file.

## Recent Changes
- Enhancement: Added `allowedLoginMethod` and `AuthOrder` options to the z/OSMF profile/schema, allowing users to specifiy those properties to use for z/OSMF operations. [#2653](https://github.com/zowe/zowe-cli/issues/2653)

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

(nitpick) space missing between header and entry

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

Labels

None yet

Projects

Status: Review/QA

Development

Successfully merging this pull request may close these issues.

feat(config): Add preferredLoginMethod to Team Config

4 participants