On this page

Function
Constraints
URI
Request Parameters
Response Parameters
Example Requests
Example Responses
Status Codes
Error Codes

Show all

Help Center/ Scalable File Service/ API Reference/ SFS Turbo APIs/ Permissions Management/ Binding to an LDAP Server

Binding to an LDAP Server

Updated on 2025-04-28 GMT+08:00

View PDF

Function

This API is used to bind to an LDAP server. Lightweight Directory Access Protocol (LDAP) is a standard protocol used for directory server access and control. An LDAP server can centrally manage the ownerships of users and groups. After you bind your file system to an LDAP server, when a user accesses a file in the file system, SFS Turbo will access your LDAP server for user authentication and obtain the user and group ownerships. In this way, standards Linux file UGO permissions are checked. To use this function, you need to first set up an LDAP server (SFS Turbo only supports LDAP v3 currently). Common directory servers that provide LDAP services include OpenLDAP (Linux) and Active Directory (Windows). The implementation varies depending on the directory server. When binding to an LDAP server, you need to specify the corresponding schema. If an incorrect schema is configured, SFS Turbo cannot obtain the correct user and group information, and users will fail to access files in the file system. Schemas that SFS Turbo supports include:

RFC2307 (Usually selected for OpenLDAP)
MS-AD-BIS (Usually selected for Active Directory. It supports RFC2307bis and nested groups.)

SFS Turbo also supports active/standby deployment of LDAP servers. If one LDAP server fails and cannot be accessed, SFS Turbo access authentication automatically switches to the standby LDAP server. In addition, if you set allow_local_user to Yes (default value is No), when both LDAP servers fail, SFS Turbo will use your local user and group information instead of the information configured on the LDAP server for identity authentication and UGO permissions check to minimize the fault impact.

Constraints

base_dn and url cannot be empty.

URI

POST /v1/{project_id}/sfs-turbo/shares/{share_id}/fs/ldap

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	The project ID.
share_id	Yes	String	The file system ID.

Request Parameters

**Table 2** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	The account token.
Content-Type	Yes	String	The MIME type.

**Table 3** Request body parameters
Parameter	Mandatory	Type	Description
url	Yes	String	The URL of the LDAP server. The format is ldap://{ip_address}:{port_number} or ldaps://{ip_address}:{port_number}, for example, ldap://192.168.xx.xx:60000.
base_dn	Yes	String	The base DN.
user_dn	No	String	The bind DN.
password	No	String	The LDAP authentication password.
vpc_id	No	String	The ID of the VPC that the specified LDAP server can connect to. This parameter is only required when the SFS Turbo file system is used across VPCs.
filter_condition	No	String	The search filters. This is a reserved field and is not supported currently.
backup_url	No	String	The URL of the standby LDAP server. The format is ldap://{ip_address}:{port_number} or ldaps://{ip_address}:{port_number}, for example, ldap://192.168.xx.xx:60000.
schema	No	String	The LDAP schema. If not specified, RFC2307 will be used.
search_timeout	No	Integer	The LDAP search timeout interval, in seconds. If not specified, 3 seconds will be used.
allow_local_user	No	String	Whether to allow local user authentication if access to the LDAP server failed. Enumeration values: Yes No

Response Parameters

Status code: 200

**Table 4** Response body parameters
Parameter	Type	Description
jobId	String	The ID of an asynchronous LDAP task. You can query the task execution status by calling the API for querying details about a task.

Status code: 400

**Table 5** Response header parameters
Parameter	Type	Description
X-request-id	String	The request ID.

**Table 6** Response body parameters
Parameter	Type	Description
errCode	String	The error code.
errMsg	String	The error message.

Status code: 500

**Table 7** Response header parameters
Parameter	Type	Description
X-request-id	String	The request ID.

**Table 8** Response body parameters
Parameter	Type	Description
errCode	String	The error code.
errMsg	String	The error message.

Example Requests

Creating and binding to an LDAP server

{
  "url" : "ldap://192.168.xx.xx:60000",
  "base_dn" : "dc=example,dc=com",
  "user_dn" : "cn=admin,dc=example,dc=com",
  "password" : "pwdxxxxxx",
  "backup_url" : "ldap://192.168.xx.xx:60000",
  "schema" : "RFC2307",
  "search_timeout" : 10,
  "allow_local_user" : "Yes"
}

Example Responses

Status code: 200

Request accepted

{
  "jobId" : "72362dxxxxa04d419dbd5e6d9fe5xxxx"
}

Status code: 400

Client error

{
  "errCode" : "SFS.TURBO.0001",
  "errMsg" : "Invalid rule id"
}

Status code: 500

Internal error

{
  "errCode" : "SFS.TURBO.0005",
  "errMsg" : "Internal server error"
}

Status Codes

Status Code	Description
200	Request accepted
400	Client error
500	Internal error

Error Codes

See Error Codes.

Parent topic: Permissions Management

Previous topic: Deleting a Permission Rule

Next topic: Querying the LDAP Configuration

Feedback

Was this page helpful?

Helpful Not helpful

Provide feedback

Thank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.

The system is busy. Please try again later.

Which of the following issues have you encountered?

Content is inconsistent with the product UI

Unclear descriptions

Lack of examples or code

Incorrect steps

Can't find what I need

Lack of best practices

Feedback (optional)

0/500

Select at least one type of issue, and enter your comments or suggestions.

Enter a maximum of 500 characters.

Submit Cancel

For any further questions, feel free to contact us through the chatbot.

Chatbot