Zuweisung von Lizenzen zu einem Mandanten

Verwenden Sie als Hostadministrator diesen Endpunkt, um einem Mandanten Lizenzen basierend auf der Mandanten-ID zuzuweisen.

Wichtig: Um Organisationen und Mandanten Lizenzen zuzuweisen, müssen Sie sich mit den Hostanmeldeinformationen authentifizieren.

API-Endpunkt

https://{yourDomain}/lrm/api/account/{accountId}/service-license/{serviceScopeId}/{serviceType}

Hinweis: Um jedem aktivierten Dienst des Mandanten Lizenzen zuzuweisen, müssen Sie für jeden Dienst einen separaten API-Aufruf durchführen.

Anforderungsheader

--header 'Authorization: Bearer {access_token}'\
--header 'Content-Type: application/json'

Hinweis: Um das {access_token} zu erhalten, müssen Sie sich mit der hier beschriebenen ROPC-Methode authentifizieren.

Pfadparameter

Pfadparameter	Datentyp	Beschreibung
accountId (erforderlich)	String	Die ID der Organisation, in der sich Ihr Mandant befindet.
serviceScopeId (erforderlich)	String	Die ID des Mandanten, dem Sie Lizenzen zuweisen möchten.
serviceType (erforderlich)	String	Der Diensttyp.

Anforderungstext

Der Anforderungstext enthält das Array der Lizenzcodes für verschiedene Produkte und die entsprechende Menge.

{
      "tenantName": "string",
      "products": 
        [
          { "code": "string", "quantity": 0 } 
        ]
    }

Hinweis:

• Eine Übersicht über die verfügbaren Lizenzcodes, die Sie im Anforderungstext verwenden können, finden Sie unter Lizenzcodes.
• Sie können so viele Lizenzen zuweisen, wie die Organisation erworben hat.

Antworten

200 OK

Gibt die zugeordneten Dienstlizenzen zurück.

{
  "accountId": "string",
  "serviceScopeId": "string",
  "serviceType": "string",
  "license": {
    "licenseCode": "string",
    "bundleCode": "string",
    "subscriptionCode": "string",
    "licenseStatus": "string",
    "startDate": 0,
    "endDate": 0,
    "gracePeriod": 0,
    "products": [
      {
        "code": "string",
        "quantity": 0,
        "type": "string",
        "features": [
          {
            "code": "string",
            "type": "string",
            "value": "string"
          }
        ]
      }
    ],
    "templates": [
      {
        "productCode": "string",
        "products": [
          {
            "code": "string",
            "type": "string"
          }
        ]
      }
    ],
    "payload": "string",
    "boonLicenseCode": "string"
  },
  "userLicensingEnabled": true,
  "accountLicenseCode": "string"
}

404

Für die angegebene Organisation ist keine Kontolizenz zugewiesen.

409

Die Lizenzzuweisung ist nicht zulässig, da sie die Anzahl der Kontolizenzen überschreitet.

Beispielanforderung

Angenommen, Sie haben alle Informationen gesammelt, die zum Erstellen des API-Aufrufs erforderlich sind.

• Ihre {baseURL} ist: https://tom-jones-server.com
• Ihre {access_token} ist: 1234 (aus Gründen der Länge).
• Die {accountId} des Mandanten, der eine Lizenzzuweisung benötigt, ist: y-y-y-delilah
• Der {serviceScopeId} ist: y1968. Der Mandant hat den Document Understanding-Dienst aktiviert.
• Sie möchten der oben genannten Organisation Produktlizenzen wie folgt zuweisen:
  • 5 Unattended-Roboter (der Lizenzcode ist UNATT)
  • 4 NonProduction-Roboter (der Lizenzcode ist NONPR)
  • 2 Document Understanding-Lizenzen (der Lizenzcode ist TIE)

Der Aufruf sollte wie folgt aussehen (cURL):

curl --location --request POST 'https://tom-jones-server.com/lrm/api/account/y-y-y-delilah/service-license/y1968/?????' \
--header 'Authorization: Bearer 1234' \
--header 'Content-Type: application/json' \
--data-raw '{
    "productQuantities": 
        [
          { "code": "UNATT", "quantity": 5 },
          { "code": "NONPR", "quantity": 4 },
          { "code": "TIE", "quantity": 2 }      
        ]
}'

Hier ist der Antworttext für eine erfolgreiche Lizenzzuweisung:

{
  "accountId": "y-y-y-delilah",
  "serviceScopeId": "y1968",
  "serviceType": "string",
  "license": {
    "licenseCode": "string",
    "bundleCode": "string",
    "subscriptionCode": "string",
    "licenseStatus": "string",
    "startDate": 0,
    "endDate": 0,
    "gracePeriod": 0,
    "products": [
      {
        "code": "string",
        "quantity": 0,
        "type": "string",
        "features": [
          {
            "code": "string",
            "type": "string",
            "value": "string"
          }
        ]
      }
    ],
    "templates": [
      {
        "productCode": "string",
        "products": [
          {
            "code": "string",
            "type": "string"
          }
        ]
      }
    ],
    "payload": "string",
    "boonLicenseCode": "string"
  },
  "userLicensingEnabled": true,
  "accountLicenseCode": "string"
}