auth
auth diagnose
Run diagnostic checks against Pega configuration
Usage
bash
pega auth diagnose [flags]Flags
| Flag | Type | Required | Default | Description |
|---|---|---|---|---|
--format | option | No | json | Output format (json, compact, yaml, table) |
--fields | option | No | Comma-separated top-level fields to include in output | |
--dry-run | boolean | No | Print HTTP request details and exit without executing | |
--quiet | boolean | No | Suppress all stderr progress/warning output | |
--verbose | boolean | No | Emit full HTTP request/response details to stderr | |
--no-cache | boolean | No | Bypass token file cache; perform fresh OAuth exchange | |
--profile | option | No | default | Named config profile |
Examples
sh
pega auth diagnoseauth login
Acquire a fresh OAuth token and cache it
Usage
bash
pega auth login [flags]Flags
| Flag | Type | Required | Default | Description |
|---|---|---|---|---|
--format | option | No | json | Output format (json, compact, yaml, table) |
--fields | option | No | Comma-separated top-level fields to include in output | |
--dry-run | boolean | No | Print HTTP request details and exit without executing | |
--quiet | boolean | No | Suppress all stderr progress/warning output | |
--verbose | boolean | No | Emit full HTTP request/response details to stderr | |
--no-cache | boolean | No | Bypass token file cache; perform fresh OAuth exchange | |
--profile | option | No | default | Named config profile |
Examples
sh
pega auth loginauth ping
Check Pega API V2 reachability
Usage
bash
pega auth ping [flags]Flags
| Flag | Type | Required | Default | Description |
|---|---|---|---|---|
--format | option | No | json | Output format (json, compact, yaml, table) |
--fields | option | No | Comma-separated top-level fields to include in output | |
--dry-run | boolean | No | Print HTTP request details and exit without executing | |
--quiet | boolean | No | Suppress all stderr progress/warning output | |
--verbose | boolean | No | Emit full HTTP request/response details to stderr | |
--no-cache | boolean | No | Bypass token file cache; perform fresh OAuth exchange | |
--profile | option | No | default | Named config profile |
Examples
sh
pega auth pingauth refresh-b2s
Refresh a B2S authentication token
Usage
bash
pega auth refresh-b2s [flags]Source endpoint: POST /refreshB2S — view command source
Flags
| Flag | Type | Required | Default | Description |
|---|---|---|---|---|
--format | option | No | json | Output format (json, compact, yaml, table) |
--fields | option | No | Comma-separated top-level fields to include in output | |
--dry-run | boolean | No | Print HTTP request details and exit without executing | |
--quiet | boolean | No | Suppress all stderr progress/warning output | |
--verbose | boolean | No | Emit full HTTP request/response details to stderr | |
--no-cache | boolean | No | Bypass token file cache; perform fresh OAuth exchange | |
--profile | option | No | default | Named config profile |
--token | option | Yes | Existing B2S token to refresh |
Examples
sh
pega auth refresh-b2s --token OLD_TOKEN