automation-suite
2024.10
true
UiPath logo, featuring letters U and I in white

Automation Suite API-Handbuch

Letzte Aktualisierung 11. Nov. 2024

Zuweisen von Lizenzen zu einer Organisation

Als Hostadministrator können Sie einen Endpunkt verwenden, um einer Organisation Lizenzen basierend auf der Organisations-ID zuzuweisen.

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

API-Endpunkt

PUT https://{yourDomain}/lrm/api/host/{hostAccountID}/organization/{organizationId}/license

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 hier beschriebenen ROPC-Methode authentifizieren.

Pfadparameter

Pfadparameter

Datentyp

Beschreibung

hostAccountID

(erforderlich)

String

Die ID des Hostkontos, das die Lizenzen zuweist.

Warnung:
Verwenden Sie immer den Standardwert: feb0dd79-85b6-483b-b297-0e49a1aa5b7d

organizationId

(erforderlich)

String

Die ID der Organisation, der Sie Lizenzen zuweisen möchten.

Anforderungstext

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

{
    "productQuantities": 
        [
          { "code": "string", "quantity": 0 } 
        ]
}{
    "productQuantities": 
        [
          { "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 Lizenzen zurück.

404

Die Hostlizenz ist nicht vorhanden, oder das Feature-Flag für lokale Flows ist deaktiviert.

409

Die Lizenzzuweisung ist nicht gestattet, da sie die Menge der Hostlizenzen ü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).
  • Ihre {hostAccountId} ist: j0ne5
  • Die {organizationId} , die eine Lizenzzuweisung benötigt, ist: y-y-y-delilah
  • Sie möchten der oben genannten Organisation Produktlizenzen wie folgt zuweisen:

Der Aufruf sollte wie folgt aussehen (cURL):

curl --location --request POST 'https://tom-jones-server.com/lrm/api/host/j0ne5/organization/y-y-y-delilah/license' \
--header 'Authorization: Bearer 1234' \
--header 'Content-Type: application/json' \
--data-raw '{
    "productQuantities": 
        [
          { "code": "UNATT", "quantity": 2 },
          { "code": "AIG", "quantity": 1 },
          { "code": "TAUNATT", "quantity": 3 }      
        ]
}'curl --location --request POST 'https://tom-jones-server.com/lrm/api/host/j0ne5/organization/y-y-y-delilah/license' \
--header 'Authorization: Bearer 1234' \
--header 'Content-Type: application/json' \
--data-raw '{
    "productQuantities": 
        [
          { "code": "UNATT", "quantity": 2 },
          { "code": "AIG", "quantity": 1 },
          { "code": "TAUNATT", "quantity": 3 }      
        ]
}'

Hier ist der Antworttext für eine erfolgreiche Lizenzzuweisung:

{
  "accountId": "y-y-y-delilah",
  "bundleCode": "string",
  "endDate": 0,
  "gracePeriod": 0,
  "licenseCode": "string",
  "licenseStatus": "string",
  "products": [
    {
      "code": "string",
      "quantity": 0,
      "type": "string",
      "features": [
        {
          "code": "string",
          "type": "string",
          "value": "string"
        }
      ]
    }
  ],
  "templates": [
    {
      "productCode": "string",
      "products": [
        {
          "code": "string",
          "type": "string"
        }
      ]
    }
  ],
  "startDate": 0,
  "subscriptionCode": "string",
  "subscriptionPlan": "string",
  "payload": "string",
  "type": "string",
  "parentLicenseCode": "string"
}{
  "accountId": "y-y-y-delilah",
  "bundleCode": "string",
  "endDate": 0,
  "gracePeriod": 0,
  "licenseCode": "string",
  "licenseStatus": "string",
  "products": [
    {
      "code": "string",
      "quantity": 0,
      "type": "string",
      "features": [
        {
          "code": "string",
          "type": "string",
          "value": "string"
        }
      ]
    }
  ],
  "templates": [
    {
      "productCode": "string",
      "products": [
        {
          "code": "string",
          "type": "string"
        }
      ]
    }
  ],
  "startDate": 0,
  "subscriptionCode": "string",
  "subscriptionPlan": "string",
  "payload": "string",
  "type": "string",
  "parentLicenseCode": "string"
}
  • API-Endpunkt
  • Anforderungsheader
  • Pfadparameter
  • Anforderungstext
  • Antworten
  • 200 OK
  • 404
  • 409
  • Beispielanforderung

War diese Seite hilfreich?

Hilfe erhalten
RPA lernen – Automatisierungskurse
UiPath Community-Forum
Uipath Logo White
Vertrauen und Sicherheit
© 2005–2024 UiPath. Alle Rechte vorbehalten