Skip to content

auth

auth diagnose

Run diagnostic checks against Pega configuration

Usage

bash
pega auth diagnose [flags]

Flags

FlagTypeRequiredDefaultDescription
--formatoptionNojsonOutput format (json, compact, yaml, table)
--fieldsoptionNoComma-separated top-level fields to include in output
--dry-runbooleanNoPrint HTTP request details and exit without executing
--quietbooleanNoSuppress all stderr progress/warning output
--verbosebooleanNoEmit full HTTP request/response details to stderr
--no-cachebooleanNoBypass token file cache; perform fresh OAuth exchange
--profileoptionNodefaultNamed config profile

Examples

sh
pega auth diagnose

auth login

Acquire a fresh OAuth token and cache it

Usage

bash
pega auth login [flags]

Flags

FlagTypeRequiredDefaultDescription
--formatoptionNojsonOutput format (json, compact, yaml, table)
--fieldsoptionNoComma-separated top-level fields to include in output
--dry-runbooleanNoPrint HTTP request details and exit without executing
--quietbooleanNoSuppress all stderr progress/warning output
--verbosebooleanNoEmit full HTTP request/response details to stderr
--no-cachebooleanNoBypass token file cache; perform fresh OAuth exchange
--profileoptionNodefaultNamed config profile

Examples

sh
pega auth login

auth ping

Check Pega API V2 reachability

Usage

bash
pega auth ping [flags]

Flags

FlagTypeRequiredDefaultDescription
--formatoptionNojsonOutput format (json, compact, yaml, table)
--fieldsoptionNoComma-separated top-level fields to include in output
--dry-runbooleanNoPrint HTTP request details and exit without executing
--quietbooleanNoSuppress all stderr progress/warning output
--verbosebooleanNoEmit full HTTP request/response details to stderr
--no-cachebooleanNoBypass token file cache; perform fresh OAuth exchange
--profileoptionNodefaultNamed config profile

Examples

sh
pega auth ping

auth refresh-b2s

Refresh a B2S authentication token

Usage

bash
pega auth refresh-b2s [flags]

Source endpoint: POST /refreshB2Sview command source

Flags

FlagTypeRequiredDefaultDescription
--formatoptionNojsonOutput format (json, compact, yaml, table)
--fieldsoptionNoComma-separated top-level fields to include in output
--dry-runbooleanNoPrint HTTP request details and exit without executing
--quietbooleanNoSuppress all stderr progress/warning output
--verbosebooleanNoEmit full HTTP request/response details to stderr
--no-cachebooleanNoBypass token file cache; perform fresh OAuth exchange
--profileoptionNodefaultNamed config profile
--tokenoptionYesExisting B2S token to refresh

Examples

sh
pega auth refresh-b2s --token OLD_TOKEN