- Erste Schritte
- Authentication
- Scopes und Berechtigungen
- Plattformverwaltungs-APIs
- Lizenzieren von Produktcodes
- Zuweisen von Lizenzen zu einer Organisation
- Zuweisung von Lizenzen zu einem Mandanten
- Zuweisung von Lizenzen zu einer Gruppe
- Zuweisung von Lizenzen zu einem Benutzer
Automation Suite API-Handbuch
Als Hostadministrator können Sie einen Endpunkt verwenden, um einer Organisation Lizenzen basierend auf der Organisations-ID zuzuweisen.
Um Organisationen und Mandanten Lizenzen zuzuweisen, müssen Sie sich mit den Host-Anmeldeinformationen 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'
Um das {access_token} zu erhalten, müssen Sie sich mit der ROPC-Methode authentifizieren, die unter ROPC-Authentifizierung beschrieben ist.
Pfadparameter
| Pfadparameter | Datentyp | Beschreibung |
|---|---|---|
hostAccountID | String | Erforderlich. Die ID des Hostkontos, das die Lizenzen zuweist. Verwenden Sie immer den Standardwert: feb0dd79-85b6-483b-b297-0e49a1aa5b7d |
organizationId | String | Erforderlich. 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 }
]
}
- 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 Organisation Produktlizenzen wie folgt zuweisen:
- Zwei Unattended-Roboter (der Lizenzcode ist
UNATT) - 1 AI Center Pro-Lizenz (der Lizenzcode ist
AIG) - 3 Testlizenzen (der Lizenzcode ist
TAUNATT)
- Zwei Unattended-Roboter (der Lizenzcode ist
Der Aufruf sollte dem folgenden Beispiel ähneln (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"
}