---
title: "Ping available ldap service."
method: POST
path: "/ldap/ping"
tags: ["Ldap"]
---

# Ping available ldap service.

`POST /ldap/ping`

This endpoint ping the available ldap service for test related configuration parameters.

## Headers

- `X-Request-Id` string

## Request body

- LdapConf — The ldap configure properties
  - `ldap_url` string — The url of ldap service.
  - `ldap_search_dn` string — The search dn of ldap service.
  - `ldap_search_password` string — The search password of ldap service.
  - `ldap_base_dn` string — The base dn of ldap service.
  - `ldap_filter` string — The serach filter of ldap service.
  - `ldap_uid` string — The serach uid from ldap service attributes.
  - `ldap_scope` integer — The serach scope of ldap service.
  - `ldap_connection_timeout` integer — The connect timeout of ldap service(second).
  - `ldap_verify_cert` boolean — Verify Ldap server certificate.

## Response `200`

Ping ldap service successfully.

- LdapPingResult — The ldap ping result
  - `success` boolean — Test success
  - `message` string — The ping operation output message.

## Other responses

- `400` — Bad request
- `401` — Unauthorized
- `403` — Forbidden
- `500` — Internal server error

---

[API](https://skmtc.dev/cerit/apis/harbor-api.md) · [All operations](https://skmtc.dev/cerit/apis/harbor-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/cerit/harbor-api/revisions/62d78801f8df/schema)