Get a mapping
Get a mapping object by ID. This API call works with user, group or domain mapping object IDs.
HTTP request syntax (URI)
GET <base_URI>/v8/storage/mappings/{mappingObjectId}
Parameters
| Name | Type | Required | Values | Description |
| mappingObjectId | URI_PARAM | Y | string | Object Id of the mapping to retrieve – can be user, group or domain mapping object |
Return codes
| Code | Data | Description |
| 200 | userMapping, groupMapping or domainMapping | The mapping has been successfully retrieved. |
| 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 a group mapping by Object ID
curl -vk -H "X-Api-Key: zrxvSDAv9x.RIP4gkmKarG3beF.or.4Tc2im7oeqYN88C9XPGHxbXC" https://172.17.11.11:8444/v8/storage/mappings/303a3a3a313a3a3a65316134636561322d616662362d313164372d393933622d3963353534373037356537353a3a3a303a3a3a4f49445f24232140255f56
Response example
HTTP/1.1 200 OK
{
"groupMapping": {
"isNfs4NameFixed": true,
"isNfs4NameValid": true,
"isNtIdFixed": false,
"isNtIdValid": false,
"isNtNameFixed": true,
"isNtNameValid": true,
"isUnixIdFixed": false,
"isUnixIdValid": true,
"isUnixNameFixed": true,
"isUnixNameValid": true,
"nfs4Name": "root@localdomain",
"ntId": "",
"ntName": "PROTOCOLS\\root",
"objectId": "303a3a3a313a3a3a65316134636561322d616662362d313164372d393933622d3963353534373037356537353a3a3a303a3a3a4f49445f24232140255f56",
"unixId": 0,
"unixName": "root"
}
}
Request example: Get a user mapping by Object ID
curl -vk -H "X-Api-Key: zrxvSDAv9x.RIP4gkmKarG3beF.or.4Tc2im7oeqYN88C9XPGHxbXC" https://172.17.11.11:8444/v8/storage/mappings/303a3a3a303a3a3a65303761313265342d616662362d313164372d393664622d3963353534373037356537353a3a3a303a3a3a4f49445f24232140255f56
Response example
HTTP/1.1 200 OK
{
"userMapping": {
"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": ""
}
}
Request example: Get a domain mapping by Object ID
curl -vk -H "X-Api-Key: zrxvSDAv9x.RIP4gkmKarG3beF.or.4Tc2im7oeqYN88C9XPGHxbXC" https://172.17.11.11:8444/v8/storage/mappings/303a3a3a6e74446f6d61696e3a3a3a756b746573743a3a3a303a3a3a4f49445f24232140255f56
Response example
HTTP/1.1 200 OK
{
"domainMapping": {
"canMapUnixNames": false,
"kerberosRealm": "",
"nfs4Domain": "uktest.example.com",
"ntDomain": "uktest",
"objectId": "303a3a3a6e74446f6d61696e3a3a3a756b746573743a3a3a303a3a3a4f49445f24232140255f56"
}
}