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

GroupSchemas overview

PingOne Group API Schemas

Schema definitions for PingOne group resources. Groups organize users and control access to resources.

Added in v0.0.1

Table of contents

utils

GroupEnvironmentSchema

Schema for environment reference in group responses

Signature

export declare const GroupEnvironmentSchema: Schema.Struct<{ id: typeof Schema.String }>

Added in v0.0.1

GroupMemberSchema

Schema for user reference in group membership

Signature

export declare const GroupMemberSchema: Schema.Struct<{
  id: typeof Schema.String
  _links: Schema.optional<Schema.Struct<{ self: Schema.optional<Schema.Struct<{ href: typeof Schema.String }>> }>>
}>

Added in v0.0.1

GroupPopulationSchema

Schema for population reference in group

Signature

export declare const GroupPopulationSchema: Schema.Struct<{ id: typeof Schema.String }>

Added in v0.0.1

PingOneCreateGroupRequest

Schema for creating a group in PingOne Based on PingOne API documentation

Signature

export declare const PingOneCreateGroupRequest: Schema.Struct<{
  name: typeof Schema.String
  description: Schema.optional<typeof Schema.String>
  population: Schema.optional<Schema.Struct<{ id: typeof Schema.String }>>
  userFilter: Schema.optional<typeof Schema.String>
  externalId: Schema.optional<typeof Schema.String>
}>

Added in v0.0.1

PingOneCreateGroupResponse

Schema for PingOne API response when creating a group

Signature

export declare const PingOneCreateGroupResponse: Schema.Struct<{
  id: typeof Schema.String
  name: typeof Schema.String
  description: Schema.optional<typeof Schema.String>
  environment: Schema.Struct<{ id: typeof Schema.String }>
  population: Schema.optional<Schema.Struct<{ id: typeof Schema.String }>>
  userFilter: Schema.optional<typeof Schema.String>
  externalId: Schema.optional<typeof Schema.String>
  custom: Schema.optional<typeof Schema.Boolean>
  createdAt: Schema.optional<typeof Schema.String>
  updatedAt: Schema.optional<typeof Schema.String>
  totalMemberCounts: Schema.optional<
    Schema.Struct<{ directMembers: typeof Schema.Number; totalMembers: typeof Schema.Number }>
  >
  _links: Schema.optional<Schema.Record$<typeof Schema.String, typeof Schema.Unknown>>
}>

Added in v0.0.1

PingOneListGroupMembersResponse

Schema for list group members response

Signature

export declare const PingOneListGroupMembersResponse: Schema.Struct<{
  _embedded: Schema.Struct<{
    users: Schema.Array$<
      Schema.Struct<{
        id: typeof Schema.String
        _links: Schema.optional<Schema.Struct<{ self: Schema.optional<Schema.Struct<{ href: typeof Schema.String }>> }>>
      }>
    >
  }>
  _links: Schema.optional<
    Schema.Struct<{
      self: Schema.optional<Schema.Struct<{ href: typeof Schema.String }>>
      next: Schema.optional<Schema.Struct<{ href: typeof Schema.String }>>
    }>
  >
  count: Schema.optional<typeof Schema.Number>
  size: Schema.optional<typeof Schema.Number>
}>

Added in v0.0.1

PingOneListGroupsResponse

Schema for list groups response (embedded format)

Signature

export declare const PingOneListGroupsResponse: Schema.Struct<{
  _embedded: Schema.Struct<{
    groups: Schema.Array$<
      Schema.Struct<{
        id: typeof Schema.String
        name: typeof Schema.String
        description: Schema.optional<typeof Schema.String>
        environment: Schema.Struct<{ id: typeof Schema.String }>
        population: Schema.optional<Schema.Struct<{ id: typeof Schema.String }>>
        userFilter: Schema.optional<typeof Schema.String>
        externalId: Schema.optional<typeof Schema.String>
        custom: Schema.optional<typeof Schema.Boolean>
        createdAt: Schema.optional<typeof Schema.String>
        updatedAt: Schema.optional<typeof Schema.String>
        totalMemberCounts: Schema.optional<
          Schema.Struct<{ directMembers: typeof Schema.Number; totalMembers: typeof Schema.Number }>
        >
        _links: Schema.optional<Schema.Record$<typeof Schema.String, typeof Schema.Unknown>>
      }>
    >
  }>
  _links: Schema.optional<
    Schema.Struct<{
      self: Schema.optional<Schema.Struct<{ href: typeof Schema.String }>>
      next: Schema.optional<Schema.Struct<{ href: typeof Schema.String }>>
    }>
  >
  count: Schema.optional<typeof Schema.Number>
  size: Schema.optional<typeof Schema.Number>
}>

Added in v0.0.1

PingOneReadGroupResponse

Schema for reading a group (same structure as create response)

Signature

export declare const PingOneReadGroupResponse: Schema.Struct<{
  id: typeof Schema.String
  name: typeof Schema.String
  description: Schema.optional<typeof Schema.String>
  environment: Schema.Struct<{ id: typeof Schema.String }>
  population: Schema.optional<Schema.Struct<{ id: typeof Schema.String }>>
  userFilter: Schema.optional<typeof Schema.String>
  externalId: Schema.optional<typeof Schema.String>
  custom: Schema.optional<typeof Schema.Boolean>
  createdAt: Schema.optional<typeof Schema.String>
  updatedAt: Schema.optional<typeof Schema.String>
  totalMemberCounts: Schema.optional<
    Schema.Struct<{ directMembers: typeof Schema.Number; totalMembers: typeof Schema.Number }>
  >
  _links: Schema.optional<Schema.Record$<typeof Schema.String, typeof Schema.Unknown>>
}>

Added in v0.0.1

PingOneUpdateGroupRequest

Schema for updating a group in PingOne All fields are optional for PATCH operations

Signature

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

Added in v0.0.1

PingOneUpdateGroupResponse

Schema for update group response

Signature

export declare const PingOneUpdateGroupResponse: Schema.Struct<{
  id: typeof Schema.String
  name: typeof Schema.String
  description: Schema.optional<typeof Schema.String>
  environment: Schema.Struct<{ id: typeof Schema.String }>
  population: Schema.optional<Schema.Struct<{ id: typeof Schema.String }>>
  userFilter: Schema.optional<typeof Schema.String>
  externalId: Schema.optional<typeof Schema.String>
  custom: Schema.optional<typeof Schema.Boolean>
  createdAt: Schema.optional<typeof Schema.String>
  updatedAt: Schema.optional<typeof Schema.String>
  totalMemberCounts: Schema.optional<
    Schema.Struct<{ directMembers: typeof Schema.Number; totalMembers: typeof Schema.Number }>
  >
  _links: Schema.optional<Schema.Record$<typeof Schema.String, typeof Schema.Unknown>>
}>

Added in v0.0.1