Skip to main content
REST API reference

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

local_cifs_group

local_cifs_group

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.

svm

svm

SVM, applies only to SVM-scoped objects.
Example request 
{
  "local_cifs_group": {
    "sid": "S-1-5-21-256008430-3394229847-3930036330-1001"
  },
  "name": "string",
  "records": [
    {
      "name": "string"
    }
  ],
  "svm": {
    "_links": {
      "self": {
        "href": "/api/resourcelink"
      }
    },
    "name": "svm1",
    "uuid": "02c9e252-41be-11e9-81d5-00a0986138f7"
  }
}

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     | records must not be specified when member name is specified. | | 655743     | svm uuid and cifs local group sid are invalid fields for the "records" parameter. |
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

local_cifs_group

Name Type Description

sid

string

The security ID of the local group which uniquely identifies the group. The group SID is automatically generated in POST and it is retrieved using the GET method.

records

Name Type Description

name

string

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

href

Name Type Description

href

string

_links

Name Type Description

self

href

svm

SVM, applies only to SVM-scoped objects.

Name Type Description

_links

_links

name

string

The name of the SVM. This field cannot be specified in a PATCH method.

uuid

string

The unique identifier of the SVM. This field cannot be specified in a PATCH method.

local_cifs_group_members

Name Type Description

local_cifs_group

local_cifs_group

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.

svm

svm

SVM, applies only to SVM-scoped objects.

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.