Skip to main content

PATCH /authCodes

Use this method to install or download license-activation keys for one or more authorization codes.

Note
This REST API requires Lenovo XClarity Administrator v3.5.0 or later.

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
    AttributesRequired / OptionalTypeDescription
    authCodesOptionalArray of objectsInformation about each authorization code
     authCodeOptionalStringLicense-authorization code ID
     licenseKeysOptionalArray of objectsInformation about each license-activation key
      licenseKeyIdOptionalStringLicense-key ID

    This attribute is idempotent (cannot be changed).

      customerNumberOptionalStringLenovo customer number associated with the license-activation key
      quantityOptionalIntegerNumber of redeemed licenses
      stateOptionalStringLicense-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
    AttributesRequired / OptionalTypeDescription
    authCodesOptionalArray of objectsInformation about each authorization code
     authCodeOptionalStringLicense-authorization code ID
     licenseKeysOptionalArray of objectsInformation about each license key
      licenseKeyIdOptionalStringLicense-key ID

    This attribute is idempotent (cannot be changed).

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

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

When licenseKyes.state=downloaded, a link to the license authorization-keys file is returned in the Location attribute in the response header.
Location: https://192.0.2.0/filename.zip

Response body

AttributesTypeDescription
responseArray of objectsInformation about each license-activation key
 resultStringRequest status for the key
 filenameStringFile name for the license-activation keys
resultStringResults of the request. This can be one of the following values.
  • success. The request completed successfully.
  • failed. The request failed. A descriptive error message was returned.
  • warning. The request completed with a warning. A descriptive error message was returned.
messagesArray of objectsInformation about one or more messages
 idStringMessage identifier of a returned message
 textStringMessage text associated with the message identifier
 explanationStringAdditional information to clarify the reason for the message
 recoveryArray of objectsRecovery information
  textStringUser actions that can be taken to recover from the event
  URLStringLink to the help system for more information, if available
The following example is returned if the request is successful.
{
"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": ""
}
}]
}