Skip to main content
REST API reference

Add local users and Active Directory users and groups to a local group and SVM

PDFs

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

Introduced In: 9.10

Adds local users, Active Directory users and Active Directory groups to the specified local group and SVM.

Important note

  • Specified members are appended to the existing list of members.

Required properties

  • svm.uuid or svm.name - Existing SVM for which members are added to local group.

  • local_cifs_group.sid - Security ID of the local group to which members are added.

  • name or records - Local users, Active Directory users, or Active Directory groups to be added to a particular local group.

  • vserver cifs users-and-groups local-group add-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": {
    "name": "svm1",
    "uuid": "02c9e252-41be-11e9-81d5-00a0986138f7"
  }
}

Response

Status: 201, Created

Headers

Name Description Type

Location

Useful for tracking the resource location

string

Error

Status: Default

ONTAP Error Response Codes

Error Code Description

655673

Failed to resolve the member to be added to the specified group.

655718

Failed to add a member to 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.

655744

Either name or records must be specified.

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

svm

SVM, applies only to SVM-scoped objects.

Name Type Description

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.