Configuring VS Code Zowe Explorer with Enterprise SSO, Team Profiles, and API Mediation Layer (APIML)
Executive Summary: Configuring VS Code Zowe Explorer with Enterprise SSO, Team Profiles, and API Mediation Layer (APIML)
Elevate mainframe developer productivity by moving from 3270 green-screens to Visual Studio Code. Discover how to configure Zowe Explorer v2 with team configuration profiles (`zowe.config.json`), secure client certificates, and Single Sign-On (SSO) via the Zowe API Mediation Layer.
1 Problem Statement & Architecture Context: Configuring VS Code Zowe Explorer with Enterprise SSO, Team Profiles, and API Mediation Layer (APIML)
Enterprise mainframe developers install the Zowe Explorer extension in VS Code but encounter constant credential prompts, connection timeouts, or SSL handshake failures when connecting to z/OSMF:
Zowe Explorer: Error connecting to session 'zsys1'.
Request failed with status code 401: Unauthorized.
JWT Token expired or APIML routing unavailable.
Developers revert to 3270 emulators because team profile configurations are not standardized across workstations.
2 Technical Root Cause & Architecture Mechanics
Zowe Explorer v2 introduced team configuration files (zowe.config.json):
- Instead of individual engineers storing plaintext credentials in local user profiles, enterprise organizations centralize mainframe gateway endpoints, API Mediation Layer (APIML) URLs, and certificate authorities.
- If the APIML gateway certificate is not trusted by Node.js/VS Code or if JWT token expiration is misconfigured, authentication fails.
3 Implementation Guide & Modernization Strategy
# 1. Initialize an Enterprise Team Configuration
In the root of your developer workspace or home directory, create zowe.config.json:
{
"$schema": "https://zowe.org/schemas/zowe.config.json",
"profiles": {
"base": {
"type": "base",
"properties": {
"host": "apiml.mainframe.stackmf.internal",
"port": 7554,
"rejectUnauthorized": false
},
"secure": []
},
"apiml": {
"type": "apiml",
"properties": {
"authType": "token"
}
},
"zosmf": {
"type": "zosmf",
"properties": {
"port": 443,
"basePath": "/api/v1"
}
}
},
"defaults": {
"base": "base",
"zosmf": "zosmf"
}
}
# 2. Authenticate Using Enterprise SSO / Login Command
Open the VS Code integrated terminal and authenticate to generate an encrypted JSON Web Token (JWT):
zowe auth login apiml
Enter your enterprise RACF / ACF2 / Top Secret credentials. Zowe securely saves the token in your operating system credential vault (Windows Credential Manager / macOS Keychain).
# 3. Access Datasets, USS Files, and JES Spool in VS Code
Open the Zowe Explorer viewlet:
- Under Data Sets, click
+and enter patternPROD.COBOL.*. - Browse, edit, syntax-highlight, and save datasets with instant automatic z/OS synchronization!
- Under Jobs, submit JCL and inspect spool output without ever opening TSO/ISPF!
Technical Specifications Matrix
| Attribute | Specification |
|---|---|
| Target Environment | IBM z/OS • DevOps & Automation |
| Key Technologies | Zowe, VS Code, Zowe Explorer |
| Delivery SLA | Accelerated Sprint Delivery via StackMF Pods |
| Technical Reviewer | Anshu, Chief Technology Architect • StackMF Architecture Pod |
Production Readiness & Verification Checklist
- Store `zowe.config.json` templates in corporate Git repositories for one-click developer onboarding.
- Use Zowe API Mediation Layer (APIML) to route all z/OS services through a single port with SSO.
- Never store plaintext mainframe passwords in `.env` or config files; enforce OS credential vaults.
? Frequently Asked Questions
What is the root cause of Configuring VS Code Zowe Explorer with Enterprise SSO, Team Profiles, and API Mediation Layer (APIML)? ↓
How do you resolve Configuring VS Code Zowe Explorer with Enterprise SSO, Team Profiles, and API Mediation Layer (APIML) in production? ↓
How can teams prevent Configuring VS Code Zowe Explorer with Enterprise SSO, Team Profiles, and API Mediation Layer (APIML) in enterprise pipelines? ↓
Recommended Technical Runbooks
Migrating from Broadcom Endevor to Git & Modern CI/CD using Zowe CLI and IBM DBB
Broadcom CA-7 / CA-11 Decoupling: Migrating 20,000+ JCL Batch Schedules to Stonebranch or Control-M
Building Enterprise REXX Automation: Scripting TSO/E, ISPF Panels, and SDSF Job Parsing
Authoritative Reference Documentation
Official IBM manuals, Redbooks, and vendor technical advisories:
This diagnostic runbook is published by StackMF Technologies LLP for educational and architectural reference only. All code snippets, JCL, and procedures are provided "AS IS" without warranty of any kind. Always test changes thoroughly in non-production sysplex environments prior to production rollout.
IBM, z/OS, CICS, Db2, IMS, RACF, and IDz are registered trademarks of International Business Machines Corporation. Broadcom, CA-7, and Endevor are trademarks of Broadcom Inc. All other trademarks belong to their respective owners and are referenced under the Nominative Fair Use Doctrine (US Lanham Act 15 U.S.C. ยง 1125 / Section 30 of the Indian Trade Marks Act, 1999) solely for technology compatibility and diagnostic identification. StackMF Technologies LLP is an independent consulting entity not affiliated with or endorsed by these vendors. View Full Legal & IP Policy →
Struggling with Critical Mainframe Incidents or Vendor Renewal Pressure?
StackMF deploys certified Senior Mainframe Engineers fluent in both z/OS legacy internals (COBOL, DB2, CICS, VSAM, CA-7, Endevor) and modern cloud stacks (React, Kafka, AWS, Git). Onboard dedicated pods in 48 hours or cut Broadcom licensing by 60%.