---
title: "ListKongPrincipalIdentities"
url: "https://nov18-dev.movespot.fyi/apis/konnect-kong-identity-admin-api-dev-0/versions/cf61fd14-4802-4fa9-ad7b-534e50226211/schemas/ListKongPrincipalIdentities"
---

> Full API specification: https://nov18-dev.movespot.fyi/apis/konnect-kong-identity-admin-api-dev-0/versions/cf61fd14-4802-4fa9-ad7b-534e50226211.md

# ListKongPrincipalIdentities

## OpenAPI definition

```yaml
openapi: 3.0.3
info:
  title: Konnect Kong Identity admin api
  version: 0.0.2
servers:
  - url: https://us.api.konghq.com/v2
    description: United-States Production region
  - url: https://eu.api.konghq.com/v2
    description: Europe Production region
  - url: https://au.api.konghq.com/v2
    description: Australia Production region
  - url: https://me.api.konghq.com/v2
    description: Middle-East Production region
  - url: https://in.api.konghq.com/v2
    description: India Production region
  - url: https://sg.api.konghq.com/v2
    description: Singapore Production region
components:
  schemas:
    CursorMetaPage:
      type: object
      properties:
        first:
          description: URI to the first page
          type: string
          format: path
        last:
          description: URI to the last page
          type: string
          format: path
        next:
          description: URI to the next page
          type: string
          format: path
          nullable: true
        previous:
          description: URI to the previous page
          type: string
          format: path
          nullable: true
        size:
          description: Requested page size
          type: number
          example: 10
      required:
        - size
        - next
        - previous
    KongPrincipalIdentity:
      discriminator:
        propertyName: type
        mapping:
          oidc: "#/components/schemas/KongPrincipalIdentityOIDCResponse"
          auth_server_client: "#/components/schemas/KongPrincipalIdentityAuthServerClientResponse"
          control_plane_consumer: "#/components/schemas/KongPrincipalIdentityCPConsumerResponse"
          custom: "#/components/schemas/KongPrincipalIdentityCustomResponse"
      oneOf:
        - $ref: "#/components/schemas/KongPrincipalIdentityOIDCResponse"
        - $ref: "#/components/schemas/KongPrincipalIdentityAuthServerClientResponse"
        - $ref: "#/components/schemas/KongPrincipalIdentityCPConsumerResponse"
        - $ref: "#/components/schemas/KongPrincipalIdentityCustomResponse"
    KongPrincipalIdentityOIDCResponse:
      allOf:
        - $ref: "#/components/schemas/KongPrincipalIdentityResponseBase"
        - type: object
          properties:
            type:
              type: string
              enum:
                - oidc
            issuer:
              type: string
            claim:
              type: object
              properties:
                name:
                  type: string
                value:
                  type: string
              required:
                - name
                - value
          required:
            - type
            - issuer
            - claim
    KongPrincipalIdentityAuthServerClientResponse:
      allOf:
        - $ref: "#/components/schemas/KongPrincipalIdentityResponseBase"
        - type: object
          properties:
            type:
              type: string
              enum:
                - auth_server_client
            auth_server_id:
              type: string
              format: uuid
            client_id:
              type: string
          required:
            - type
            - auth_server_id
            - client_id
    KongPrincipalIdentityCPConsumerResponse:
      allOf:
        - $ref: "#/components/schemas/KongPrincipalIdentityResponseBase"
        - type: object
          properties:
            type:
              type: string
              enum:
                - control_plane_consumer
            control_plane_id:
              type: string
            consumer_id:
              type: string
            workspace_id:
              type: string
          required:
            - type
            - control_plane_id
            - consumer_id
    KongPrincipalIdentityCustomResponse:
      allOf:
        - $ref: "#/components/schemas/KongPrincipalIdentityResponseBase"
        - type: object
          properties:
            type:
              type: string
              enum:
                - custom
            key:
              type: string
            value:
              type: string
          required:
            - type
            - key
            - value
    KongPrincipalIdentityResponseBase:
      allOf:
        - $ref: "#/components/schemas/KongPrincipalIdentityBase"
        - type: object
          required:
            - labels
    KongPrincipalIdentityBase:
      type: object
      properties:
        id:
          $ref: "#/components/schemas/UUID"
        labels:
          $ref: "#/components/schemas/Labels"
        created_at:
          $ref: "#/components/schemas/CreatedAt"
        updated_at:
          $ref: "#/components/schemas/UpdatedAt"
      required:
        - id
        - created_at
        - updated_at
    UUID:
      description: Contains a unique identifier used for this resource.
      type: string
      format: uuid
      example: 5f9fd312-a987-4628-b4c5-bb4f4fddd5f7
      readOnly: true
    Labels:
      description: >
        Labels store metadata of an entity that can be used for filtering an
        entity list or for searching across entity types. 


        Keys must be of length 1-63 characters, and cannot start with "kong",
        "konnect", "mesh", "kic", or "_".
      type: object
      example:
        env: test
      additionalProperties:
        type: string
        pattern: ^[a-z0-9A-Z]{1}([a-z0-9A-Z-._]*[a-z0-9A-Z]+)?$
        minLength: 1
        maxLength: 63
      maxProperties: 50
      title: Labels
    CreatedAt:
      description: An ISO-8601 timestamp representation of entity creation date.
      type: string
      format: date-time
      example: 2022-11-04T20:10:06.927Z
      readOnly: true
    UpdatedAt:
      description: An ISO-8601 timestamp representation of entity update date.
      type: string
      format: date-time
      example: 2022-11-04T20:10:06.927Z
      readOnly: true
    ListKongPrincipalIdentities:
      type: object
      properties:
        meta:
          $ref: "#/components/schemas/CursorMetaPage"
        data:
          type: array
          items:
            $ref: "#/components/schemas/KongPrincipalIdentity"
      required:
        - meta
        - data
```
