Validate update of user licenses

The PATCH /users/{userId}/licenses/validate endpoint validates update of user licenses for the user matching the provided user ID.

Headers

Header parameters in Requests (User Admin API) apply to this endpoint.

Authorization scopes supported:

Parameters

The endpoint accepts the following query parameter:

userID

The user ID of the required user.

Requests

Example request

curl -L -X POST "https://***.api.newvoicemedia.com/useradmin/users/8e22b1fe-d2ea-403d-8c03-50eb21188e79/licenses/validate" \
-H "Content-Type: application/json" \
-H "Accept: application/vnd.newvoicemedia.v4+json" \
-H "Authorization: Bearer <ACCESS_TOKEN>" \
--data-raw "<JSON BODY>"

Request body parameters

The endpoint requires an licenseTypes object in JSON format as in the request body.

{
  "licenseTypes": {
    "analytics": "none",
    "krispnoisecancellation": "enabled"
  }
}

where:

• userId. The unique ID of the user.
• licenseTypes. The license types assigned to the user.
  • analytics. The type of the analytics license. Possible values: creator, viewer, none.
  • krispnoisecancellation. The type of the krispnoisecancellation license. Possible values: enabled, none.

Responses

Successful response

Successful requests return a 200 Success code.

Example response

{
  "changeValidations": [
    {
      "licenseName": "Analytics",
      "licenseCapability": "Creator",
      "operationType": "Delete",
      "currentCount": 3,
      "countAfterAssignment": 3,
      "isAssignmentPossible": true,
      "validationErrors": []
    },
    {
      "licenseName": "KrispNoiseCancellation",
      "licenseCapability": "None",
      "operationType": "Delete",
      "currentCount": 3,
      "countAfterAssignment": 3,
      "isAssignmentPossible": true,
      "validationErrors": []
    },
    {
      "licenseName": "KrispNoiseCancellation",
      "licenseCapability": "Enabled",
      "operationType": "Add",
      "currentCount": 3,
      "countAfterAssignment": 4,
      "isAssignmentPossible": false,
      "validationErrors": [
      "License limit exceeded"
  ]
}

where:

• changeValidations. Validation results of license changes to be done for the requested user.
  • licenseName. The name of the license to be changed.
  • licenseCapability. The current/new capability of the license to be changed.
  • operationType. The type of operation to be done for the license change.
  • currentCount. Count of current assignments.
  • countAfterAssignnment. Count of assignments after successful license change.
  • isAssignmentPossible. The indicator of possibility to assign the license to the requested user.
  • validationErrors. Errors which can be caused by the license change for the requested user eg. when exceeded license limitations.