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

PopulationSchemas overview

PingOne Population API Schemas

Schema definitions for PingOne population resources. Populations are containers for organizing users with shared policies.

Added in v0.0.1

Table of contents

utils

CreatePopulationRequest (type alias)

Type for create population request

Signature

export type CreatePopulationRequest = typeof CreatePopulationRequestSchema.Type

Added in v0.0.1

CreatePopulationRequestSchema

Schema for population creation request

Signature

export declare const CreatePopulationRequestSchema: Schema.Struct<{
  name: typeof Schema.String
  description: Schema.optional<typeof Schema.String>
}>

Added in v0.0.1

ListPopulationsResponse (type alias)

Type for list populations response

Signature

export type ListPopulationsResponse = typeof ListPopulationsResponseSchema.Type

Added in v0.0.1

ListPopulationsResponseSchema

Schema for the list populations response

Signature

export declare const ListPopulationsResponseSchema: Schema.Struct<{
  _embedded: Schema.Struct<{
    populations: Schema.Array$<
      Schema.Struct<{
        id: typeof Schema.String
        name: typeof Schema.String
        description: Schema.optional<typeof Schema.String>
        default: typeof Schema.Boolean
        passwordPolicy: Schema.optional<Schema.Struct<{ id: typeof Schema.String }>>
        environment: Schema.optional<Schema.Struct<{ id: typeof Schema.String }>>
        userCount: Schema.optional<typeof Schema.Number>
        preferredLanguage: Schema.optional<typeof Schema.String>
        theme: Schema.optional<Schema.Struct<{ id: typeof Schema.String }>>
        createdAt: Schema.optional<typeof Schema.String>
        updatedAt: Schema.optional<typeof Schema.String>
        _links: Schema.optional<Schema.Record$<typeof Schema.String, typeof Schema.Unknown>>
      }>
    >
  }>
  count: Schema.optional<typeof Schema.Number>
  size: Schema.optional<typeof Schema.Number>
}>

Added in v0.0.1

Population (type alias)

Type inferred from PopulationSchema

Signature

export type Population = typeof PopulationSchema.Type

Added in v0.0.1

PopulationSchema

Schema for Population in PingOne

Signature

export declare const PopulationSchema: Schema.Struct<{
  id: typeof Schema.String
  name: typeof Schema.String
  description: Schema.optional<typeof Schema.String>
  default: typeof Schema.Boolean
  passwordPolicy: Schema.optional<Schema.Struct<{ id: typeof Schema.String }>>
  environment: Schema.optional<Schema.Struct<{ id: typeof Schema.String }>>
  userCount: Schema.optional<typeof Schema.Number>
  preferredLanguage: Schema.optional<typeof Schema.String>
  theme: Schema.optional<Schema.Struct<{ id: typeof Schema.String }>>
  createdAt: Schema.optional<typeof Schema.String>
  updatedAt: Schema.optional<typeof Schema.String>
  _links: Schema.optional<Schema.Record$<typeof Schema.String, typeof Schema.Unknown>>
}>

Added in v0.0.1

PopulationsEmbeddedSchema

Schema for the embedded populations response

Signature

export declare const PopulationsEmbeddedSchema: Schema.Struct<{
  populations: Schema.Array$<
    Schema.Struct<{
      id: typeof Schema.String
      name: typeof Schema.String
      description: Schema.optional<typeof Schema.String>
      default: typeof Schema.Boolean
      passwordPolicy: Schema.optional<Schema.Struct<{ id: typeof Schema.String }>>
      environment: Schema.optional<Schema.Struct<{ id: typeof Schema.String }>>
      userCount: Schema.optional<typeof Schema.Number>
      preferredLanguage: Schema.optional<typeof Schema.String>
      theme: Schema.optional<Schema.Struct<{ id: typeof Schema.String }>>
      createdAt: Schema.optional<typeof Schema.String>
      updatedAt: Schema.optional<typeof Schema.String>
      _links: Schema.optional<Schema.Record$<typeof Schema.String, typeof Schema.Unknown>>
    }>
  >
}>

Added in v0.0.1

UpdatePopulationRequest (type alias)

Type for update population request

Signature

export type UpdatePopulationRequest = typeof UpdatePopulationRequestSchema.Type

Added in v0.0.1

UpdatePopulationRequestSchema

Schema for population update request

Signature

export declare const UpdatePopulationRequestSchema: Schema.Struct<{
  name: Schema.optional<typeof Schema.String>
  description: Schema.optional<typeof Schema.String>
}>

Added in v0.0.1