Retrieve local users for all SVMs
Retrieves local users for all Storage Virtual Machines (SVMs), including the local groups these users belong to. Use this endpoint to manage user access and group membership within your ONTAP environment.
HTTP method and endpoint
GET /protocols/cifs/local-users
Introduced in
ONTAP 9.9
Usage notes
Retrieves local users for all of the SVMs. Local groups to which this user belongs to are also displayed.
Advanced properties
-
membership
Related ONTAP commands
-
vserver cifs users-and-groups local-user show -
vserver cifs users-and-groups local-user show-membership
Learn more
Parameters
| Name | Type | In | Required | Description |
|---|---|---|---|---|
description |
string |
query |
False |
Filter by description
|
name |
string |
query |
False |
Filter by name
|
account_disabled |
boolean |
query |
False |
Filter by account_disabled |
sid |
string |
query |
False |
Filter by sid
|
full_name |
string |
query |
False |
Filter by full_name
|
svm.name |
string |
query |
False |
Filter by svm.name |
svm.uuid |
string |
query |
False |
Filter by svm.uuid |
membership.sid |
string |
query |
False |
Filter by membership.sid
|
membership.name |
string |
query |
False |
Filter by membership.name
|
fields |
array[string] |
query |
False |
Specify the fields to return. |
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.
|
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.
|
order_by |
array[string] |
query |
False |
Order results by specified fields and optional [asc |
Response
Status: 200, Ok
| Name | Type | Description |
|---|---|---|
_links |
||
num_records |
integer |
Number of local user records. |
records |
array[local_cifs_user] |
Example response
{
"_links": {
"next": {
"href": "/api/resourcelink"
},
"self": {
"href": "/api/resourcelink"
}
},
"num_records": 1,
"records": [
{
"_links": {
"self": {
"href": "/api/resourcelink"
}
},
"description": "This is local user.",
"full_name": "user name",
"membership": [
{
"_links": {
"self": {
"href": "/api/resourcelink"
}
},
"name": "SMB_SERVER01\\group",
"sid": "S-1-5-21-256008430-3394229847-3930036330-1001"
}
],
"name": "SMB_SERVER01\\user",
"sid": "S-1-5-21-256008430-3394229847-3930036330-1001",
"svm": {
"_links": {
"self": {
"href": "/api/resourcelink"
}
},
"name": "svm1",
"uuid": "02c9e252-41be-11e9-81d5-00a0986138f7"
}
}
]
}
Error
Status: Default, Error
| Name | Type | Description |
|---|---|---|
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 |
||
self |
_links
| Name | Type | Description |
|---|---|---|
self |
membership
| Name | Type | Description |
|---|---|---|
_links |
||
name |
string |
Local group name. The maximum supported length of a group name is 256 characters. |
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. |
svm
SVM, applies only to SVM-scoped objects.
| Name | Type | Description |
|---|---|---|
_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_user
| Name | Type | Description |
|---|---|---|
_links |
||
account_disabled |
boolean |
Indicates whether the user account is enabled or disabled. |
description |
string |
Description for the local user. |
full_name |
string |
User's full name. |
membership |
array[membership] |
Specifies local groups of which this local user is a member. |
name |
string |
Local user name. The maximum supported length of an user name is 20 characters. |
sid |
string |
The security ID of the local user which uniquely identifies the user. The user SID is automatically generated in POST and it is retrieved using the GET method. |
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. |