Help Center/ Scalable File Service/ API Reference/ SFS Turbo APIs/ Permissions Management/ Leaving the AD Domain
Updated on 2025-07-22 GMT+08:00
View PDF

Leaving the AD Domain

Function

This API is used to remove a file system from an AD domain. AD DS is a directory service that provides unified identity and permissions management through domain networks. By adding an SFS Turbo file system to an AD domain, you can easily authenticate and manage user identities and control file permissions in that domain.

Constraints

This API is only supported for SMB file systems.

URI

DELETE /v1/{project_id}/sfs-turbo/shares/{share_id}/fs/active-directory-domain

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

service_account

Yes

String

The service account, which is specified when the domain server is created. administrator is used normally.

password

Yes

String

The password of the service account.

Response Parameters

Status code: 202

Table 4 Response body parameters

Parameter

Type

Description

job_id

String

The ID of the asynchronous task for leaving the AD domain.

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

None

Example Responses

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

202

AD domain left successfully

400

Error response

500

Error response

Error Codes

See Error Codes.

Parent topic: Permissions Management