Zuweisung von Lizenzen zu einer Gruppe

Verwenden Sie als Organisationsadministrator diesen Endpunkt, um einer Gruppe Lizenzen zuzuweisen. Dazu müssen Sie eine externe Anwendung mit dem Scope PM.License.Write erstellen.

Erfahren Sie, wie Sie eine externe Anwendung erstellen.

API-Endpunkt

PUT https://{yourDomain}/{organizationName}/lease_/api/account/{accountId}/user-license/group/{groupId}

Anforderungsheader

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

Hinweis:

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

Pfadparameter

Parameter	Datentyp	Beschreibung
accountId	String	Erforderlich. Die ID der Organisation, in der sich Ihr Mandant befindet.
groupId	String	Erforderlich. Die ID der Gruppe, der Sie Lizenzen zuweisen möchten. Sie können diese ID abrufen, indem Sie die folgenden Schritte ausführen .

Anforderungstext

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

{
    "userBundleCodes": ["string"]
}

Hinweis:

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

Antworten

200 OK

Gibt die zugewiesenen Gruppenlizenzen zurück.

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://{yourDomain}/{organizationName}.
• Ihre {access_token} ist: 1234 (aus Gründen der Länge).
• Die {accountId} des Mandanten, der eine Lizenzzuweisung benötigt, ist: song-one
• Die {groupId} lautet: group-01.
• Sie möchten der Gruppe Benutzerlizenzen wie folgt zuweisen:
  • Automatisierungsentwickler – Benannter Benutzer (der Lizenzcode ist RPADEVPRONU)
  • Insights Designer (der Lizenzcode ist IDU)
  • Citizen Developer – Multiuser (der Lizenzcode ist CTZDEVCU)

Der Aufruf sollte dem folgenden Beispiel ähneln (cURL):

curl --location --request POST 'https://https://{yourDomain}/{organizationName}/lease_/api/account/1234/user-license/group/group-01' \
--header 'Authorization: Bearer 1234' \
--header 'Content-Type: application/json' \
--data-raw '{
    "userBundleCodes": ["RPADEVPRONU", "IDU", "CTZDEVCU"], 
    "useExternalLicense": false
}'

Hier ist der Antworttext für eine erfolgreiche Lizenzzuweisung:

{
  "groupId": "string",
  "organizationId": "string",
  "useExternalLicense": false,
  "userBundleCodes": [
    "string"
  ]
}