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

EnvironmentClient overview

PingOne Environments HTTP Client

Provides functions for managing PingOne environments via the PingOne Management API. Includes operations for reading and listing environments.

Added in v0.0.2

Table of contents

API Client

listEnvironments

Lists environments

Signature

export declare const listEnvironments: ({
  token,
  limit,
  filter
}: {
  token: string
  limit?: number
  filter?: string
}) => Effect.Effect<
  {
    readonly _links?: { readonly self?: { readonly href: string }; readonly next?: { readonly href: string } }
    readonly _embedded: {
      readonly environments: readonly {
        readonly region: string
        readonly name: string
        readonly id: string
        readonly createdAt: Utc
        readonly updatedAt: Utc
        readonly type: "PRODUCTION" | "SANDBOX"
        readonly description?: string
        readonly license: { readonly name?: string; readonly id: string }
      }[]
    }
  },
  PingOneApiError | HttpClientError | ParseError,
  HttpClient | CredentialService | CacheService
>

Added in v0.0.2

readEnvironment

Reads an environment by ID

Signature

export declare const readEnvironment: ({
  token,
  environmentId
}: {
  token: string
  environmentId: string
}) => Effect.Effect<
  {
    readonly region: string
    readonly name: string
    readonly id: string
    readonly createdAt: Utc
    readonly updatedAt: Utc
    readonly type: "PRODUCTION" | "SANDBOX"
    readonly description?: string
    readonly license: { readonly name?: string; readonly id: string }
  },
  PingOneApiError | HttpClientError | ParseError,
  HttpClient | CredentialService | CacheService
>

Added in v0.0.2