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

BulkOperations overview

Bulk Operations for PingOne Users

Provides functions for bulk import, export, and delete operations. Uses Effect concurrency for efficient parallel processing.

Added in v0.0.1

Table of contents

utils

bulkDeleteUsers

Bulk delete users from CSV or JSON file containing user IDs

Signature

export declare const bulkDeleteUsers: ({
  envId,
  token,
  filePath,
  format,
  dryRun,
  concurrency
}: BulkDeleteUsersPayload) => Effect.Effect<
  {
    readonly total: number
    readonly successful: number
    readonly failed: number
    readonly errors: readonly { readonly userId: string; readonly error: string }[]
  },
  Error | ParseError | PlatformError,
  FileSystem.FileSystem | HttpClient | CredentialService
>

Added in v0.0.1

bulkExportUsers

Bulk export users to CSV or JSON file

Signature

export declare const bulkExportUsers: ({
  envId,
  token,
  filePath,
  format,
  filter,
  limit
}: BulkExportUsersPayload) => Effect.Effect<
  { exported: number; filePath: string; format: "csv" | "json" },
  PingOneApiError | HttpClientError | ParseError | PlatformError,
  FileSystem.FileSystem | HttpClient | CredentialService | CacheService
>

Added in v0.0.1

bulkImportUsers

Bulk import users from CSV or JSON file

Signature

export declare const bulkImportUsers: ({
  envId,
  token,
  filePath,
  format,
  dryRun,
  concurrency
}: BulkImportUsersPayload) => Effect.Effect<
  {
    readonly total: number
    readonly successful: number
    readonly failed: number
    readonly errors: readonly {
      readonly username: string
      readonly row: number
      readonly error: string
      readonly errorType: "validation" | "duplicate"
    }[]
  },
  Error | ParseError | PlatformError,
  FileSystem.FileSystem | HttpClient | CredentialService
>

Added in v0.0.1