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

GroupTypes overview

PingOne Group API TypeScript Types

TypeScript type definitions for group API operations. Defines payload structures for group management functions.

Added in v0.0.1

Table of contents

utils

AddGroupMemberPayload (interface)

Payload for adding a member to a group

Signature

export interface AddGroupMemberPayload {
  envId: string
  token: string
  groupId: string
  userId: string
}

Added in v0.0.1

CreateGroupPayload (interface)

Payload for creating a group

Signature

export interface CreateGroupPayload<S extends Schema.Schema.Type<typeof PingOneCreateGroupRequest>> {
  envId: string
  token: string
  groupData: S
}

Added in v0.0.1

DeleteGroupPayload (interface)

Payload for deleting a group

Signature

export interface DeleteGroupPayload {
  envId: string
  token: string
  groupId: string
}

Added in v0.0.1

ListGroupMembersPayload (interface)

Payload for listing group members

Signature

export interface ListGroupMembersPayload {
  envId: string
  token: string
  groupId: string
  limit?: number
}

Added in v0.0.1

ListGroupsPayload (interface)

Payload for listing groups

Signature

export interface ListGroupsPayload {
  envId: string
  token: string
  limit?: number
  filter?: string
  expand?: string
}

Added in v0.0.1

ReadGroupPayload (interface)

Payload for reading a group

Signature

export interface ReadGroupPayload {
  envId: string
  token: string
  groupId: string
  expand?: string
}

Added in v0.0.1

RemoveGroupMemberPayload (interface)

Payload for removing a member from a group

Signature

export interface RemoveGroupMemberPayload {
  envId: string
  token: string
  groupId: string
  userId: string
}

Added in v0.0.1

UpdateGroupPayload (interface)

Payload for updating a group

Signature

export interface UpdateGroupPayload<S extends Schema.Schema.Type<typeof PingOneUpdateGroupRequest>> {
  envId: string
  token: string
  groupId: string
  groupData: S
}

Added in v0.0.1