PATCH /authCodes

Authentication​

Authentication with username and password is required.

Request URL​

PATCH https://{management_server_IP}/authCodes

Query parameters​

None

Request body​

• Install license-activation keys in Lenovo XClarity Administrator

  Attributes			Required / Optional	Type	Description
  authCodes			Optional	Array of objects	Information about each authorization code
  	authCode		Optional	String	License-authorization code ID
  	licenseKeys		Optional	Array of objects	Information about each license-activation key
  		licenseKeyId	Optional	String	License-key ID This attribute is idempotent (cannot be changed).
  		customerNumber	Optional	String	Lenovo customer number associated with the license-activation key
  		quantity	Optional	Integer	Number of redeemed licenses
  		state	Optional	String	License-key state. This is always installed.

  The following example install four license keys in Lenovo XClarity Administrator.

  {
     "authCodes": [{
        "authCode": "YYA7BQ2V37V11O0AID2K4",
        "licenseKeys": [{
           "licenseKeyId": "00002",
           "state": "installed"
        },
        {
           "licenseKeyId": "00003",
           "state": "installed"
        }]
     },
     {
        "authCode": "YYA7BQ2V37V11O0AID2K5",
        "licenseKeys": [{
           "licenseKeyId": "00025",
           "state": "installed"
        },
        {
           "licenseKeyId": "00032",
           "state": "installed"
        }]
     }]
  }
  

• Download license-activation keys to the local system

  Attributes			Required / Optional	Type	Description
  authCodes			Optional	Array of objects	Information about each authorization code
  	authCode		Optional	String	License-authorization code ID
  	licenseKeys		Optional	Array of objects	Information about each license key
  		licenseKeyId	Optional	String	License-key ID This attribute is idempotent (cannot be changed).
  		state	Optional	String	License-key state. This is always downloaded. The name and path of the license-activation keys file on the local system is returned in the "Location" field in the response header.

  The following example downloads four license keys to the local system.

  {
     "authCodes": [{
        "authCode": "YYA7BQ2V37V11O0AID2K4",
        "licenseKeys": [{
           "licenseKeyId": "00002",
           "state": "downloaded"
        },
        {
           "licenseKeyId": "00003",
           "state": "downloaded"
        }]
     },
     {
        "authCode": "YYA7BQ2V37V11O0AID2K5",
        "licenseKeys": [{
           "licenseKeyId": "00025",
           "state": "downloaded"
        },
        {
           "licenseKeyId": "00032",
           "state": "downloaded"
        }]
     }]
  }
  

Response codes​

Response header​

Location: https://192.0.2.0/filename.zip

Response body​

{
   "response": [{
      "result": "OK",
      "filename": "lnvgy_fod_0038_7777777777_anyos_noarch_00000011_1337.key"
   }],
   "result": "success",
   "messages": [{
      "id": "FQXHMSE0001I",
      "text": "The request completed successfully.",
      "explanation": "",
      "recovery": {
         "text": "Information only. No action is required.",
         "URL": ""
      }
   }]
}