GET /resourceAccessControl

Use this GET method to retrieve the current access-control settings.

Note: This API requires Lenovo XClarity Administrator v2.0.0 or later

Authentication

Authentication with user name and password is required.

Request URL

GET https://<management_server_IP>/resourceAccessControl

Query parameters

None

Request body

None

Response codes

Code Description
200 OK
500 Internal server error

Response body

Attributes Type Description
result String Results 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.
response Object  
  defaultRoleGroups Array of strings List 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>).

  publicAccess Boolean Indicates 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 .

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

  • false. Access control is disabled

messages Array Information about one or more messages.
  explanation String Additional information to clarify the reason for the message.
  id String The message identifier of a returned message.
  recovery Array Recovery information
    text String User actions that can be taken to recover from the event.
    URL String Link to the help system for more information, if available.
  text String Message 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": ""
   }]
}