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

ApplicationSchemas overview

PingOne Application API Schemas

Schema definitions for PingOne application resources. Applications represent OAuth/OIDC clients and other integrations.

Added in v0.0.1

Table of contents

utils

Application (type alias)

Type inferred from ApplicationSchema

Signature

export type Application = typeof ApplicationSchema.Type

Added in v0.0.1

ApplicationSchema

Signature

export declare const ApplicationSchema: Schema.extend<
  Schema.Struct<{
    id: typeof Schema.String
    name: typeof Schema.String
    description: Schema.optional<typeof Schema.String>
    enabled: typeof Schema.Boolean
    type: typeof Schema.String
    protocol: typeof Schema.String
    createdAt: Schema.optional<typeof Schema.String>
    updatedAt: Schema.optional<typeof Schema.String>
    homePageUrl: Schema.optional<typeof Schema.String>
    loginPageUrl: Schema.optional<typeof Schema.String>
    icon: Schema.optional<Schema.Struct<{ id: typeof Schema.String; href: typeof Schema.String }>>
    accessControl: Schema.optional<typeof Schema.Unknown>
    grantTypes: Schema.optional<Schema.Array$<typeof Schema.String>>
    tokenEndpointAuthMethod: Schema.optional<typeof Schema.String>
    redirectUris: Schema.optional<Schema.Array$<typeof Schema.String>>
    postLogoutRedirectUris: Schema.optional<Schema.Array$<typeof Schema.String>>
    responseTypes: Schema.optional<Schema.Array$<typeof Schema.String>>
    pkceEnforcement: Schema.optional<typeof Schema.String>
    refreshTokenDuration: Schema.optional<typeof Schema.Number>
    refreshTokenRollingDuration: Schema.optional<typeof Schema.Number>
    environment: Schema.optional<Schema.Struct<{ id: typeof Schema.String }>>
    _links: Schema.optional<typeof Schema.Unknown>
  }>,
  Schema.Record$<typeof Schema.String, typeof Schema.Unknown>
>

ApplicationsEmbeddedSchema

Schema for embedded applications in list response

Signature

export declare const ApplicationsEmbeddedSchema: Schema.Struct<{
  applications: Schema.Array$<
    Schema.extend<
      Schema.Struct<{
        id: typeof Schema.String
        name: typeof Schema.String
        description: Schema.optional<typeof Schema.String>
        enabled: typeof Schema.Boolean
        type: typeof Schema.String
        protocol: typeof Schema.String
        createdAt: Schema.optional<typeof Schema.String>
        updatedAt: Schema.optional<typeof Schema.String>
        homePageUrl: Schema.optional<typeof Schema.String>
        loginPageUrl: Schema.optional<typeof Schema.String>
        icon: Schema.optional<Schema.Struct<{ id: typeof Schema.String; href: typeof Schema.String }>>
        accessControl: Schema.optional<typeof Schema.Unknown>
        grantTypes: Schema.optional<Schema.Array$<typeof Schema.String>>
        tokenEndpointAuthMethod: Schema.optional<typeof Schema.String>
        redirectUris: Schema.optional<Schema.Array$<typeof Schema.String>>
        postLogoutRedirectUris: Schema.optional<Schema.Array$<typeof Schema.String>>
        responseTypes: Schema.optional<Schema.Array$<typeof Schema.String>>
        pkceEnforcement: Schema.optional<typeof Schema.String>
        refreshTokenDuration: Schema.optional<typeof Schema.Number>
        refreshTokenRollingDuration: Schema.optional<typeof Schema.Number>
        environment: Schema.optional<Schema.Struct<{ id: typeof Schema.String }>>
        _links: Schema.optional<typeof Schema.Unknown>
      }>,
      Schema.Record$<typeof Schema.String, typeof Schema.Unknown>
    >
  >
}>

Added in v0.0.1

CreateApplicationRequest (type alias)

Type for create application request

Signature

export type CreateApplicationRequest = typeof CreateApplicationRequestSchema.Type

Added in v0.0.1

CreateApplicationRequestSchema

Schema for create application request

Signature

export declare const CreateApplicationRequestSchema: Schema.Struct<{
  name: typeof Schema.String
  description: Schema.optional<typeof Schema.String>
  enabled: Schema.optional<typeof Schema.Boolean>
  type: typeof Schema.String
  protocol: typeof Schema.String
}>

Added in v0.0.1

ListApplicationsResponse (type alias)

Type for list applications response

Signature

export type ListApplicationsResponse = typeof ListApplicationsResponseSchema.Type

Added in v0.0.1

ListApplicationsResponseSchema

Schema for list applications response

Signature

export declare const ListApplicationsResponseSchema: Schema.Struct<{
  _embedded: Schema.Struct<{
    applications: Schema.Array$<
      Schema.extend<
        Schema.Struct<{
          id: typeof Schema.String
          name: typeof Schema.String
          description: Schema.optional<typeof Schema.String>
          enabled: typeof Schema.Boolean
          type: typeof Schema.String
          protocol: typeof Schema.String
          createdAt: Schema.optional<typeof Schema.String>
          updatedAt: Schema.optional<typeof Schema.String>
          homePageUrl: Schema.optional<typeof Schema.String>
          loginPageUrl: Schema.optional<typeof Schema.String>
          icon: Schema.optional<Schema.Struct<{ id: typeof Schema.String; href: typeof Schema.String }>>
          accessControl: Schema.optional<typeof Schema.Unknown>
          grantTypes: Schema.optional<Schema.Array$<typeof Schema.String>>
          tokenEndpointAuthMethod: Schema.optional<typeof Schema.String>
          redirectUris: Schema.optional<Schema.Array$<typeof Schema.String>>
          postLogoutRedirectUris: Schema.optional<Schema.Array$<typeof Schema.String>>
          responseTypes: Schema.optional<Schema.Array$<typeof Schema.String>>
          pkceEnforcement: Schema.optional<typeof Schema.String>
          refreshTokenDuration: Schema.optional<typeof Schema.Number>
          refreshTokenRollingDuration: Schema.optional<typeof Schema.Number>
          environment: Schema.optional<Schema.Struct<{ id: typeof Schema.String }>>
          _links: Schema.optional<typeof Schema.Unknown>
        }>,
        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

UpdateApplicationRequest (type alias)

Type for update application request

Signature

export type UpdateApplicationRequest = typeof UpdateApplicationRequestSchema.Type

Added in v0.0.1

UpdateApplicationRequestSchema

Schema for update application request

Signature

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

Added in v0.0.1