Help Center/ Scalable File Service Turbo/ API Reference/ API/ Permissions Management/ Modifying the LDAP Configuration
Updated on 2025-07-22 GMT+08:00
View PDF
Share

Modifying the LDAP Configuration

Function

This API is used to modify the LDAP configuration.

Constraints

This API is only supported for NFS file systems.

URI

PUT /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

No

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

No

String

The base DN.

user_dn

No

String

The bind DN.

password

No

String

The LDAP authentication password.

vpc_id

No

String

The VPC ID.

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.

Response Parameters

Status code: 200

Table 4 Response header parameters

Parameter

Type

Description

X-request-id

String

The request ID.
Table 5 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 6 Response header parameters

Parameter

Type

Description

X-request-id

String

The request ID.
Table 7 Response body parameters

Parameter

Type

Description

errCode

String

The error code.

errMsg

String

The error message.

Status code: 500

Table 8 Response header parameters

Parameter

Type

Description

X-request-id

String

The request ID.
Table 9 Response body parameters

Parameter

Type

Description

errCode

String

The error code.

errMsg

String

The error message.

Example Requests

{
  "url" : "ldap://192.168.xx.xx:60000",
  "base_dn" : "dc=example,dc=com",
  "user_dn" : "cn=admin,dc=example,dc=com",
  "password" : "pwdxxxxxx",
  "vpc_id" : "26f6b565-xxxx-XXXX-xxxx-03f0bd975433",
  "backup_url" : "ldap://192.168.xx.xx:60000",
  "schema" : "RFC2307",
  "search_timeout" : 10
}

Example Responses

Status code: 200

Updating

{
  "jobId" : "72362dxxxxa04d419dbd5e6d9fe5xxxx"
}

Status code: 400

Error response

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

Status code: 500

Error response

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

Status Codes

Status Code

Description

200

Updating

400

Error response

500

Error response

Error Codes

See Error Codes.

Parent topic: Permissions Management