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

> 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 directories

`GET` `/directories`

Operation ID: `ListKongDirectories`

Retrieves a paginated list of all available directories in the organization. Results can be sorted by name, created_at, or updated_at.

## 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 directories. Supported sort attributes are: - name - created_at - updated_at

## Responses

- `200` - List of Directories
- `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:
    get:
      operationId: ListKongDirectories
      summary: List all directories
      description: >
        Retrieves a paginated list of all available directories in the
        organization.

        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 directories. Supported sort attributes are:
            - name
            - created_at
            - updated_at
          required: false
          schema:
            $ref: "#/components/schemas/SortQuery"
      responses:
        "200":
          $ref: "#/components/responses/ListKongDirectoriesResponse"
        "401":
          $ref: "#/components/responses/Unauthorized"
        "403":
          $ref: "#/components/responses/Forbidden"
      tags:
        - Kong Identity Directories
security:
  - systemAccountAccessToken: []
  - personalAccessToken: []
  - konnectAccessToken: []
components:
  parameters:
    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
    ListKongDirectories:
      type: object
      properties:
        meta:
          $ref: "#/components/schemas/CursorMetaPage"
        data:
          type: array
          items:
            $ref: "#/components/schemas/KongDirectory"
      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
    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
    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
    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
  responses:
    ListKongDirectoriesResponse:
      description: List of Directories
      content:
        application/json:
          schema:
            $ref: "#/components/schemas/ListKongDirectories"
          examples: {}
    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.
```
