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

PingOneTypes overview

PingOne User API TypeScript Types

TypeScript type definitions for user API operations. Defines payload structures for user management, authentication, sessions, MFA, and bulk operations.

Added in v0.0.1

Table of contents

utils

BulkDeleteUsersPayload (interface)

TypeScript interface for bulk delete users payload

Signature

export interface BulkDeleteUsersPayload {
  readonly envId: string
  readonly token: string
  readonly filePath: string
  readonly format: "csv" | "json"
  readonly dryRun?: boolean
  readonly concurrency?: number
}

Added in v0.0.1

BulkExportUsersPayload (interface)

TypeScript interface for bulk export users payload

Signature

export interface BulkExportUsersPayload {
  readonly envId: string
  readonly token: string
  readonly filePath: string
  readonly format: "csv" | "json"
  readonly filter?: string
  readonly limit?: number
}

Added in v0.0.1

BulkImportUsersPayload (interface)

TypeScript interface for bulk import users payload

Signature

export interface BulkImportUsersPayload {
  readonly envId: string
  readonly token: string
  readonly filePath: string
  readonly format: "csv" | "json"
  readonly dryRun?: boolean
  readonly concurrency?: number
}

Added in v0.0.1

CreateUserPayload (interface)

TypeScript interface for PingOne user creation payload

Signature

export interface CreateUserPayload<S> {
  readonly envId: string
  readonly token: string
  readonly userData: S
}

Added in v0.0.1

DeleteMfaDevicePayload (interface)

TypeScript interface for PingOne delete MFA device payload

Signature

export interface DeleteMfaDevicePayload {
  readonly envId: string
  readonly token: string
  readonly userId: string
  readonly deviceId: string
}

Added in v0.0.1

DeleteUserPayload (interface)

TypeScript interface for PingOne delete user payload

Signature

export interface DeleteUserPayload {
  readonly envId: string
  readonly token: string
  readonly userId: string
}

Added in v0.0.1

ListMfaDevicesPayload (interface)

TypeScript interface for PingOne list MFA devices payload

Signature

export interface ListMfaDevicesPayload {
  readonly envId: string
  readonly token: string
  readonly userId: string
  readonly limit?: number
}

Added in v0.0.1

ListUserSessionsPayload (interface)

TypeScript interface for PingOne list user sessions payload

Signature

export interface ListUserSessionsPayload {
  readonly envId: string
  readonly token: string
  readonly userId: string
  readonly limit?: number
}

Added in v0.0.1

ListUsersPayload (interface)

TypeScript interface for PingOne list users payload

Signature

export interface ListUsersPayload {
  readonly envId: string
  readonly token: string
  readonly limit?: number
  readonly filter?: string
}

Added in v0.0.1

PasswordResetPayload (interface)

TypeScript interface for PingOne password reset payload

Signature

export interface PasswordResetPayload<S> {
  readonly envId: string
  readonly token: string
  readonly resetData: S
}

Added in v0.0.1

PingOnePasswordResetData (type alias)

Type alias for PingOne password reset request data

Signature

export type PingOnePasswordResetData = Schema.Schema.Type<typeof PingOnePasswordResetRequest>

Added in v0.0.1

PingOneSetPasswordData (type alias)

Type alias for PingOne set password request data

Signature

export type PingOneSetPasswordData = Schema.Schema.Type<typeof PingOneSetPasswordRequest>

Added in v0.0.1

PingOneUpdateUserData (type alias)

Type alias for PingOne update user request data

Signature

export type PingOneUpdateUserData = Schema.Schema.Type<typeof PingOneUpdateUserRequest>

Added in v0.0.1

PingOneUserData (type alias)

Type alias for PingOne create user request data

Signature

export type PingOneUserData = Schema.Schema.Type<typeof PingOneCreateUserRequest>

Added in v0.0.1

PingOneUserResponse (type alias)

Type alias for PingOne create user response data

Signature

export type PingOneUserResponse = Schema.Schema.Type<typeof PingOneCreateUserResponse>

Added in v0.0.1

PingOneVerifyUserData (type alias)

Type alias for PingOne verify user request data

Signature

export type PingOneVerifyUserData = Schema.Schema.Type<typeof PingOneVerifyUserRequest>

Added in v0.0.1

ReadUserPayload (interface)

TypeScript interface for PingOne read user payload

Signature

export interface ReadUserPayload {
  readonly envId: string
  readonly token: string
  readonly userId: string
}

Added in v0.0.1

RevokeUserSessionPayload (interface)

TypeScript interface for PingOne revoke user session payload

Signature

export interface RevokeUserSessionPayload {
  readonly envId: string
  readonly token: string
  readonly userId: string
  readonly sessionId: string
}

Added in v0.0.1

SetPasswordPayload (interface)

TypeScript interface for PingOne set password payload

Signature

export interface SetPasswordPayload<S> {
  readonly envId: string
  readonly token: string
  readonly userId: string
  readonly passwordData: S
}

Added in v0.0.1

UpdateUserAccountPayload (interface)

TypeScript interface for PingOne update user account payload

Signature

export interface UpdateUserAccountPayload {
  readonly envId: string
  readonly token: string
  readonly userId: string
  readonly canAuthenticate: boolean
}

Added in v0.0.1

UpdateUserMfaPayload (interface)

TypeScript interface for PingOne update user MFA payload

Signature

export interface UpdateUserMfaPayload {
  readonly envId: string
  readonly token: string
  readonly userId: string
  readonly mfaEnabled: boolean
}

Added in v0.0.1

UpdateUserPayload (interface)

TypeScript interface for PingOne update user payload

Signature

export interface UpdateUserPayload<S> {
  readonly envId: string
  readonly token: string
  readonly userId: string
  readonly userData: S
}

Added in v0.0.1

UpdateUserStatusPayload (interface)

TypeScript interface for PingOne update user status payload

Signature

export interface UpdateUserStatusPayload {
  readonly envId: string
  readonly token: string
  readonly userId: string
  readonly enabled: boolean
}

Added in v0.0.1

VerifyUserPayload (interface)

TypeScript interface for PingOne verify user payload

Signature

export interface VerifyUserPayload<S> {
  readonly envId: string
  readonly token: string
  readonly userId: string
  readonly verificationData: S
}

Added in v0.0.1