Skip to main content

GET /resourceAccessControl

Use this method to return the current access-control settings.

Authentication

Authentication with username and password is required.

Request URL

GET https://{management_server_IP}/resourceAccessControl

Query parameters

None

Request body

None

Response codes

CodeDescription
200OK
500Internal server error

Response body

AttributesTypeDescription
resultStringResults of the request. This can be one of the following values.
  • success. The request completed successfully.
  • failed. The request failed. A descriptive error message was returned.
responseObject 
 defaultRoleGroupsArray of stringsList of role groups that are authorized by default to view and manage all devices when the devices are initially managed.

After a device is managed by Lenovo XClarity Administrator, you can change the authorized role groups for that device. (see PUT /chassis/{uuid}, PUT /nodes/{uuid}, PUT /storage/{uuid}, and PUT /storage/{uuid}).

 publicAccessBooleanIndicates whether the resource can be accessed by all role groups. This can be one of the following values.
  • true. The resource is can be access by all role group.

  • false. The resource is restricted to specific role groups .

 resourceAccessControlEnabledStringIndicates whether access control is enabled. This can be one of the following values:
  • true. Access control is enabled

  • false. Access control is disabled

messagesArrayInformation about one or more messages.
 explanationStringAdditional information to clarify the reason for the message.
 idStringThe message identifier of a returned message.
 recoveryArrayRecovery information
  textStringUser actions that can be taken to recover from the event.
  URLStringLink to the help system for more information, if available.
 textStringMessage text associated with the message identifier.

Response example

{
"result": "success",
"response": {
"defaultRoleGroups": ["lxc-hw-admin","lxc-os-admin"]
"publicAccess": false,
"resourceAccessControlEnabled": true,
},
"messages": [{
"id": "FQXHMSE0001I",
"text": "The request completed successfully.",
"recovery": {
"text": "Information only. No action is required.",
"URL": ""
},
"explanation": ""
}]
}