POST /authCodes

Authentication​

Authentication with username and password is required.

Request URL​

POST https://{management_server_IP}/authCodes

Query parameters​

None

Request body​

• Add a single authorization code

  Attributes			Required / Optional	Type	Description
  authCode			Required	String	License-authorization code ID
  lenovoCustomerNumber			Required if authCode is not specified	String	Lenovo customer number You can specify either authCode or lenovoCustomerNumber, but not both.
  retrieveKeys			Optional	Boolean	Indicates whether to retrieve license-activation keys. This can be one of the following values. true. Retrieve license-activation keys. false. (default) Do not retrieve license-activation keys.

  The following example adds an authorization code to XClarity Administrator but does not retrieve the license-activation keys for that code.

  {
     "authCode": "YYA7BQ2V37V11O0AID2K4"
  }
  

  The following example adds an authorization code to XClarity Administrator and retrieves license-activation keys for that code.

  {
     "authCode": "YYA7BQ2V37V11O0AID2K4"
     "retrieveKeys": true
  }
  

  The following example retrieves license-activation keys for that all authorization codes associated with the specified Lenovo customer number.

  {
     "lenovoCustomerNumber": "1234567890",
     "retrieveKeys": true
  }
  

• Add multiple authorization codes

  Use the multipart/form-data content type to import a CSV file that contains one or more authorization codes, separated by a comma (for example, WWGDISQHE24UQK05MVM1P9,WWMEHFI7SNL7K9L59T6OBT,WWTRPECTK9OFNHR8RJUPVT). For more information about the multipart/form-data media type, see Returning Values from Forms: multipart/form-data webpage.

  The following example imports a CVS file that contains the authorization codes.

  Request Header

  Content-Type: multipart/form-data; boundary=AaB03x
  

  Request body

  --AaB03x
      Content-Disposition: form-data; name="fileUpload"; filename="auth_codes.csv"
      Content-Type: application/octet-stream
  --AaB03x--
  
  

• Retrieve license-activation keys

  Attributes			Required / Optional	Type	Description
  authCode			Required	Object	Information about the authorization code for which you want to retrieve license-activation keys
  	authCode		Required	String	License-authorization code ID If you specify a Lenovo customer number, specify an empty string for the authorization code.
  	lenovoCustomerNumber		Optional	String	Lenovo customer number If you specify an authorization code, specify an empty string for the Lenovo customer number.
  	retrieveKeys		Optional	Boolean	Indicates whether to retrieve license-activation keys. This value is always true.

  The following example fetches the redeemed license-activation keys for a specific authorization code.

  {
     "authCode": {
        "authCode": "YYA7BQ2V37V11O0AID2K4",
        "retrieveKeys": true
     }
  }
  

  The following example fetches the redeemed license-activation keys for all authorization codes that are associated with a specific Lenovo customer number.

  {
     "authCode": {
        "authCode": "",
        "lenovoCustomerNumber": "1234567890",
        "retrieveKeys": true
     }
  }
  

Response codes​

Response body​

{
   "authCodes": [{
      "authCode": "YYA7BQ2V37V11O0AID2K4",
      "errorMsg": "",
      "featureCode": "1341 contact",
      "featureDescription": "Lenovo XClarity Pro, Per Managed Endpoint w/5 Yr SW S&S",
      "keysRedeemed": 0,
      "keysRemaining ": 50,
      "lenovoCustomerNumber": "1234567890",
      "licenseKeys": [],
      "partNumber": "5641PX5",
      "purchaseOrder": "00000000",
      "salesOrder": "999999999",
      "startDate": "2020-06-02",
   },
   {
      "authCode": "YYA7BQ2V37V11O0AID2K5",
      "errorMsg": "",
      "featureCode": "1341 contact",
      "featureDescription": "Lenovo XClarity Pro, Per Managed Endpoint w/5 Yr SW S&S",
      "keysRedeemed": 0,
      "keysRemaining ": 50,
      "lenovoCustomerNumber": "1234567890",
      "licenseKeys": [],
      "partNumber": "5641PX5",
      "purchaseOrder": "00000000",
      "salesOrder": "999999999",
      "startDate": "2020-06-02"
   }],
   "customerInfo": {
      "companyNameInEnglish": "Some Company",
      "companyNameInLocalLanguage": " Some Company ",
      "contactEmailAddress": "jane.doe@somecompany.com",
      "contactPhoneNumber": "9995551212",
      "customerAddress": "10 Main Street",
      "customerCity": "Rockville",
      "customerRegionStateOrProvince": "NY",
      "customerPostalCode": "12345",
      "country": "US",
      "firstName": "Jane",
      "lastName": "Doe",
      "preferredLanguage": "EN"
   }
}

{
   "authCodes": [{
      "authCode": "YYA7BQ2V37V11O0AID2K5",
      "errorMsg": "",
      "featureCode": "1341 contact",
      "featureDescription": "Lenovo XClarity Pro, Per Managed Endpoint w/5 Yr SW S&S",
      "keysRedeemed": 0,
      "keysRemaining ": 50,
      "lenovoCustomerNumber": "1234567890",
      "licenseKeys": [{
      "licenseKeyFile": "00001",
         "customerNumber": "1234567890",
         "licenseKeyId": "00001",
         "quantity": 20,
         "state": "installed"
      },
      {
         "customerNumber": "1234567890",
         "licenseKeyId": "00003",
         "quantity": 30,
         "state": "installed"
      },
      ...],
      "partNumber": "5641PX5",
      "purchaseOrder": "00000000",
      "salesOrder": "999999999",
      "startDate": "2020-06-02"
   }],
   "customerInfo": {
      "companyNameInEnglish": "Some Company",
      "companyNameInLocalLanguage": " Some Company ",
      "contactEmailAddress": "jane.doe@somecompany.com",
      "contactPhoneNumber": "9995551212",
      "customerAddress": "10 Main Street",
      "customerCity": "Rockville",
      "customerRegionStateOrProvince": "NY",
      "customerPostalCode": "12345",
      "country": "US",
      "firstName": "Jane",
      "lastName": "Doe",
      "preferredLanguage": "EN"
   }
}