Help Center> Scalable File Service> API Reference> SFS Turbo APIs> Permissions Management> Creating and Binding the LDAP Configuration
Updated on 2024-01-03 GMT+08:00
View PDF

Creating and Binding the LDAP Configuration

Function

This API is used to create and bind the LDAP configuration.

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

Project ID

share_id

Yes

String

File system ID

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

Account token

Content-Type

Yes

String

MIME type
Table 3 Request body parameters

Parameter

Mandatory

Type

Description

url

Yes

String

URL of the LDAP server

base_dn

Yes

String

Base DN

user_dn

No

String

User DN

password

No

String

LDAP authentication password

vpc_id

No

String

ID of the VPC which the specified LDAP server can be connected to. This parameter is required only when the SFS Turbo file system is used across VPCs.

filter_condition

No

String

Filter criteria. This is a reserved field and is not supported currently.

Response Parameters

Status code: 200

Table 4 Response body parameters

Parameter

Type

Description

job_id

String

ID of an asynchronous task for creating the LDAP configuration

Status code: 400

Table 5 Response body parameters

Parameter

Type

Description

errCode

String

Error code

Minimum: 8

Maximum: 36

errMsg

String

Error description

Minimum: 2

Maximum: 512

Status code: 500

Table 6 Response body parameters

Parameter

Type

Description

errCode

String

Error code

Minimum: 8

Maximum: 36

errMsg

String

Error description

Minimum: 2

Maximum: 512

Example Requests

Creating and binding an LDAP server

{
  "url" : "ldap://192.168.xx.xx:60000",
  "base_dn" : "dc=huawei,dc=com",
  "user_dn" : "cn=admin,dc=huawei,dc=com",
  "password" : "pwdxxxxxx"
}

Example Responses

Status code: 200

Request accepted

{
  "job_id" : "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