[PPSC-579] docs(auth): establish JWT as primary authentication method#99
Merged
yiftach-armis merged 1 commit intomainfrom Mar 15, 2026
Merged
Conversation
Update all CLI documentation to position JWT authentication (client_id/client_secret) as the recommended first-class method, with Basic auth (API token/tenant ID) as legacy fallback. - Lead Quick Start and auth sections with JWT examples - Reference VIPR External API screen for obtaining credentials - Update all CI platform examples to use JWT env vars - Add "Recommended"/"Legacy" labels throughout - Note that tenant ID is auto-extracted from JWT token - Fix pre-existing yamllint issues (document-start, indentation) - Fix markdownlint MD036 (use headings instead of bold emphasis)
|
Test Coverage Reporttotal: (statements) 80.8% Coverage by function |
There was a problem hiding this comment.
Pull request overview
This PR updates the CLI documentation to make JWT authentication (ARMIS_CLIENT_ID/ARMIS_CLIENT_SECRET) the primary recommended method, while repositioning Basic auth (ARMIS_API_TOKEN/ARMIS_TENANT_ID) as a legacy fallback across the docs and CI examples.
Changes:
- Reworks authentication sections across core docs/README to recommend JWT first and explain Basic as legacy.
- Updates CI example configurations and docs to use JWT env vars where applicable and adds notes where reusable workflows remain Basic-only.
- Updates SBOM/VEX CI examples to remove explicit
--tenant-idusage in favor of JWT (and/or env-based configuration).
Reviewed changes
Copilot reviewed 13 out of 13 changed files in this pull request and generated 9 comments.
Show a summary per file
| File | Description |
|---|---|
README.md |
Updates auth guidance, flags, CI integration examples, and security notes to prioritize JWT. |
docs/CI-INTEGRATION.md |
Rewrites authentication guidance and updates CI platform snippets to prefer JWT, with reusable-workflow constraints noted. |
docs/CI-SETUP.md |
Updates required secrets, local testing, and troubleshooting to prefer JWT credentials. |
docs/FEATURES.md |
Updates CI example snippet and env var table to emphasize JWT as recommended. |
docs/ci-examples/README.md |
Updates “Required Secrets” section to document JWT as recommended and Basic as legacy. |
docs/ci-examples/gitlab-ci.yml |
Switches GitLab example variables to JWT env vars. |
docs/ci-examples/github-actions.yml |
Updates header comments to mention JWT, but the workflow still uses Basic-only action inputs. |
docs/ci-examples/github-actions-scheduled.yml |
Updates header comments to mention JWT, but workflow uses Basic-only reusable workflow secrets. |
docs/ci-examples/github-actions-reusable.yml |
Adds clarification that reusable workflow is currently Basic-only. |
docs/ci-examples/github-actions-pr-scan.yml |
Updates header comments to mention JWT, but workflow uses Basic-only reusable workflow secrets. |
docs/ci-examples/circleci-config.yml |
Switches CircleCI example environment variables to JWT env vars. |
docs/ci-examples/azure-pipelines.yml |
Switches Azure Pipelines example variables/env to JWT env vars and fixes indentation. |
docs/ci-examples/Jenkinsfile |
Switches Jenkins example credentials to JWT env vars and removes tenant-id usage. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| --tenant-id string Tenant identifier (env: ARMIS_TENANT_ID) | ||
| --client-id string Client ID for JWT authentication (env: ARMIS_CLIENT_ID) [recommended] | ||
| --client-secret string Client secret for JWT authentication (env: ARMIS_CLIENT_SECRET) [recommended] | ||
| --region string Armis cloud region (env: ARMIS_REGION) |
| | `api-token` | Armis API token (Basic auth) | | ||
| | `tenant-id` | Tenant identifier (Basic auth) | | ||
|
|
||
| > **Note:** The reusable workflow currently accepts Basic auth secrets only. For JWT authentication (recommended), use [Option 3: Manual Installation](#option-3-manual-installation) with `ARMIS_CLIENT_ID` and `ARMIS_CLIENT_SECRET` environment variables. |
| - `api-token`: Armis API token for authentication (legacy — JWT support coming soon) | ||
| - `tenant-id`: Tenant identifier for Armis Cloud (legacy — not needed with JWT) | ||
|
|
||
| > **Note:** The reusable workflow currently accepts Basic auth secrets. For JWT authentication in CI, set `ARMIS_CLIENT_ID` and `ARMIS_CLIENT_SECRET` as environment variables directly in your workflow steps (see [Manual Installation](#option-3-manual-installation) below). |
| | `ARMIS_API_TOKEN` | Your Armis API token for authentication | | ||
| | `ARMIS_TENANT_ID` | Your Armis tenant identifier | | ||
| | `ARMIS_API_TOKEN` | API token for Basic authentication | | ||
| | `ARMIS_TENANT_ID` | Tenant identifier (not needed with JWT) | |
| | `ARMIS_CLIENT_ID` | Client ID for JWT authentication (recommended) | | ||
| | `ARMIS_CLIENT_SECRET` | Client secret for JWT authentication (recommended) | | ||
| | `ARMIS_API_TOKEN` | API token for Basic authentication (legacy) | | ||
| | `ARMIS_TENANT_ID` | Tenant identifier (legacy, not needed with JWT) | |
Comment on lines
+7
to
13
| # Required secrets (JWT - recommended): | ||
| # - ARMIS_CLIENT_ID: Client ID from VIPR external API screen | ||
| # - ARMIS_CLIENT_SECRET: Client secret from VIPR external API screen | ||
| # | ||
| # Legacy secrets (Basic auth): | ||
| # - ARMIS_API_TOKEN: Your Armis API token | ||
| # - ARMIS_TENANT_ID: Your Armis tenant identifier |
Comment on lines
+12
to
18
| # Required secrets (JWT - recommended): | ||
| # - ARMIS_CLIENT_ID: Client ID from VIPR external API screen | ||
| # - ARMIS_CLIENT_SECRET: Client secret from VIPR external API screen | ||
| # | ||
| # Legacy secrets (Basic auth): | ||
| # - ARMIS_API_TOKEN: Your Armis API token | ||
| # - ARMIS_TENANT_ID: Your Armis tenant identifier |
Comment on lines
+12
to
18
| # Required secrets (JWT - recommended): | ||
| # - ARMIS_CLIENT_ID: Client ID from VIPR external API screen | ||
| # - ARMIS_CLIENT_SECRET: Client secret from VIPR external API screen | ||
| # | ||
| # Legacy secrets (Basic auth): | ||
| # - ARMIS_API_TOKEN: Your Armis API token | ||
| # - ARMIS_TENANT_ID: Your Armis tenant identifier |
Comment on lines
+40
to
+43
| #### Basic Authentication (Legacy) | ||
|
|
||
| - `ARMIS_API_TOKEN`: API token for Basic authentication | ||
| - `ARMIS_TENANT_ID`: Tenant identifier (not needed with JWT) |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
ARMIS_CLIENT_ID/ARMIS_CLIENT_SECRET) as the recommended first-class methodARMIS_API_TOKEN/ARMIS_TENANT_ID) is repositioned as legacy fallback throughoutFiles Changed
README.md— Quick Start, auth flags, env vars, security considerations, inline CI examplesdocs/CI-INTEGRATION.md— Auth section rewrite, all CI platform examplesdocs/CI-SETUP.md— Required secrets, local testing, troubleshootingdocs/FEATURES.md— Env vars table, SBOM CI exampledocs/ci-examples/*— All 7 CI example files updatedTest plan