Skip to main content

PUT /nodes/{uuid}/singleSignOn

Use this method to enable or disable single sign-on for a specific ThinkSystem or ThinkAgile server.

Note
This API requires Lenovo XClarity Administrator v3.3.0 or later.

Authentication​

Authentication with username and password is required.

Request URL​

PUT https://{management_server_IP}/nodes/{uuid}/singleSignOn

where {uuid} is the UUID of the ThinkSystem or ThinkAgile server. To obtain the server UUIDs, use GET /nodes.

Query parameters​

None

Request body​

ParameterRequired / OptionalTypeDescription
ssoEnabledRequiredBooleanIndicates whether single sign-on is enabled. This can be one of the following values.

  • true. Single sign-on is enabled.

  • false. Single sign-on is disabled.

Note
Single sign-on is disabled automatically when using the CyberArk identity-management system for authentication.
The following example clears a port-forwarding configuration.
{
   "ssoEnabled": true
}

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