Skip to main content

Delete an Active Directory account for an SVM

Contributors
PDFs

DELETE /protocols/active-directory/{svm.uuid}

Introduced In: 9.12

Deletes the Active Directory account for a given SVM.

  • vserver active-directory delete

Important notes

  • Active Directory account deletion is asynchronous. Response contains Task UUID and Link that can be queried to get the status.

Parameters

Name Type In Required Description

svm.uuid

string

path

True

UUID of the SVM to which this object belongs.

Request Body

Name Type Description

password

string

Administrator password required for Active Directory account creation.

username

string

Administrator username required for Active Directory account creation.
Example request 
{
  "password": "testpwd",
  "username": "admin"
}

Response

Status: 200, Ok

Error

Status: Default

ONTAP Error Response Codes

Error Code Description

655414

Failed to remove Active Directory machine.

655431

Username cannot be empty.

655432

Password cannot be empty.

Also see the table of common errors in the Response body overview section of this documentation.

Name Type Description

error

returned_error
Example error 
{
  "error": {
    "arguments": {
      "code": "string",
      "message": "string"
    },
    "code": "4",
    "message": "entry doesn't exist",
    "target": "uuid"
  }
}

Definitions

See Definitions

active_directory_delete

Name Type Description

password

string

Administrator password required for Active Directory account creation.

username

string

Administrator username required for Active Directory account creation.

error_arguments

Name Type Description

code

string

Argument code

message

string

Message argument

returned_error

Name Type Description

arguments

array[error_arguments]

Message arguments

code

string

Error code

message

string

Error message

target

string

The target parameter that caused the error.