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

index overview

PingOne population management commands - entry point for all population-related CLI commands.

Added in v0.0.1

Table of contents

utils

populationsCommand

Parent populations command with nested subcommands

Signature

export declare const populationsCommand: Command.Command<
  "populations",
  OAuthService | HttpClient | CredentialService | CacheService,
  PingOneValidationError | PingOneAuthError,
  {
    readonly subcommand: Option<
      | {
          readonly name: string
          readonly environmentId: Option<string>
          readonly pingoneToken: Option<Redacted<string>>
          readonly description: Option<string>
        }
      | {
          readonly populationId: string
          readonly environmentId: Option<string>
          readonly pingoneToken: Option<Redacted<string>>
        }
      | {
          readonly environmentId: Option<string>
          readonly pingoneToken: Option<Redacted<string>>
          readonly limit: Option<number>
          readonly filter: Option<string>
        }
      | {
          readonly populationId: string
          readonly environmentId: Option<string>
          readonly pingoneToken: Option<Redacted<string>>
          readonly name: Option<string>
          readonly description: Option<string>
        }
      | {
          readonly populationId: string
          readonly environmentId: Option<string>
          readonly pingoneToken: Option<Redacted<string>>
        }
    >
  }
>

Added in v0.0.1