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

PingOneSchemas overview

PingOne User API Schemas

Schema definitions for PingOne user resources. Includes schemas for user CRUD operations, sessions, MFA, and bulk operations.

Added in v0.0.1

Table of contents

utils

PingOneAccountSchema

Schema for account authentication settings

Signature

export declare const PingOneAccountSchema: Schema.Struct<{ canAuthenticate: Schema.optional<typeof Schema.Boolean> }>

Added in v0.0.1

PingOneAddressSchema

Schema for address in update operations

Signature

export declare const PingOneAddressSchema: Schema.Struct<{
  streetAddress: Schema.optional<typeof Schema.String>
  locality: Schema.optional<typeof Schema.String>
  region: Schema.optional<typeof Schema.String>
  postalCode: Schema.optional<typeof Schema.String>
  countryCode: Schema.optional<typeof Schema.String>
}>

Added in v0.0.1

PingOneBulkDeleteResultSchema

Schema for bulk delete result

Signature

export declare const PingOneBulkDeleteResultSchema: Schema.Struct<{
  total: typeof Schema.Number
  successful: typeof Schema.Number
  failed: typeof Schema.Number
  errors: Schema.Array$<Schema.Struct<{ userId: typeof Schema.String; error: typeof Schema.String }>>
}>

Added in v0.0.1

PingOneBulkDeleteUserSchema

Schema for bulk delete user ID

Signature

export declare const PingOneBulkDeleteUserSchema: Schema.Struct<{ userId: typeof Schema.String }>

Added in v0.0.1

PingOneBulkImportResultSchema

Schema for bulk import result

Signature

export declare const PingOneBulkImportResultSchema: Schema.Struct<{
  total: typeof Schema.Number
  successful: typeof Schema.Number
  failed: typeof Schema.Number
  errors: Schema.Array$<
    Schema.Struct<{
      row: typeof Schema.Number
      username: typeof Schema.String
      error: typeof Schema.String
      errorType: Schema.Literal<["validation", "duplicate"]>
    }>
  >
}>

Added in v0.0.1

PingOneBulkImportUserSchema

Schema for bulk import user CSV row

Signature

export declare const PingOneBulkImportUserSchema: Schema.Struct<{
  username: typeof Schema.String
  email: typeof Schema.String
  givenName: Schema.optional<typeof Schema.String>
  familyName: Schema.optional<typeof Schema.String>
  department: Schema.optional<typeof Schema.String>
  populationId: typeof Schema.String
}>

Added in v0.0.1

PingOneCreateUserRequest

Schema for creating a user in PingOne Based on PingOne API documentation

Signature

export declare const PingOneCreateUserRequest: Schema.Struct<{
  username: typeof Schema.String
  email: typeof Schema.String
  name: Schema.optional<
    Schema.Struct<{ given: Schema.optional<typeof Schema.String>; family: Schema.optional<typeof Schema.String> }>
  >
  population: Schema.Struct<{ id: typeof Schema.String }>
  department: Schema.optional<typeof Schema.String>
  locales: Schema.optional<Schema.Array$<typeof Schema.String>>
}>

Added in v0.0.1

PingOneCreateUserResponse

Schema for PingOne API response when creating a user

Signature

export declare const PingOneCreateUserResponse: Schema.Struct<{
  id: typeof Schema.String
  environment: Schema.Struct<{ id: typeof Schema.String }>
  population: Schema.Struct<{ id: typeof Schema.String }>
  createdAt: typeof Schema.String
  email: typeof Schema.String
  enabled: typeof Schema.Boolean
  lifecycle: Schema.Struct<{ status: typeof Schema.String }>
  mfaEnabled: typeof Schema.Boolean
  name: Schema.optional<
    Schema.Struct<{ given: Schema.optional<typeof Schema.String>; family: Schema.optional<typeof Schema.String> }>
  >
  locales: Schema.optional<Schema.Array$<typeof Schema.String>>
  updatedAt: typeof Schema.String
  username: typeof Schema.String
  department: Schema.optional<typeof Schema.String>
  account: Schema.optional<
    Schema.Struct<{
      canAuthenticate: Schema.optional<typeof Schema.Boolean>
      status: Schema.optional<typeof Schema.String>
    }>
  >
  identityProvider: Schema.optional<Schema.Struct<{ type: typeof Schema.String }>>
  verifyStatus: Schema.optional<typeof Schema.String>
  _links: Schema.optional<Schema.Record$<typeof Schema.String, typeof Schema.Unknown>>
}>

Added in v0.0.1

PingOneDeleteMfaDeviceResponse

Schema for delete MFA device response

Signature

export declare const PingOneDeleteMfaDeviceResponse: Schema.Struct<{
  id: typeof Schema.String
  status: typeof Schema.String
}>

Added in v0.0.1

PingOneEnvironmentSchema

Schema for environment reference in PingOne responses

Signature

export declare const PingOneEnvironmentSchema: Schema.Struct<{ id: typeof Schema.String }>

Added in v0.0.1

PingOneExtendedNameSchema

Schema for extended name structure in update operations

Signature

export declare const PingOneExtendedNameSchema: Schema.Struct<{
  formatted: Schema.optional<typeof Schema.String>
  given: Schema.optional<typeof Schema.String>
  middle: Schema.optional<typeof Schema.String>
  family: Schema.optional<typeof Schema.String>
  honorificPrefix: Schema.optional<typeof Schema.String>
  honorificSuffix: Schema.optional<typeof Schema.String>
}>

Added in v0.0.1

PingOneLifecycleSchema

Schema for lifecycle status in PingOne responses

Signature

export declare const PingOneLifecycleSchema: Schema.Struct<{ status: typeof Schema.String }>

Added in v0.0.1

PingOneListMfaDevicesResponse

Schema for list MFA devices response

Signature

export declare const PingOneListMfaDevicesResponse: Schema.Struct<{
  _embedded: Schema.Struct<{
    devices: Schema.Array$<
      Schema.Struct<{
        id: typeof Schema.String
        type: typeof Schema.String
        status: Schema.optional<typeof Schema.String>
        name: Schema.optional<typeof Schema.String>
        nickname: Schema.optional<typeof Schema.String>
        createdAt: typeof Schema.String
        updatedAt: typeof Schema.String
      }>
    >
  }>
  _links: Schema.optional<
    Schema.Struct<{
      self: Schema.optional<Schema.Struct<{ href: typeof Schema.String }>>
      next: Schema.optional<Schema.Struct<{ href: typeof Schema.String }>>
    }>
  >
  count: Schema.optional<typeof Schema.Number>
  size: Schema.optional<typeof Schema.Number>
}>

Added in v0.0.1

PingOneListSessionsResponse

Schema for list sessions response

Signature

export declare const PingOneListSessionsResponse: Schema.Struct<{
  _embedded: Schema.Struct<{
    sessions: Schema.Array$<
      Schema.Struct<{
        id: typeof Schema.String
        createdAt: typeof Schema.String
        expiresAt: Schema.optional<typeof Schema.String>
        lastUsedAt: Schema.optional<typeof Schema.String>
        application: Schema.optional<
          Schema.Struct<{ id: typeof Schema.String; name: Schema.optional<typeof Schema.String> }>
        >
      }>
    >
  }>
  _links: Schema.optional<
    Schema.Struct<{
      self: Schema.optional<Schema.Struct<{ href: typeof Schema.String }>>
      next: Schema.optional<Schema.Struct<{ href: typeof Schema.String }>>
    }>
  >
  count: Schema.optional<typeof Schema.Number>
  size: Schema.optional<typeof Schema.Number>
}>

Added in v0.0.1

PingOneListUsersResponse

Schema for list users response

Signature

export declare const PingOneListUsersResponse: Schema.Struct<{
  _embedded: Schema.Struct<{
    users: Schema.Array$<
      Schema.Struct<{
        id: typeof Schema.String
        environment: Schema.Struct<{ id: typeof Schema.String }>
        population: Schema.Struct<{ id: typeof Schema.String }>
        createdAt: typeof Schema.String
        email: typeof Schema.String
        enabled: typeof Schema.Boolean
        lifecycle: Schema.Struct<{ status: typeof Schema.String }>
        mfaEnabled: typeof Schema.Boolean
        name: Schema.optional<
          Schema.Struct<{ given: Schema.optional<typeof Schema.String>; family: Schema.optional<typeof Schema.String> }>
        >
        locales: Schema.optional<Schema.Array$<typeof Schema.String>>
        updatedAt: typeof Schema.String
        username: typeof Schema.String
        department: Schema.optional<typeof Schema.String>
        account: Schema.optional<
          Schema.Struct<{
            canAuthenticate: Schema.optional<typeof Schema.Boolean>
            status: Schema.optional<typeof Schema.String>
          }>
        >
        identityProvider: Schema.optional<Schema.Struct<{ type: typeof Schema.String }>>
        verifyStatus: Schema.optional<typeof Schema.String>
        _links: Schema.optional<Schema.Record$<typeof Schema.String, typeof Schema.Unknown>>
      }>
    >
  }>
  _links: Schema.optional<
    Schema.Struct<{
      self: Schema.optional<Schema.Struct<{ href: typeof Schema.String }>>
      next: Schema.optional<Schema.Struct<{ href: typeof Schema.String }>>
    }>
  >
  count: Schema.optional<typeof Schema.Number>
  size: Schema.optional<typeof Schema.Number>
}>

Added in v0.0.1

PingOneMfaDeviceSchema

Schema for MFA device information

Signature

export declare const PingOneMfaDeviceSchema: Schema.Struct<{
  id: typeof Schema.String
  type: typeof Schema.String
  status: Schema.optional<typeof Schema.String>
  name: Schema.optional<typeof Schema.String>
  nickname: Schema.optional<typeof Schema.String>
  createdAt: typeof Schema.String
  updatedAt: typeof Schema.String
}>

Added in v0.0.1

PingOnePaginationLinksSchema

Schema for pagination links in list responses

Signature

export declare const PingOnePaginationLinksSchema: Schema.Struct<{
  self: Schema.optional<Schema.Struct<{ href: typeof Schema.String }>>
  next: Schema.optional<Schema.Struct<{ href: typeof Schema.String }>>
}>

Added in v0.0.1

PingOnePasswordResetRequest

Schema for password reset/recovery request

Signature

export declare const PingOnePasswordResetRequest: Schema.Struct<{ email: typeof Schema.String }>

Added in v0.0.1

PingOnePasswordResetResponse

Schema for password reset/recovery response

Signature

export declare const PingOnePasswordResetResponse: Schema.Struct<{
  id: typeof Schema.String
  status: typeof Schema.String
}>

Added in v0.0.1

PingOnePhotoSchema

Schema for photo in update operations

Signature

export declare const PingOnePhotoSchema: Schema.Struct<{ href: typeof Schema.String }>

Added in v0.0.1

PingOnePopulationSchema

Schema for population reference in PingOne

Signature

export declare const PingOnePopulationSchema: Schema.Struct<{ id: typeof Schema.String }>

Added in v0.0.1

PingOneReadUserResponse

Schema for reading a user (same structure as create response)

Signature

export declare const PingOneReadUserResponse: Schema.Struct<{
  id: typeof Schema.String
  environment: Schema.Struct<{ id: typeof Schema.String }>
  population: Schema.Struct<{ id: typeof Schema.String }>
  createdAt: typeof Schema.String
  email: typeof Schema.String
  enabled: typeof Schema.Boolean
  lifecycle: Schema.Struct<{ status: typeof Schema.String }>
  mfaEnabled: typeof Schema.Boolean
  name: Schema.optional<
    Schema.Struct<{ given: Schema.optional<typeof Schema.String>; family: Schema.optional<typeof Schema.String> }>
  >
  locales: Schema.optional<Schema.Array$<typeof Schema.String>>
  updatedAt: typeof Schema.String
  username: typeof Schema.String
  department: Schema.optional<typeof Schema.String>
  account: Schema.optional<
    Schema.Struct<{
      canAuthenticate: Schema.optional<typeof Schema.Boolean>
      status: Schema.optional<typeof Schema.String>
    }>
  >
  identityProvider: Schema.optional<Schema.Struct<{ type: typeof Schema.String }>>
  verifyStatus: Schema.optional<typeof Schema.String>
  _links: Schema.optional<Schema.Record$<typeof Schema.String, typeof Schema.Unknown>>
}>

Added in v0.0.1

PingOneRevokeSessionResponse

Schema for revoke session response

Signature

export declare const PingOneRevokeSessionResponse: Schema.Struct<{
  id: typeof Schema.String
  status: typeof Schema.String
}>

Added in v0.0.1

PingOneSessionSchema

Schema for session information in PingOne

Signature

export declare const PingOneSessionSchema: Schema.Struct<{
  id: typeof Schema.String
  createdAt: typeof Schema.String
  expiresAt: Schema.optional<typeof Schema.String>
  lastUsedAt: Schema.optional<typeof Schema.String>
  application: Schema.optional<Schema.Struct<{ id: typeof Schema.String; name: Schema.optional<typeof Schema.String> }>>
}>

Added in v0.0.1

PingOneSetPasswordRequest

Schema for setting a user’s password

Signature

export declare const PingOneSetPasswordRequest: Schema.Struct<{
  value: typeof Schema.String
  forceChange: Schema.optional<typeof Schema.Boolean>
}>

Added in v0.0.1

PingOneSetPasswordResponse

Schema for set password response

Signature

export declare const PingOneSetPasswordResponse: Schema.Struct<{
  environment: Schema.Struct<{ id: typeof Schema.String }>
  user: Schema.Struct<{ id: typeof Schema.String }>
  passwordPolicy: Schema.Struct<{ id: typeof Schema.String }>
  status: typeof Schema.String
  lastChangedAt: typeof Schema.String
}>

Added in v0.0.1

PingOneUpdateMfaRequest

Schema for updating user MFA status

Signature

export declare const PingOneUpdateMfaRequest: Schema.Struct<{ mfaEnabled: typeof Schema.Boolean }>

Added in v0.0.1

PingOneUpdateMfaResponse

Schema for MFA update response

Signature

export declare const PingOneUpdateMfaResponse: Schema.Struct<{
  id: typeof Schema.String
  environment: Schema.Struct<{ id: typeof Schema.String }>
  mfaEnabled: typeof Schema.Boolean
  updatedAt: typeof Schema.String
}>

Added in v0.0.1

PingOneUpdateUserAccountRequest

Schema for updating user account lock status

Signature

export declare const PingOneUpdateUserAccountRequest: Schema.Struct<{
  account: Schema.Struct<{ canAuthenticate: Schema.optional<typeof Schema.Boolean> }>
}>

Added in v0.0.1

PingOneUpdateUserRequest

Schema for updating a user in PingOne Based on PingOne API documentation for PUT /users/:id

Signature

export declare const PingOneUpdateUserRequest: Schema.Struct<{
  username: Schema.optional<typeof Schema.String>
  name: Schema.optional<
    Schema.Struct<{
      formatted: Schema.optional<typeof Schema.String>
      given: Schema.optional<typeof Schema.String>
      middle: Schema.optional<typeof Schema.String>
      family: Schema.optional<typeof Schema.String>
      honorificPrefix: Schema.optional<typeof Schema.String>
      honorificSuffix: Schema.optional<typeof Schema.String>
    }>
  >
  nickname: Schema.optional<typeof Schema.String>
  title: Schema.optional<typeof Schema.String>
  preferredLanguage: Schema.optional<typeof Schema.String>
  locale: Schema.optional<typeof Schema.String>
  email: Schema.optional<typeof Schema.String>
  primaryPhone: Schema.optional<typeof Schema.String>
  mobilePhone: Schema.optional<typeof Schema.String>
  photo: Schema.optional<Schema.Struct<{ href: typeof Schema.String }>>
  address: Schema.optional<
    Schema.Struct<{
      streetAddress: Schema.optional<typeof Schema.String>
      locality: Schema.optional<typeof Schema.String>
      region: Schema.optional<typeof Schema.String>
      postalCode: Schema.optional<typeof Schema.String>
      countryCode: Schema.optional<typeof Schema.String>
    }>
  >
  accountId: Schema.optional<typeof Schema.String>
  type: Schema.optional<typeof Schema.String>
  timezone: Schema.optional<typeof Schema.String>
}>

Added in v0.0.1

PingOneUpdateUserResponse

Schema for update user response (includes all fields from update request plus system fields)

Signature

export declare const PingOneUpdateUserResponse: Schema.Struct<{
  id: typeof Schema.String
  environment: Schema.Struct<{ id: typeof Schema.String }>
  population: Schema.Struct<{ id: typeof Schema.String }>
  createdAt: typeof Schema.String
  email: Schema.optional<typeof Schema.String>
  enabled: typeof Schema.Boolean
  lifecycle: Schema.Struct<{ status: typeof Schema.String }>
  mfaEnabled: typeof Schema.Boolean
  name: Schema.optional<
    Schema.Struct<{
      formatted: Schema.optional<typeof Schema.String>
      given: Schema.optional<typeof Schema.String>
      middle: Schema.optional<typeof Schema.String>
      family: Schema.optional<typeof Schema.String>
      honorificPrefix: Schema.optional<typeof Schema.String>
      honorificSuffix: Schema.optional<typeof Schema.String>
    }>
  >
  updatedAt: typeof Schema.String
  username: Schema.optional<typeof Schema.String>
  nickname: Schema.optional<typeof Schema.String>
  title: Schema.optional<typeof Schema.String>
  preferredLanguage: Schema.optional<typeof Schema.String>
  locale: Schema.optional<typeof Schema.String>
  primaryPhone: Schema.optional<typeof Schema.String>
  mobilePhone: Schema.optional<typeof Schema.String>
  photo: Schema.optional<Schema.Struct<{ href: typeof Schema.String }>>
  address: Schema.optional<
    Schema.Struct<{
      streetAddress: Schema.optional<typeof Schema.String>
      locality: Schema.optional<typeof Schema.String>
      region: Schema.optional<typeof Schema.String>
      postalCode: Schema.optional<typeof Schema.String>
      countryCode: Schema.optional<typeof Schema.String>
    }>
  >
  accountId: Schema.optional<typeof Schema.String>
  type: Schema.optional<typeof Schema.String>
  timezone: Schema.optional<typeof Schema.String>
}>

Added in v0.0.1

PingOneUpdateUserStatusRequest

Schema for updating user status (enable/disable)

Signature

export declare const PingOneUpdateUserStatusRequest: Schema.Struct<{ enabled: typeof Schema.Boolean }>

Added in v0.0.1

PingOneUserNameSchema

Schema for user name structure in PingOne

Signature

export declare const PingOneUserNameSchema: Schema.Struct<{
  given: Schema.optional<typeof Schema.String>
  family: Schema.optional<typeof Schema.String>
}>

Added in v0.0.1

PingOneUserStatusResponse

Schema for user status update response

Signature

export declare const PingOneUserStatusResponse: Schema.Struct<{
  id: typeof Schema.String
  environment: Schema.Struct<{ id: typeof Schema.String }>
  enabled: typeof Schema.Boolean
  lifecycle: Schema.Struct<{ status: typeof Schema.String }>
  updatedAt: typeof Schema.String
}>

Added in v0.0.1

PingOneVerifyUserRequest

Schema for verifying a user account

Signature

export declare const PingOneVerifyUserRequest: Schema.Struct<{ verificationCode: typeof Schema.String }>

Added in v0.0.1

PingOneVerifyUserResponse

Schema for verify user response (same as read user)

Signature

export declare const PingOneVerifyUserResponse: Schema.Struct<{
  id: typeof Schema.String
  environment: Schema.Struct<{ id: typeof Schema.String }>
  population: Schema.Struct<{ id: typeof Schema.String }>
  createdAt: typeof Schema.String
  email: typeof Schema.String
  enabled: typeof Schema.Boolean
  lifecycle: Schema.Struct<{ status: typeof Schema.String }>
  mfaEnabled: typeof Schema.Boolean
  name: Schema.optional<
    Schema.Struct<{ given: Schema.optional<typeof Schema.String>; family: Schema.optional<typeof Schema.String> }>
  >
  locales: Schema.optional<Schema.Array$<typeof Schema.String>>
  updatedAt: typeof Schema.String
  username: typeof Schema.String
  department: Schema.optional<typeof Schema.String>
  account: Schema.optional<
    Schema.Struct<{
      canAuthenticate: Schema.optional<typeof Schema.Boolean>
      status: Schema.optional<typeof Schema.String>
    }>
  >
  identityProvider: Schema.optional<Schema.Struct<{ type: typeof Schema.String }>>
  verifyStatus: Schema.optional<typeof Schema.String>
  _links: Schema.optional<Schema.Record$<typeof Schema.String, typeof Schema.Unknown>>
}>

Added in v0.0.1