Skip to main content
REST API reference
A newer release of this product is available.

Delete local users or Active Directory users and groups from a local group and SVM

PDFs

DELETE /protocols/cifs/local-groups/{svm.uuid}/{local_cifs_group.sid}/members

Introduced In: 9.10

Deletes the local users, Active Directory users and/or Active Directory groups from the specified local group and SVM.

  • vserver cifs users-and-groups local-group remove-members

Learn more

Parameters

Name Type In Required Description

local_cifs_group.sid

string

path

True

Local group SID

return_records

boolean

query

False

The default is false. If set to true, the records are returned.

  • Default value:

svm.uuid

string

path

True

UUID of the SVM to which this object belongs.

Request Body

Name Type Description

name

string

Local user, Active Directory user, or Active Directory group which is a member of the specified local group.

records

array[records]

An array of local users, Active Directory users, and Active Directory groups specified to add or delete multiple members to or from a local group in a single API call. Not allowed when the name property is used.
Example request 
{
  "name": "string",
  "records": [
    {
      "name": "string"
    }
  ]
}

Response

Status: 200, Ok

Error

Status: Default, Error ontap error response codes | error code | description | | ---------- | ----------- | | 655673     | failed to resolve the member to be deleted from the specified group. | | 655719     | failed to delete a member from the specified group. the error code returned details the failure along with the reason for the failure. take corrective actions as per the specified reason. | | 655742     | the "records" field must not be specified when a single user is to be deleted. | | 655743     | svm uuid and cifs local group sid are invalid fields for the "records" parameter. |
Name Type Description

error

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

Definitions

See Definitions

records

Name Type Description

name

string

Local user, Active Directory user, or Active Directory group which is a member of the specified local group.

local_cifs_group_members

Name Type Description

name

string

Local user, Active Directory user, or Active Directory group which is a member of the specified local group.

records

array[records]

An array of local users, Active Directory users, and Active Directory groups specified to add or delete multiple members to or from a local group in a single API call. Not allowed when the name property is used.

error_arguments

Name Type Description

code

string

Argument code

message

string

Message argument

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.