Skip to main content

PUT /resourceAccessControl

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

Note
Only users with lxc-supervisor or lxc-security-admin authority can modify the access-control settings.

Authentication

Authentication with username and password is required.

Request URL

PUT https://{management_server_IP}/resourceAccessControl

Query parameters

None

Request body

AttributesRequired / OptionalTypeDescription
defaultRoleGroupsOptionalArray 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}).

publicAccessOptionalBooleanIndicates 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 .

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

  • false. Access control is disabled

The following example disables access control.
{
"resourceAccessControlEnabled": false
}
The following example enables access control and sets the default role groups for all devices.
{
"resourceAccessControlEnabled": true,
"defaultRoleGroups": ["lxc-hw-admin","lxc-os-admin"]
}

Response codes

CodeDescriptionComments
200OKThe request completed successfully.
400Bad RequestA query parameter or request attribute is missing or not valid, or the operation is not supported. A descriptive error message is returned in the response body.
401UnauthorizedThe user cannot be authenticated. Authentication has not been provided or has failed. A descriptive error message is returned in the response body.
403ForbiddenThe orchestrator server was prevented from fulfilling the request. A descriptive error message is returned in the response body. Ensure that you have privileges to perform the request.
404Not foundA specified resource cannot be found. A descriptive error message is returned in the response body.
409ConflictThere is a conflict with the current state of the resource. A descriptive error message is returned in the response body.
500Internal Server ErrorAn internal error occurred. A descriptive error message is returned in the response body.

Response body

None