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

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

# ListKongDirectories

## 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
    KongDirectory:
      description: >
        A directory represents an organizational boundary for grouping
        principals and managing their identities.

        Directories are region-specific and can control which control planes
        have authentication access.
      type: object
      properties:
        id:
          $ref: "#/components/schemas/UUID"
        name:
          $ref: "#/components/schemas/DirectoryName"
        description:
          $ref: "#/components/schemas/DirectoryDescription"
        allowed_control_planes:
          $ref: "#/components/schemas/AllowedControlPlanes"
        allow_all_control_planes:
          $ref: "#/components/schemas/AllowAllControlPlanes"
        ttl_secs:
          $ref: "#/components/schemas/DirectoryTTLSecs"
        negative_ttl_secs:
          $ref: "#/components/schemas/DirectoryNegativeTTLSecs"
        labels:
          $ref: "#/components/schemas/Labels"
        created_at:
          $ref: "#/components/schemas/CreatedAt"
        updated_at:
          $ref: "#/components/schemas/UpdatedAt"
      required:
        - id
        - name
        - description
        - labels
        - allowed_control_planes
        - allow_all_control_planes
        - ttl_secs
        - negative_ttl_secs
        - 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
    DirectoryName:
      description: >
        Human-readable name of the directory, used to identify the
        organizational boundary.

        A directory name is unique within the organization.
      type: string
      maxLength: 255
      minLength: 1
      pattern: ^[a-z0-9-_]+$
    DirectoryDescription:
      description: >
        Optional description providing additional context about the directory's
        purpose or usage.
      type: string
      maxLength: 255
    AllowedControlPlanes:
      description: >
        List of control plane IDs authorized to make authentication requests to
        this directory.

        Maximum of 32 control planes can be specified. Use
        allow_all_control_planes for unrestricted access.
      type: array
      items:
        type: string
        format: uuid
        uniqueItems: true
        minItems: 0
        maxItems: 32
      default: []
      nullable: false
    AllowAllControlPlanes:
      description: >
        When set to true, all control planes within the organization can make
        authentication requests to this directory.

        This overrides the allowed_control_planes list. Defaults to false for
        security.
      type: boolean
      default: false
      nullable: false
    DirectoryTTLSecs:
      description: >
        The time in seconds that a principal will be cached in memory on a
        running Gateway if it is

        successfully authenticated from this directory. Maximum is 86400 seconds
        (24 hours).
      type: integer
      default: 600
      maximum: 86400
      minimum: 300
    DirectoryNegativeTTLSecs:
      description: >
        If a running Gateway triggers a lookup for a principal that cannot be
        authenticated in this directory,

        a `negative_ttl_secs` is set. The Gateway will not try to look up the
        principal in Konnect for `negative_ttl_secs` seconds.


        A principal will be cached for `negative_ttl_secs` if it does not exist
        in the directory, or if the provided credentials are invalid.

        Maximum is 86400 seconds (24 hours).
      type: integer
      default: 600
      maximum: 86400
      minimum: 300
    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
    ListKongDirectories:
      type: object
      properties:
        meta:
          $ref: "#/components/schemas/CursorMetaPage"
        data:
          type: array
          items:
            $ref: "#/components/schemas/KongDirectory"
      required:
        - meta
        - data
```
