Get user mappings associated with a virtual server
Get the user mappings associated with a specific virtual server.
If the virtual server is configured in the global security context, the mappings retrieved will be those from the global context. Specify a virtual server ID of 0 to ensure the global mappings are retrieved. If the virtual server is configured to have an individual security context, the mappings will only be associated with the specified virtual server.
The number of users present can potentially be very large, so additional filters are provided to allow the number returned to be restricted to specific types.
HTTP request syntax (URI)
GET <base_URI>/v8/storage/virtual-servers/{virtualServerId}/mappings/user
Parameters
| Name | Type | Required | Values | Description |
| virtualServerId | URI_PARAM | Y | string/number | Specifies either the virtual server object ID or the HNAS storage virtual server ID. |
| includeFixed | BODY | N | boolean | Include all fixed mappings |
| includeFixedUnix | BODY | N | boolean | Include all fixed Unix mappings |
| includeFixedNt | BODY | N | boolean | Include all fixed NT mappings |
| includeFixedNfs4 | BODY | N | boolean | Include all fixed NFSv4 mappings |
| includeFixedKerberos | BODY | N | boolean | Include all fixed Kerberos mappings |
| includeInvalid | BODY | N | boolean | Include all invalid mappings |
| includeInvalidUnix | BODY | N | boolean | Include all invalid Unix mappings |
| includeInvalidNt | BODY | N | boolean | Include all invalid NT mappings |
| includeInvalidNfs4 | BODY | N | boolean | Include all invalid NFSv4 mappings |
| includeInvalidKerberos | BODY | N | boolean | Include all invalid Kerberos mappings |
Return codes
| Code | Data | Description |
| 200 | userMappings | List of user mappings retrieved successfully. |
| 400 | Error Message | Missing or invalid request contents. |
| 404 | Error Message | Requested resource not found. |
| 500 | Error message | Error associated with the storage system. |
Any HTTP status code other than 200 indicates that the API did not complete successfully.
Request example: Get user mappings that matches unixName=terry
curl -vk -H "X-Api-Key: zrxvSDAv9x.RIP4gkmKarG3beF.or.4Tc2im7oeqYN88C9XPGHxbXC" https://172.17.11.11:8444/v8/storage/virtual-servers/1/mappings/user?unixName=terry
Response example
HTTP/1.1 200 OK
{
"userMappings": [
{
"isKerberosNameFixed": false,
"isKerberosNameValid": true,
"isNfs4NameFixed": false,
"isNfs4NameValid": true,
"isNtIdFixed": false,
"isNtIdValid": false,
"isNtNameFixed": false,
"isNtNameValid": true,
"isUnixIdFixed": true,
"isUnixIdValid": true,
"isUnixNameFixed": true,
"isUnixNameValid": true,
"kerberosName": "terry@EXAMPLE.COM",
"nfs4Name": "terry@example.com",
"ntId": "",
"ntName": "EXAMPLE\\terry",
"objectId": "303a3a3a303a3a3a65306462336230612d616662362d313164372d393836382d3963353534373037356537353a3a3a303a3a3a4f49445f24232140255f56",
"unixId": 522,
"unixName": "terry"
}
]
}
Request example: Get user mappings that include Fixed Kerberos details
curl -vk -H "X-Api-Key: zrxvSDAv9x.RIP4gkmKarG3beF.or.4Tc2im7oeqYN88C9XPGHxbXC" https://172.17.11.11:8444/v8/storage/virtual-servers/1/mappings/user?includeFixedKerberos=true
Response example
HTTP/1.1 200 OK
{
"userMappings": [
{
"isKerberosNameFixed": true,
"isKerberosNameValid": false,
"isNfs4NameFixed": true,
"isNfs4NameValid": true,
"isNtIdFixed": true,
"isNtIdValid": true,
"isNtNameFixed": false,
"isNtNameValid": true,
"isUnixIdFixed": true,
"isUnixIdValid": true,
"isUnixNameFixed": true,
"isUnixNameValid": true,
"kerberosName": "",
"nfs4Name": "ANONYMOUS@",
"ntId": "S-1-5-7",
"ntName": "NT AUTHORITY\\Anonymous Logon",
"objectId": "303a3a3a303a3a3a65303761313265342d616662362d313164372d393664392d3963353534373037356537353a3a3a303a3a3a4f49445f24232140255f56",
"unixId": 65534,
"unixName": "nobody"
},
{
"isKerberosNameFixed": true,
"isKerberosNameValid": false,
"isNfs4NameFixed": true,
"isNfs4NameValid": true,
"isNtIdFixed": true,
"isNtIdValid": true,
"isNtNameFixed": false,
"isNtNameValid": true,
"isUnixIdFixed": true,
"isUnixIdValid": false,
"isUnixNameFixed": true,
"isUnixNameValid": false,
"kerberosName": "",
"nfs4Name": "OWNER@",
"ntId": "S-1-5-32-21061",
"ntName": "BUILTIN\\Current Owner",
"objectId": "303a3a3a303a3a3a65303761313265342d616662362d313164372d393664622d3963353534373037356537353a3a3a303a3a3a4f49445f24232140255f56",
"unixId": 0,
"unixName": ""
}
]
}