UiPath Documentation
automation-suite
2.2510
true
Automation Suite API-Handbuch
Wichtig :
Bitte beachten Sie, dass dieser Inhalt teilweise mithilfe von maschineller Übersetzung lokalisiert wurde. Es kann 1–2 Wochen dauern, bis die Lokalisierung neu veröffentlichter Inhalte verfügbar ist.

Zuweisung von Lizenzen zu einem Mandanten

Weisen Sie einem Mandanten in der Automation Suite Lizenzen mithilfe der Lizenzverwaltungs-API zu, wobei Anmeldeinformationen des Hostadministrators und die Mandanten-ID erforderlich sind.

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 Host-Anmeldeinformationen authentifizieren.

API-Endpunkt​

PUT 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'
--header 'Authorization: Bearer {access_token}'\
--header 'Content-Type: application/json'
Hinweis:

Um das {access_token} zu erhalten, müssen Sie sich mit der ROPC-Methode authentifizieren, die unter ROPC-Authentifizierung beschrieben ist.

Pfadparameter​

ParameterDatentypBeschreibung
accountIdStringErforderlich.

Die ID der Organisation, in der sich Ihr Mandant befindet.
serviceScopeIdStringErforderlich.

Die ID des Mandanten, dem Sie Lizenzen zuweisen möchten.
serviceTypeStringErforderlich.

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 } 
        ]
    }
    {
      "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"
}
{
  "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"
}

Für die angegebene Organisation ist keine Kontolizenz zugewiesen.

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 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 dem folgenden Beispiel ähneln (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 }      
        ]
}'
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"
}
{
  "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"
}
  • API-Endpunkt​
  • Anforderungsheader​
  • Pfadparameter​
  • Anforderungstext​
  • Antworten​
  • 200 OK​
  • 404​
  • 409​
  • Beispielanforderung​

War diese Seite hilfreich?

Verbinden

Benötigen Sie Hilfe? Support(opens in new window)

Möchten Sie lernen? UiPath Academy(opens in new window)

Haben Sie Fragen? UiPath-Forum(opens in new window)

Auf dem neuesten Stand bleiben