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

Retrieve local users and Active Directory users and groups that belong to a local group and SVM

Contributors
PDFs

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

Introduced In: 9.10

Retrieves local users, Active Directory users and Active Directory groups which are members of the specified local group and SVM.

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

Learn more

Parameters

Name Type In Required Description

local_cifs_group.sid

string

path

True

Local group SID

max_records

integer

query

False

Limit the number of records returned.

return_records

boolean

query

False

The default is true for GET calls. When set to false, only the number of records is returned.

  • Default value: 1

return_timeout

integer

query

False

The number of seconds to allow the call to execute before returning. When iterating over a collection, the default is 15 seconds. ONTAP returns earlier if either max records or the end of the collection is reached.

  • Default value: 1

  • Max value: 120

  • Min value: 0

order_by

array[string]

query

False

Order results by specified fields and optional [asc

desc] direction. Default direction is 'asc' for ascending.

svm.uuid

string

path

True

UUID of the SVM to which this object belongs.

fields

array[string]

query

False

Response

Status: 200, Ok
Name Type Description

_links

_links

num_records

integer

Number of local group records.

records

array[local_cifs_group_members]
Example response 
{
  "_links": {
    "next": {
      "href": "/api/resourcelink"
    },
    "self": {
      "href": "/api/resourcelink"
    }
  },
  "records": [
    {
      "name": "string",
      "records": [
        {
          "name": "string"
        }
      ]
    }
  ]
}

Error

Status: Default, Error
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

href

Name Type Description

href

string

_links

Name Type Description

next

href

self

href

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.