Skip to main content

Security

The following resources are available for performing security functions.

  • /certificateRevocationList
    Use this REST API to download all certificate revocation lists (CRLs) or to upload a CRL. A CRL is a list of certificates that have been revoked and are no longer trusted. A certificate might be revoked if it was incorrectly issued by the CA or if its key is compromised, lost, or stolen.
  • /certificateRevocationList/{CRL_id}
    Use this REST API to download or delete a specific certificate revocation list (CRL). A CRL is a list of certificates that have been revoked and are no longer trusted. A certificate might be revoked if it was incorrectly issued by the CA or if its key is compromised, lost, or stolen.
  • /certificatePolicy
    Use this REST API to return or modify the certificate policy type for the management server. This policy applies to all parts of the certificate, including the root CA certificate, server certificate, and CSR for externally signed certificates.
  • /certificateSettings
    Use this REST API to retrieve the saved certificate values from the most recent certificate creation.
  • /certificateSigningRequest
    Use this REST API to generate, download , or delete a Certificate Signing Request (CSR).
  • /cryptoSettings
    Use this REST API to retrieve or modify the current cryptography settings on Lenovo XClarity Administrator. The cryptographic settings determine how secure communications are handled between Lenovo XClarity Administrator and all managed systems. It sets the encryption-key lengths to be used if secure communications are implemented.
  • /encapsulationSettings
    Use this REST API to retrieve information about or modify Lenovo XClarity Administrator's global encapsulation setting.
  • /endpoint/signingCertificate/{id}/{resource}
    Use this REST API to retrieve a signed certificate from the chassis, rack server, or tower server containing the specified device and replace the certificate that is currently in the Lenovo XClarity Administrator trust store.
  • /identityManagementSystems
    Use this REST API to return a list of all configured identity-management systems.
  • /identityManagementSystems/cyberark
    Use this REST API to return information about or create the CyberArk identity-management system configuration.
  • /identityManagementSystems/cyberark/paths
    Use this REST API to return information about, modify, or delete a specific CyberArk path that is defined in Lenovo XClarity Administrator. A CyberArk path is made up of an application ID, safe, and optional folder that identify the location of onboarded user accounts in CyberArk.
  • /identityManagementSystems/cyberark/paths/{id}
    Use this REST API to return a list of all CyberArk paths that are defined in Lenovo XClarity Administrator, or to create a path.
  • /ldapClientSettings
    Use this REST API to retrieve or modify client settings when an external LDAP server is used for authentication.
  • /mutualAuthCertificates
    Use this REST API to return the list of all TLS mutual-authentication certificates or regenerate a TLS mutual-authentication certificate.
  • /mutualAuthCertificates/cyberark/{type}
    Use this REST API to download the mutual-authentication certificate for CyberArk, in PEM or DER format.
  • /mutualAuthCertificates/cyberark/details
    Use this REST API to return information about the mutual-authentication certificate for CyberArk.
  • /privileges
    Use this REST API to retrieve information about all user privileges.
  • /privileges/{id}
    Use this REST API to retrieve information about a specific user privilege.
  • /privilegeCategories
    Use this REST API to retrieve information about all privilege categories.
  • /privilegeCategories/{id}
    Use this REST API to retrieve information about a specific privilege category.
  • /resourceAccessControl
    Use this REST API to retrieve and modify the access-control settings.
  • /roles
    Use this REST API to retrieve information about all user roles and to create a custom role.
  • /roles/{id}
    Use this REST API to retrieve information about a specific user role, modify an existing custom role, or delete a role.
  • /roleGroups
    Use this REST API to retrieve information about all role groups or create a new role group.
  • /roleGroups/{id}
    Use this REST API to modify properties for that role group.
  • /roleGroups/{name}
    Use this REST API to retrieve information about a specific role group or delete a role group.
  • /ssoSettings
    Use this REST API to retrieve and modify client settings when an external SAML 2.0 identity provider is used for authentication.
  • /serverCertificate
    Use this REST API to generate a self-signed certificate, download a certificate, and upload a new signed certificate to Lenovo XClarity Administrator and creates a job to send the new certificate to all managed devices.
  • /serverCertificate/details
    Use this REST API to retrieve detailed information about the server certificate.
  • /serverCertificate/jobs
    Use this REST API to retrieve information about all known jobs for provisioning signed server certificates to managed devices.
  • /serverCertificate/jobs/{job_id}
    Use this REST API to retrieve information about a specific job for provisioning a signed server certificate to managed devices.
  • /service/country
    Use this REST API to return or modify the country in which XClarity Administrator is located. This country used to download Storage DM firmware.
  • /sessions
    Use this REST API to retrieve information about all active user sessions, or log in or out of Lenovo XClarity Administrator.
  • /sessions/{uuid}
    Use this REST API to disconnect (log off) another active user session from Lenovo XClarity Administrator.
  • /signingCertificate
    Use this REST API to retrieve information about or regenerate the Certificate Authority (CA) root (signing) certificate that is currently in the Lenovo XClarity Administrator trust store in Lenovo XClarity Administrator and creates a job to send the certificate to all managed devices.
  • /signingCertificate/details
    Use this REST API to retrieve detailed information about the Certificate Authority (CA) root (signing) certificate that is currently in the Lenovo XClarity Administrator trust store.
  • /signingCertificate/jobs
    Use this REST API to retrieve information about all known jobs for provisioning signing certificates to managed devices.
  • /signingCertificate/jobs/{job_id}
    Use this REST API to retrieve information about a specific job for provisioning a signing certificate to managed devices.
  • /singleSignOn
    Use this REST API to retrieve and modify the single sign-on setting.
  • /storedCredentials
    Use this REST API to retrieve information about all stored credentials and to create a stored credential.
  • /storedCredentials/{id}
    Use this REST API to retrieve information about a specific stored credential, to modify properties for a stored credential, or to delete a stored credential account.
  • /trustedCertificates
    Use this REST API to retrieve information about all trusted certificates that are currently installed, or upload and install a new trusted certificate.
  • /trustedCertificates/{id}
    Use this REST API to retrieve information about or delete a specific trusted certificate.
  • /trustedCertificates/details
    Use this REST API to retrieve detailed information about all trusted certificates.
  • /trustedCertificates/details/{id}
    Use this REST API to retrieve the detailed information about a specific trusted certificate.
  • /utils/countries
    Use this REST API to return a list of country and region codes.
  • /userAccounts
    Use this REST API to retrieve information about all user accounts or create a new user account. User accounts are used to log in and manage the Lenovo XClarity Administrator and all chassis and servers that are managed by the Lenovo XClarity Administrator.
  • /userAccounts/{id}
    Use this REST API to retrieve information about, modify, or delete a specific user account. User accounts are used to log in and manage the Lenovo XClarity Administrator and all chassis and servers that are managed by the XClarity Administrator.
  • /userAccounts/passwordChange
    Use this REST API to change the password for a specific user account that is currently logged in to Lenovo XClarity Administrator.
  • /userAccountSettings
    Use this REST API to retrieve or modify the security settings for all user accounts.