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

ApplicationClient overview

PingOne Applications HTTP Client

Provides functions for managing PingOne applications via the PingOne Management API. Includes operations for creating, reading, updating, and deleting OAuth/OIDC applications.

Added in v0.0.1

Table of contents

API Client

createApplication

Creates an application in PingOne via API

Signature

export declare const createApplication: <S extends Schema.Schema.Type<typeof CreateApplicationRequestSchema>>({
  envId,
  token,
  applicationData
}: {
  envId: string
  token: string
  applicationData: S
}) => Effect.Effect<
  {
    readonly name: string
    readonly id: string
    readonly environment?: { readonly id: string }
    readonly createdAt?: string
    readonly enabled: boolean
    readonly updatedAt?: string
    readonly type: string
    readonly _links?: unknown
    readonly description?: string
    readonly protocol: string
    readonly homePageUrl?: string
    readonly loginPageUrl?: string
    readonly icon?: { readonly id: string; readonly href: string }
    readonly accessControl?: unknown
    readonly grantTypes?: readonly string[]
    readonly tokenEndpointAuthMethod?: string
    readonly redirectUris?: readonly string[]
    readonly postLogoutRedirectUris?: readonly string[]
    readonly responseTypes?: readonly string[]
    readonly pkceEnforcement?: string
    readonly refreshTokenDuration?: number
    readonly refreshTokenRollingDuration?: number
  } & { readonly [x: string]: unknown },
  PingOneApiError | HttpClientError | ParseError | HttpBodyError,
  HttpClient | CredentialService
>

Added in v0.0.1

deleteApplication

Deletes an application from PingOne via API

Signature

export declare const deleteApplication: ({
  envId,
  token,
  applicationId
}: {
  envId: string
  token: string
  applicationId: string
}) => Effect.Effect<any, PingOneApiError | HttpClientError, HttpClient | CredentialService>

Added in v0.0.1

listApplications

Lists applications in PingOne via API

Signature

export declare const listApplications: ({
  envId,
  token,
  limit,
  filter
}: {
  envId: string
  token: string
  limit?: number
  filter?: string
}) => Effect.Effect<
  {
    readonly _embedded: {
      readonly applications: readonly ({
        readonly name: string
        readonly id: string
        readonly environment?: { readonly id: string }
        readonly createdAt?: string
        readonly enabled: boolean
        readonly updatedAt?: string
        readonly type: string
        readonly _links?: unknown
        readonly description?: string
        readonly protocol: string
        readonly homePageUrl?: string
        readonly loginPageUrl?: string
        readonly icon?: { readonly id: string; readonly href: string }
        readonly accessControl?: unknown
        readonly grantTypes?: readonly string[]
        readonly tokenEndpointAuthMethod?: string
        readonly redirectUris?: readonly string[]
        readonly postLogoutRedirectUris?: readonly string[]
        readonly responseTypes?: readonly string[]
        readonly pkceEnforcement?: string
        readonly refreshTokenDuration?: number
        readonly refreshTokenRollingDuration?: number
      } & { readonly [x: string]: unknown })[]
    }
    readonly count?: number
    readonly size?: number
  },
  PingOneApiError | HttpClientError | ParseError,
  HttpClient | CredentialService | CacheService
>

Added in v0.0.1

readApplication

Reads an application from PingOne via API

Signature

export declare const readApplication: ({
  envId,
  token,
  applicationId
}: {
  envId: string
  token: string
  applicationId: string
}) => Effect.Effect<
  {
    readonly name: string
    readonly id: string
    readonly environment?: { readonly id: string }
    readonly createdAt?: string
    readonly enabled: boolean
    readonly updatedAt?: string
    readonly type: string
    readonly _links?: unknown
    readonly description?: string
    readonly protocol: string
    readonly homePageUrl?: string
    readonly loginPageUrl?: string
    readonly icon?: { readonly id: string; readonly href: string }
    readonly accessControl?: unknown
    readonly grantTypes?: readonly string[]
    readonly tokenEndpointAuthMethod?: string
    readonly redirectUris?: readonly string[]
    readonly postLogoutRedirectUris?: readonly string[]
    readonly responseTypes?: readonly string[]
    readonly pkceEnforcement?: string
    readonly refreshTokenDuration?: number
    readonly refreshTokenRollingDuration?: number
  } & { readonly [x: string]: unknown },
  PingOneApiError | HttpClientError | ParseError,
  HttpClient | CredentialService | CacheService
>

Added in v0.0.1

updateApplication

Updates an application in PingOne via API

Signature

export declare const updateApplication: <S extends Schema.Schema.Type<typeof UpdateApplicationRequestSchema>>({
  envId,
  token,
  applicationId,
  applicationData
}: {
  envId: string
  token: string
  applicationId: string
  applicationData: S
}) => Effect.Effect<
  {
    readonly name: string
    readonly id: string
    readonly environment?: { readonly id: string }
    readonly createdAt?: string
    readonly enabled: boolean
    readonly updatedAt?: string
    readonly type: string
    readonly _links?: unknown
    readonly description?: string
    readonly protocol: string
    readonly homePageUrl?: string
    readonly loginPageUrl?: string
    readonly icon?: { readonly id: string; readonly href: string }
    readonly accessControl?: unknown
    readonly grantTypes?: readonly string[]
    readonly tokenEndpointAuthMethod?: string
    readonly redirectUris?: readonly string[]
    readonly postLogoutRedirectUris?: readonly string[]
    readonly responseTypes?: readonly string[]
    readonly pkceEnforcement?: string
    readonly refreshTokenDuration?: number
    readonly refreshTokenRollingDuration?: number
  } & { readonly [x: string]: unknown },
  PingOneApiError | HttpClientError | ParseError | HttpBodyError,
  HttpClient | CredentialService
>

Added in v0.0.1