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

EnvironmentSchemas overview

PingOne Environment API Schemas

Schema definitions for PingOne environment resources. Environments are isolated containers for identity configurations.

Added in v0.0.2

Table of contents

Models

Environment (type alias)

Environment type definition

Signature

export type Environment = Schema.Schema.Type<typeof EnvironmentSchema>

Added in v0.0.2

ListEnvironmentsResponse (type alias)

List environments response type definition

Signature

export type ListEnvironmentsResponse = Schema.Schema.Type<typeof ListEnvironmentsResponseSchema>

Added in v0.0.2

Schemas

EnvironmentSchema

Environment schema

Signature

export declare const EnvironmentSchema: Schema.Struct<{
  id: typeof Schema.String
  name: typeof Schema.String
  description: Schema.optional<typeof Schema.String>
  type: Schema.Literal<["PRODUCTION", "SANDBOX"]>
  region: typeof Schema.String
  license: Schema.Struct<{ id: typeof Schema.String; name: Schema.optional<typeof Schema.String> }>
  createdAt: typeof Schema.DateTimeUtc
  updatedAt: typeof Schema.DateTimeUtc
}>

Added in v0.0.2

EnvironmentTypeSchema

Environment type

Signature

export declare const EnvironmentTypeSchema: Schema.Literal<["PRODUCTION", "SANDBOX"]>

Added in v0.0.2

HalLinksSchema

HAL links schema for pagination

Signature

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

Added in v0.0.2

LicenseSchema

License information schema

Signature

export declare const LicenseSchema: Schema.Struct<{
  id: typeof Schema.String
  name: Schema.optional<typeof Schema.String>
}>

Added in v0.0.2

ListEnvironmentsResponseSchema

List environments response schema

Signature

export declare const ListEnvironmentsResponseSchema: Schema.Struct<{
  _embedded: Schema.Struct<{
    environments: Schema.Array$<
      Schema.Struct<{
        id: typeof Schema.String
        name: typeof Schema.String
        description: Schema.optional<typeof Schema.String>
        type: Schema.Literal<["PRODUCTION", "SANDBOX"]>
        region: typeof Schema.String
        license: Schema.Struct<{ id: typeof Schema.String; name: Schema.optional<typeof Schema.String> }>
        createdAt: typeof Schema.DateTimeUtc
        updatedAt: typeof Schema.DateTimeUtc
      }>
    >
  }>
  _links: Schema.optional<
    Schema.Struct<{
      self: Schema.optional<Schema.Struct<{ href: typeof Schema.String }>>
      next: Schema.optional<Schema.Struct<{ href: typeof Schema.String }>>
    }>
  >
}>

Added in v0.0.2