---
title: "List all the Principals of a Directory"
url: "https://nov18-dev.movespot.fyi/apis/konnect-kong-identity-admin-api-dev-0/versions/cf61fd14-4802-4fa9-ad7b-534e50226211/operations/listPrincipals"
---

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

# List all the Principals of a Directory

`GET` `/directories/{directoryId}/principals`

Operation ID: `listPrincipals`

Retrieves a paginated list of all principals within the specified directory. Results can be sorted by name, created_at, or updated_at.

## Path parameters

- `directoryId` (string, uuid, required) - ID of the directory

## Query parameters

- `page[size]` (integer, optional) - The maximum number of items to include per page. The last page of a collection may include fewer items.
- `page[before]` (string, optional) - Request the next page of data, starting with the item before this parameter.
- `page[after]` (string, optional) - Request the next page of data, starting with the item after this parameter.
- `sort` (string, optional) - Sorts a collection of principals. Supported sort attributes are: - name - created_at - updated_at

## Responses

- `200` - List of Kong Principals
- `401` - Unauthorized
- `403` - Forbidden

## 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
paths:
  /directories/{directoryId}/principals:
    parameters:
      - $ref: "#/components/parameters/directoryId"
    get:
      operationId: listPrincipals
      summary: List all the Principals of a Directory
      description: >
        Retrieves a paginated list of all principals within the specified
        directory.

        Results can be sorted by name, created_at, or updated_at.
      parameters:
        - $ref: "#/components/parameters/PageSize"
        - $ref: "#/components/parameters/PageBefore"
        - $ref: "#/components/parameters/PageAfter"
        - name: sort
          in: query
          description: |
            Sorts a collection of principals. Supported sort attributes are:
            - name
            - created_at
            - updated_at
          required: false
          schema:
            $ref: "#/components/schemas/SortQuery"
      responses:
        "200":
          $ref: "#/components/responses/ListKongPrincipalsResponse"
        "401":
          $ref: "#/components/responses/Unauthorized"
        "403":
          $ref: "#/components/responses/Forbidden"
      tags:
        - KongPrincipal
security:
  - systemAccountAccessToken: []
  - personalAccessToken: []
  - konnectAccessToken: []
components:
  parameters:
    directoryId:
      name: directoryId
      in: path
      required: true
      description: ID of the directory
      schema:
        type: string
        format: uuid
    PageSize:
      name: page[size]
      description: The maximum number of items to include per page. The last page of a
        collection may include fewer items.
      required: false
      in: query
      allowEmptyValue: true
      schema:
        type: integer
        example: 10
    PageBefore:
      name: page[before]
      description: Request the next page of data, starting with the item before this
        parameter.
      required: false
      in: query
      allowEmptyValue: true
      schema:
        type: string
        example: ewogICJpZCI6ICJoZWxsbyB3b3JsZCIKfQ
    PageAfter:
      name: page[after]
      description: Request the next page of data, starting with the item after this
        parameter.
      required: false
      in: query
      allowEmptyValue: true
      schema:
        type: string
        example: ewogICJpZCI6ICJoZWxsbyB3b3JsZCIKfQ
  schemas:
    SortQuery:
      description: >
        The `asc` suffix is optional as the default sort order is ascending.

        The `desc` suffix is used to specify a descending order.

        Multiple sort attributes may be provided via a comma separated list.

        JSONPath notation may be used to specify a sub-attribute (eg: 'foo.bar
        desc').
      type: string
      example: created_at desc
      title: SortQuery
    ListKongPrincipals:
      type: object
      properties:
        meta:
          $ref: "#/components/schemas/CursorMetaPage"
        data:
          type: array
          items:
            $ref: "#/components/schemas/KongPrincipal"
      required:
        - meta
        - data
    UnauthorizedError:
      allOf:
        - $ref: "#/components/schemas/BaseError"
        - type: object
          properties:
            status:
              example: 401
            title:
              example: Unauthorized
            type:
              example: https://httpstatuses.com/401
            instance:
              example: kong:trace:1234567890
            detail:
              example: Invalid credentials
    ForbiddenError:
      allOf:
        - $ref: "#/components/schemas/BaseError"
        - type: object
          properties:
            status:
              example: 403
            title:
              example: Forbidden
            type:
              example: https://httpstatuses.com/403
            instance:
              example: kong:trace:1234567890
            detail:
              example: Forbidden
    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
    KongPrincipal:
      description: >
        A principal represents an authenticated identity within a directory.

        Principals can be associated with API keys and inherit metadata from
        their parent directory.
      type: object
      properties:
        id:
          $ref: "#/components/schemas/UUID"
        display_name:
          $ref: "#/components/schemas/KongPrincipalDisplayName"
        description:
          $ref: "#/components/schemas/KongPrincipalDescription"
        metadata:
          $ref: "#/components/schemas/KongIdentityMetadata"
        labels:
          $ref: "#/components/schemas/Labels"
        created_at:
          $ref: "#/components/schemas/CreatedAt"
        updated_at:
          $ref: "#/components/schemas/UpdatedAt"
      required:
        - id
        - description
        - metadata
        - labels
        - created_at
        - updated_at
    BaseError:
      description: standard error
      type: object
      properties:
        status:
          description: >
            The HTTP status code of the error. Useful when passing the response

            body to child properties in a frontend UI. Must be returned as an
            integer.
          type: integer
          readOnly: true
        title:
          description: |
            A short, human-readable summary of the problem. It should not
            change between occurences of a problem, except for localization.
            Should be provided as "Sentence case" for direct use in the UI.
          type: string
          readOnly: true
        type:
          description: The error type.
          type: string
          readOnly: true
        instance:
          description: |
            Used to return the correlation ID back to the user, in the format
            kong:trace:<correlation_id>. This helps us find the relevant logs
            when a customer reports an issue.
          type: string
          readOnly: true
        detail:
          description: >
            A human readable explanation specific to this occurence of the
            problem.

            This field may contain request/entity data to help the user
            understand

            what went wrong. Enclose variable values in square brackets. Should
            be

            provided as "Sentence case" for direct use in the UI.
          type: string
          readOnly: true
      required:
        - status
        - title
        - instance
        - detail
      title: Error
    UUID:
      description: Contains a unique identifier used for this resource.
      type: string
      format: uuid
      example: 5f9fd312-a987-4628-b4c5-bb4f4fddd5f7
      readOnly: true
    KongPrincipalDisplayName:
      description: |
        Human-readable name of the principal.
      type: string
      maxLength: 255
    KongPrincipalDescription:
      description: >
        Optional description providing additional context about the principal's
        purpose or role.
      type: string
      maxLength: 255
    KongIdentityMetadata:
      description: >
        A map of metadata key-value pairs associated with this entity. This
        metadata is passed to the data plane 

        to enrich the execution context. During authentication, metadata is
        inherited and overridden in a hierarchical 

        manner: Directory metadata is inherited by Principals, which is then
        inherited and overridden by Credentials.
      type: object
      additionalProperties:
        oneOf:
          - type: string
            format: date-time
          - type: boolean
          - type: string
          - type: integer
          - type: array
            items:
              type: string
            minItems: 0
            maxItems: 255
            uniqueItems: true
          - type: array
            items:
              type: integer
            minItems: 0
            maxItems: 255
            uniqueItems: true
      maxProperties: 50
      minProperties: 0
      nullable: 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
  responses:
    ListKongPrincipalsResponse:
      description: List of Kong Principals
      content:
        application/json:
          schema:
            $ref: "#/components/schemas/ListKongPrincipals"
          examples:
            listPrincipals:
              summary: List of principals
              value:
                meta:
                  page: 1
                  size: 2
                  previous: null
                  next: eyJpZCI6IjEyMzQ1Njc4LTEyMzQtMTIzNC0xMjM0LTEyMzQ1Njc4OTAxMiJ9
                data:
                  - id: 12345678-1234-1234-1234-123456789012
                    name: principal-1
                    description: First principal
                    metadata:
                      consumer_groups:
                        - group1
                        - group2
                      consumer_type: service
                    labels:
                      env: production
                      team: platform
                    created_at: 2024-01-15T10:30:00Z
                    updated_at: 2024-01-15T10:30:00Z
                  - id: 23456789-2345-2345-2345-234567890123
                    name: principal-2
                    description: Second principal
                    metadata:
                      consumer_type: application
                    labels:
                      env: staging
                    created_at: 2024-01-16T14:20:00Z
                    updated_at: 2024-01-16T14:20:00Z
    Unauthorized:
      description: Unauthorized
      content:
        application/problem+json:
          schema:
            $ref: "#/components/schemas/UnauthorizedError"
          examples:
            UnauthorizedExample:
              $ref: "#/components/examples/UnauthorizedExample"
    Forbidden:
      description: Forbidden
      content:
        application/problem+json:
          schema:
            $ref: "#/components/schemas/ForbiddenError"
          examples:
            UnauthorizedExample:
              $ref: "#/components/examples/ForbiddenExample"
  examples:
    UnauthorizedExample:
      value:
        status: 401
        title: Unauthorized
        instance: kong:trace:8347343766220159418
        detail: Unauthorized
    ForbiddenExample:
      value:
        status: 403
        title: Forbidden
        instance: kong:trace:2723154947768991354
        detail: You do not have permission to perform this action
  securitySchemes:
    systemAccountAccessToken:
      type: http
      scheme: bearer
      bearerFormat: Token
      description: >
        The system account access token is meant for automations and
        integrations that are not directly associated with a human identity.

        You can generate a system account Access Token by creating a system
        account and then obtaining a system account access token for that
        account.

        The access token must be passed in the header of a request, for example:

        `curl -X GET 'https://global.api.konghq.com/v2/users/' --header
        'Authorization: Bearer spat_i2Ej...'`
    personalAccessToken:
      type: http
      scheme: bearer
      bearerFormat: Token
      description: >
        The personal access token is meant to be used as an alternative to
        basic-auth when accessing Konnect via APIs.

        You can generate a Personal Access Token (PAT) from the [personal access
        token page](https://cloud.konghq.com/global/account/tokens/) in the
        Konnect dashboard.

        The PAT token must be passed in the header of a request, for example:

        `curl -X GET 'https://global.api.konghq.com/v2/users/' --header
        'Authorization: Bearer kpat_xgfT...'`
    konnectAccessToken:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: >
        The Konnect access token is meant to be used by the Konnect dashboard
        and the decK CLI authenticate with.
```
