Use this method to install or download license-activation keys for one or more authorization codes.
Authentication with user name and password is required.
PATCH https://{management_server_IP}/authCodes
None
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. |
{
"authCodes": [{
"authCode": "YYA7BQ2V37V11O0AID2K4",
"licenseKeys": [{
"licenseKeyId": "00002",
"state": "installed"
},
{
"licenseKeyId": "00003",
"state": "installed"
}]
},
{
"authCode": "YYA7BQ2V37V11O0AID2K5",
"licenseKeys": [{
"licenseKeyId": "00025",
"state": "installed"
},
{
"licenseKeyId": "00032",
"state": "installed"
}]
}]
}
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. |
{
"authCodes": [{
"authCode": "YYA7BQ2V37V11O0AID2K4",
"licenseKeys": [{
"licenseKeyId": "00002",
"state": "downloaded"
},
{
"licenseKeyId": "00003",
"state": "downloaded"
}]
},
{
"authCode": "YYA7BQ2V37V11O0AID2K5",
"licenseKeys": [{
"licenseKeyId": "00025",
"state": "downloaded"
},
{
"licenseKeyId": "00032",
"state": "downloaded"
}]
}]
}
Code | Description | Comments |
---|---|---|
200 | OK | The request completed successfully. |
400 | Bad Request | A 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. |
403 | Forbidden | The 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. |
409 | Conflict | There is a conflict with the current state of the resource. A descriptive error message is returned in the response body. |
500 | Internal Server Error | An internal error occurred. A descriptive error message is returned in the response body. |
Location: https://192.0.2.0/filename.zip
Attributes | Type | Description | ||
---|---|---|---|---|
response | Array of objects | Information about each license-activation key | ||
result | String | Request status for the key | ||
filename | String | File name for the license-activation keys | ||
result | String | Results of the request. This can be one of the
following values.
|
||
messages | Array of objects | Information about one or more messages | ||
id | String | Message identifier of a returned message | ||
text | String | Message text associated with the message identifier | ||
explanation | String | Additional information to clarify the reason for the message | ||
recovery | Array of objects | 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 |
{
"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": ""
}
}]
}