Skip to main content Link Search Menu Expand Document (external link)
ping-cli

index overview

Auth Commands

Commands for managing OAuth authentication credentials.

Added in v0.0.3

Table of contents

utils

authCommand

Auth command group.

Manages OAuth client credentials authentication.

Available subcommands:

  • login: Store OAuth credentials
  • logout: Clear stored credentials
  • status: Show authentication status

Signature

export declare const authCommand: Command.Command<
  "auth",
  OAuthService | Prompt.Environment,
  QuitException | OAuthFlowError,
  {
    readonly subcommand: Option<
      | {
          readonly clientId: Option<string>
          readonly clientSecret: Option<Redacted<string>>
          readonly environmentId: Option<string>
          readonly region: Option<"com" | "eu" | "asia" | "ca">
        }
      | {}
      | {}
    >
  }
>

Added in v0.0.3