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

index overview

PingOne command module aggregating all PingOne-related CLI commands.

Added in v0.0.1


Table of contents


utils

p1Command

Parent p1 command with nested subcommands

Signature

export declare const p1Command: Command.Command<
  "p1",
  OAuthService | FileSystem | HttpClient | CredentialService | CacheService,
  Error | HttpClientError | ParseError | HttpBodyError | PlatformError,
  {
    readonly subcommand: Option<
      | {
          readonly username: string
          readonly email: string
          readonly environmentId: Option<string>
          readonly populationId: string
          readonly pingoneToken: Option<Redacted<string>>
          readonly givenName: Option<string>
          readonly familyName: Option<string>
          readonly department: Option<string>
          readonly locales: Option<string>
        }
      | {
          readonly userId: string
          readonly environmentId: Option<string>
          readonly pingoneToken: Option<Redacted<string>>
        }
      | {
          readonly userId: string
          readonly jsonData: string
          readonly environmentId: Option<string>
          readonly pingoneToken: Option<Redacted<string>>
        }
      | {
          readonly userId: string
          readonly environmentId: Option<string>
          readonly pingoneToken: Option<Redacted<string>>
        }
      | {
          readonly userId: string
          readonly verificationCode: 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 userId: string
          readonly environmentId: Option<string>
          readonly pingoneToken: Option<Redacted<string>>
        }
      | {
          readonly userId: string
          readonly environmentId: Option<string>
          readonly pingoneToken: Option<Redacted<string>>
        }
      | {
          readonly userId: string
          readonly environmentId: Option<string>
          readonly pingoneToken: Option<Redacted<string>>
        }
      | {
          readonly userId: string
          readonly environmentId: Option<string>
          readonly pingoneToken: Option<Redacted<string>>
        }
      | {
          readonly userId: string
          readonly environmentId: Option<string>
          readonly pingoneToken: Option<Redacted<string>>
          readonly limit: Option<number>
        }
      | {
          readonly userId: string
          readonly sessionId: string
          readonly environmentId: Option<string>
          readonly pingoneToken: Option<Redacted<string>>
        }
      | {
          readonly userId: string
          readonly environmentId: Option<string>
          readonly pingoneToken: Option<Redacted<string>>
        }
      | {
          readonly userId: string
          readonly environmentId: Option<string>
          readonly pingoneToken: Option<Redacted<string>>
        }
      | {
          readonly userId: string
          readonly environmentId: Option<string>
          readonly pingoneToken: Option<Redacted<string>>
          readonly limit: Option<number>
        }
      | {
          readonly userId: string
          readonly deviceId: string
          readonly environmentId: Option<string>
          readonly pingoneToken: Option<Redacted<string>>
        }
      | {
          readonly userId: string
          readonly password: Redacted<string>
          readonly environmentId: Option<string>
          readonly pingoneToken: Option<Redacted<string>>
          readonly forceChange: boolean
        }
      | {
          readonly email: string
          readonly environmentId: Option<string>
          readonly pingoneToken: Option<Redacted<string>>
        }
      | {
          readonly email: string
          readonly environmentId: Option<string>
          readonly pingoneToken: Option<Redacted<string>>
        }
      | {
          readonly filePath: string
          readonly environmentId: Option<string>
          readonly pingoneToken: Option<Redacted<string>>
          readonly format: "csv" | "json"
          readonly dryRun: boolean
          readonly concurrency: number
        }
      | {
          readonly filePath: string
          readonly environmentId: Option<string>
          readonly pingoneToken: Option<Redacted<string>>
          readonly format: "csv" | "json"
          readonly filter: Option<string>
          readonly limit: Option<number>
        }
      | {
          readonly filePath: string
          readonly environmentId: Option<string>
          readonly pingoneToken: Option<Redacted<string>>
          readonly format: "csv" | "json"
          readonly confirm: boolean
          readonly dryRun: boolean
          readonly concurrency: number
        }
      | {
          readonly subcommand: Option<
            | {
                readonly name: string
                readonly environmentId: Option<string>
                readonly pingoneToken: Option<Redacted<string>>
                readonly description: Option<string>
                readonly populationId: Option<string>
                readonly userFilter: Option<string>
                readonly externalId: Option<string>
              }
            | {
                readonly groupId: string
                readonly environmentId: Option<string>
                readonly pingoneToken: Option<Redacted<string>>
                readonly expand: Option<string>
              }
            | {
                readonly environmentId: Option<string>
                readonly pingoneToken: Option<Redacted<string>>
                readonly limit: Option<number>
                readonly filter: Option<string>
                readonly expand: Option<string>
              }
            | {
                readonly groupId: string
                readonly environmentId: Option<string>
                readonly pingoneToken: Option<Redacted<string>>
                readonly name: Option<string>
                readonly description: Option<string>
                readonly userFilter: Option<string>
                readonly externalId: Option<string>
              }
            | {
                readonly groupId: string
                readonly environmentId: Option<string>
                readonly pingoneToken: Option<Redacted<string>>
              }
            | {
                readonly groupId: string
                readonly userId: string
                readonly environmentId: Option<string>
                readonly pingoneToken: Option<Redacted<string>>
              }
            | {
                readonly groupId: string
                readonly userId: string
                readonly environmentId: Option<string>
                readonly pingoneToken: Option<Redacted<string>>
              }
            | {
                readonly groupId: string
                readonly environmentId: Option<string>
                readonly pingoneToken: Option<Redacted<string>>
                readonly limit: Option<number>
              }
          >
        }
      | {
          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>>
              }
          >
        }
      | {
          readonly subcommand: Option<
            | {
                readonly name: string
                readonly environmentId: Option<string>
                readonly pingoneToken: Option<Redacted<string>>
                readonly description: Option<string>
                readonly type: string
                readonly protocol: string
                readonly enabled: boolean
              }
            | {
                readonly applicationId: 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 applicationId: string
                readonly environmentId: Option<string>
                readonly pingoneToken: Option<Redacted<string>>
                readonly name: Option<string>
                readonly description: Option<string>
                readonly enabled: Option<boolean>
              }
            | {
                readonly applicationId: string
                readonly environmentId: Option<string>
                readonly pingoneToken: Option<Redacted<string>>
              }
          >
        }
    >
  }
>

Added in v0.0.1