---
title: "Get a list of directory service configurations"
method: POST
path: "/directory_services/list"
tags: ["directory_service"]
---

# Get a list of directory service configurations

`POST /directory_services/list`

This operation gets a list of directory service configurations, allowing for sorting and pagination. Note: Entities that have not been created successfully are not listed.

## Request body

- DirectoryServiceListMetadata — All api calls that return a list will have this metadata block as input
  - `filter` string — The filter in FIQL syntax used for the results.
  - `kind` string — The kind name
  - `sort_order` string — The sort order in which results are returned
  - `offset` integer — Offset from the start of the entity list
  - `length` integer — The number of records to retrieve relative to the offset
  - `sort_attribute` string — The attribute to perform sort on

## Response `200`

Success

- DirectoryServiceListIntentResponse — Response object for intentful operation of directory_services
  - `entities` DirectoryServiceIntentResource[]
    - `status` DirectoryServiceDefStatus — Details of the directory service.
      - `state` string — The state of the directory service configuration.
      - `message_list` MessageResource[]
        - `message` string, required — If state is ERROR, a message describing the error.
        - `reason` string, required — If state is ERROR, a machine-readable snake-cased string.
        - `details` object — Custom key-value details relevant to the status.
      - `name` string, required — Name of the directory service.
      - `resources` object, required — The configuration details of the directory service.
        - `open_ldap_configuration` OpenLdapConfigurationDefStatus — Configuration for OpenLDAP directory service.
          - `user_configuration` object, required
            - `user_search_base` string, required — The base DN for user search.
            - `user_object_class` string, required — The object class in the OpenLDAP system that corresponds to users.
            - `username_attribute` string, required — Unique identifier for each user which can be used in authentication.
          - `user_group_configuration` object, required
            - `group_search_base` string, required — The base DN for group search.
            - `group_member_attribute` string, required — The attribute in a group that associates users to the group.
            - `group_object_class` string, required — The object class in the OpenLDAP system that corresponds to groups.
            - `group_member_attribute_value` string, required — The user attribute value that will be used in group entity to associate user to the group.
        - `admin_group_reference_list` UserGroupReference[] — List of admin user groups available in the directory service.
          - `kind` string, required — The kind name
          - `name` string
          - `uuid` string, UUID, required
        - `service_account` ServiceAccount, required — Credentials to connect to the directory service.
          - `username` string, required — The username to connect to the directory service.
          - `password` string, required — The password to authenticate the request.
        - `url` string, required — URL of the directory.
        - `directory_type` string, required — Type of the directory service.
        - `admin_user_reference_list` UserReference[] — The list of admin users available in the directory service.
          - `kind` string, required — The kind name
          - `name` string
          - `uuid` string, UUID, required
        - `domain_name` string, required — The domain name of the directory service.
    - `spec` DirectoryService — The configuration details of the directory service.
      - `name` string, required — The name of the directory service.
      - `resources` object, required — The details of the directory service.
        - `open_ldap_configuration` OpenLdapConfiguration — Configuration for OpenLDAP directory service.
          - `user_configuration` object, required
            - `user_search_base` string, required — The base DN for user search.
            - `user_object_class` string, required — The object class in the OpenLDAP system that corresponds to users.
            - `username_attribute` string, required — Unique identifier for each user which can be used in authentication.
          - `user_group_configuration` object, required
            - `group_search_base` string, required — The base DN for group search.
            - `group_member_attribute` string, required — The attribute in a group that associates users to the group.
            - `group_object_class` string, required — The object class in the OpenLDAP system that corresponds to groups.
            - `group_member_attribute_value` string, required — The user attribute value that will be used in group entity to associate user to the group.
        - `admin_group_reference_list` UserGroupReference[] — List of admin user groups available in the directory service.
          - `kind` string, required — The kind name
          - `name` string
          - `uuid` string, UUID, required
        - `service_account` ServiceAccount, required — Credentials to connect to the directory service.
          - `username` string, required — The username to connect to the directory service.
          - `password` string, required — The password to authenticate the request.
        - `url` string, required — URL of the directory.
        - `directory_type` string, required — Type of the directory service.
        - `admin_user_reference_list` UserReference[] — The list of admin users available in the directory service.
          - `kind` string, required — The kind name
          - `name` string
          - `uuid` string, UUID, required
        - `domain_name` string, required — The domain name of the directory service.
    - `api_version` string
    - `metadata` DirectoryServiceMetadata, required — The directory_service kind metadata
      - `last_update_time` string, date-time — UTC date and time in RFC-3339 format when directory_service was last updated
      - `kind` string, required — The kind name
      - `uuid` string, UUID — directory_service uuid
      - `spec_version` integer — Version number of the latest spec.
      - `creation_time` string, date-time — UTC date and time in RFC-3339 format when directory_service was created
      - `spec_hash` string — Hash of the spec. This will be returned from server.
      - `should_force_translate` boolean — Applied on Prism Central only. Indicate whether force to translate the spec of the fanout request to fit the target cluster API schema.
      - `owner_reference` UserReference — The reference to a user
        - `kind` string, required — The kind name
        - `name` string
        - `uuid` string, UUID, required
      - `categories` object — Categories for the directory_service
      - `name` string — directory_service name
  - `api_version` string, required
  - `metadata` DirectoryServiceListMetadataOutput, required — All api calls that return a list will have this metadata block
    - `filter` string — The filter used for the results
    - `kind` string — The kind name
    - `sort_order` string — The sort order in which results are returned
    - `offset` integer — Offset from the start of the entity list
    - `total_matches` integer — Total matches found
    - `length` integer — The number of records retrieved relative to the offset
    - `sort_attribute` string — The attribute to perform sort on

## Other responses

- `default` — Internal Error

---

[API](https://skmtc.net/nutanix/apis/nutanix-intentful-api.md) · [All operations](https://skmtc.net/nutanix/apis/nutanix-intentful-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/nutanix/nutanix-intentful-api/revisions/40395083ab31/schema)