Update an organization license

Updates the specified organization license by setting the values of the parameters passed. Any parameters not provided will be left unchanged.

PATCH/v3/organizations/{organizationId}/licenses/{id}
JWT
organization:license:update

Parameters

NameTypeInDescription
organizationId*stringpath
id*stringpathUnique identifier for the organization license.

Request Body Schema

PropertyTypeDescriptionConstraints
userGroupIds*arrayList of unique identifiers for the user groups.items: string

Request Example

{
  "userGroupIds": [
    "string"
  ]
}
Triggers webhook: organization.license.updated
POST <your-webhook-url>
{
  "event": "organization.license.updated",
  "data": {
    "id": "string",
    "createdAt": "2019-08-24T14:15:22Z",
    "updatedAt": "2019-08-24T14:15:22Z",
    "key": "string",
    "revoked": true,
    "suspended": true,
    "perpetual": true,
    "type": "node-locked",
    "validity": 0,
    "subscriptionInterval": "string",
    "totalActivations": 0,
    "totalDeactivations": 0,
    "allowedActivations": 0,
    "allowedDeactivations": 0,
    "allowedFloatingClients": 0,
    "leaseDuration": 0,
    "expiresAt": "2019-08-24T14:15:22Z",
    "effectiveDate": "2019-08-24T14:15:22Z",
    "notes": "string",
    "metadata": [
      {
        "id": "string",
        "createdAt": "2019-08-24T14:15:22Z",
        "updatedAt": "2019-08-24T14:15:22Z",
        "key": "string",
        "value": "string"
      }
    ],
    "meterAttributes": [
      {
        "id": "string",
        "createdAt": "2019-08-24T14:15:22Z",
        "updatedAt": "2019-08-24T14:15:22Z",
        "name": "string",
        "allowedUses": 0,
        "totalUses": 0,
        "grossUses": 0,
        "floating": true
      }
    ],
    "product": {
      "id": "string",
      "displayName": "string",
      "iconUrl": "string",
      "description": "string"
    },
    "productVersion": {
      "displayName": "string"
    },
    "entitlementSet": {
      "name": "string"
    },
    "userGroups": [
      {
        "id": "string",
        "createdAt": "2019-08-24T14:15:22Z",
        "updatedAt": "2019-08-24T14:15:22Z",
        "name": "string",
        "description": "string"
      }
    ]
  },
  "triggeredAt": "string"
}

Responses

200 OK
{
  "id": "string",
  "createdAt": "2019-08-24T14:15:22Z",
  "updatedAt": "2019-08-24T14:15:22Z",
  "key": "string",
  "revoked": true,
  "suspended": true,
  "perpetual": true,
  "type": "node-locked",
  "validity": 0,
  "subscriptionInterval": "string",
  "totalActivations": 0,
  "totalDeactivations": 0,
  "allowedActivations": 0,
  "allowedDeactivations": 0,
  "allowedFloatingClients": 0,
  "leaseDuration": 0,
  "expiresAt": "2019-08-24T14:15:22Z",
  "effectiveDate": "2019-08-24T14:15:22Z",
  "notes": "string",
  "metadata": [
    {
      "id": "string",
      "createdAt": "2019-08-24T14:15:22Z",
      "updatedAt": "2019-08-24T14:15:22Z",
      "key": "string",
      "value": "string"
    }
  ],
  "meterAttributes": [
    {
      "id": "string",
      "createdAt": "2019-08-24T14:15:22Z",
      "updatedAt": "2019-08-24T14:15:22Z",
      "name": "string",
      "allowedUses": 0,
      "totalUses": 0,
      "grossUses": 0,
      "floating": true
    }
  ],
  "product": {
    "id": "string",
    "displayName": "string",
    "iconUrl": "string",
    "description": "string"
  },
  "productVersion": {
    "displayName": "string"
  },
  "entitlementSet": {
    "name": "string"
  },
  "userGroups": [
    {
      "id": "string",
      "createdAt": "2019-08-24T14:15:22Z",
      "updatedAt": "2019-08-24T14:15:22Z",
      "name": "string",
      "description": "string"
    }
  ]
}