In diesem Artikel wird erklärt, wie Organisationen Udemys SCIM-API (System for Cross-domain Identity Management) verwenden können, um Nutzerlizenzen hinzuzufügen oder zu entfernen.
SCIM wird von vielen Identitätsanbietern (IdP) wie Okta und OneLogin unterstützt.Du kannst die SCIM-API von Udemy Business auch für andere Identitätsanbieter oder selbstentwickelte Tools verwenden.
Hinweis: SCIM-API-Token für Udemy Business sind etwa zwei Jahre lang gültig. Administrator:innen erhalten eine Benachrichtigung über Folgendes:
- 30 Tage vor Ablauf des Token
- nach Ablauf des Token
Verwendung von Lizenzen
Lizenzen werden von einem Identitätsanbieter üblicherweise auf Gruppenebene vergeben, in einigen Fällen auch individuell. Ist das Lizenztyp-Attribut in der Anfrage enthalten, wird der Lizenztyp für die entsprechenden Nutzer:innen angegeben.
- Das Attribut kann bei der Erstellung von Nutzer:innen hinzugefügt werden. In dem Fall erhalten die Nutzer:innen die angegebenen Lizenzen, sobald sie ihr Udemy Business-Konto aktivieren.
- Das Attribut kann auch für eine:n bestehende:n Nutzer:in hinzugefügt werden und ermöglicht das Zuweisen oder Entfernen einer vorhandenen Lizenz.
- Wenn vom gewählten Typ nicht mehr genügend Lizenzen für das Konto verfügbar sind, sendet Udemy Business eine Fehlermeldung an den IdP, und die Änderungen werden nicht übernommen.
Beschränkungen beim Entfernen von Lizenzen:
Nutzer:innen müssen jeweils einen Lizenztyp besitzen. Der:die Nutzer:in muss im Konto deiner Organisation deaktiviert werden, um alle Lizenzen für eine:n Nutzer:in wieder verfügbar zu machen. Wenn Udemy Business ein leeres Lizenztyp-Attribut empfängt, wird es vom System ignoriert.
Die Lizenz kann derzeit für inaktive Nutzer:innen (d. h. Nutzer:innen, denen beide Lizenzen zugewiesen wurden, die sich jedoch noch nicht eingeloggt haben) nicht von „Pro” auf „Enterprise” herabgestuft werden.
Zuweisen des erforderlichen Lizenztyp-Attributs
Das Lizenztyp-Attribut, das beim Identitätsanbieter deiner Organisation hinzugefügt werden muss, lautet wie folgt:
urn:ietf:params:scim:schemas:extension:udemy:2.0:User.
Das Attribut muss als Stringliste angegeben werden. Jede Zeichenfolge muss dabei einem Lizenznamen entsprechen (siehe Abschnitt zu Lizenztypen unten für weitere Informationen).
Angabe der zulässigen Werte und der entsprechenden Lizenztypen
Zur Verwaltung des Lizenztyps eines Nutzers bzw. einer Nutzerin muss ein zulässiger Wert eingegeben werden. Die Eingabewerte aus der Tabelle unten werden mit den unterstützten Lizenztypen für Udemy Business abgeglichen. Beim Wert für den Lizenznamen muss die Groß-/Kleinschreibung nicht beachtet werden.
| Lizenzname | Typ |
Beispiele für zulässige Werte |
| Enterprise | Abo-Lizenz | Enterprise, eNtErpRisE, enTERpriseusw. |
|
Pro |
Zusätzliche Lizenz |
Pro, pRo, PRo,usw. |
Hinweis: Wenn ein unzulässiger Wert eingegeben wird, erscheint eine Fehlermeldung.
Hinzufügen von Lizenztypen bei der Erstellung von Nutzer:innen
Nachfolgend ein Beispiel, was bei deinem Identitätsanbieter eingegeben werden muss, um Lizenztypen bei der Nutzererstellung hinzuzufügen:
POST /scim/v2/Users HTTP/1.1 Host: myorganization.udemy.com Accept: application/scim+json Authorization: Bearer <enter your Bearer token here> Content-Type: application/scim+json { "schemas": [ "urn:ietf:params:scim:schemas:core:2.0:User", "urn:ietf:params:scim:schemas:extension:enterprise:2.0:User", "urn:ietf:params:scim:schemas:extension:udemy:2.0:User" ], "userName": "john.doe@udemy.com", "externalId": "someexternalidtest12312", "name": { "givenName": "John", "familyName": "Doe" }, "emails": [ { "primary": true, "type": "work", "value": "john.doe@udemy.com" } ], "active": true, "urn:ietf:params:scim:schemas:extension:udemy:2.0:User": { "licenseTypes": ["Enterprise", "Pro"] } }Attribute von bestehenden Nutzer:innen ändern und Lizenztypen hinzufügen
Nachfolgend ein Beispiel, was eingegeben werden muss, um die Attribute bestehender Nutzer:innen zu ändern und Lizenztypen hinzuzufügen:
PUT /scim/v2/Users/<scim-user-uuid> HTTP/1.1
Host: myorganization.udemy.com
Accept: application/scim+json
Authorization: Bearer <enter your Bearer token here>
Content-Type: application/scim+json
{
"schemas": [
"urn:ietf:params:scim:schemas:core:2.0:User",
"urn:ietf:params:scim:schemas:extension:enterprise:2.0:User",
"urn:ietf:params:scim:schemas:extension:udemy:2.0:User"
],
"userName": "john.doe@udemy.com",
"externalId": "someexternalidtest12312",
"name": {
"givenName": "John",
"familyName": "Doe"
},
"emails": [
{
"primary": true,
"type": "work",
"value": "john.doe@udemy.com"
}
],
"active": true,
"urn:ietf:params:scim:schemas:extension:udemy:2.0:User": {
"licenseTypes": ["Enterprise", "Pro"]
}
}
Festlegen nur des Felds „Lizenztyp” von bestehenden Nutzer:innen
Es gibt zwei Optionen für die Verwendung von PATCH-Anforderungen, um für eine:n bestehende:n Nutzer:in nur das Lizenztyp-Feld festzulegen:
"op": "add"
Nutze bitte folgende Option, um zusätzliche Lizenzen (z. B. eine Pro-Lizenz) zu bereits vorhandenen hinzuzufügen:
"op": "replace"
zum Überschreiben vorhandener Werte.
Hinweis:
Mit dem „add”-Befehl kann eine Udemy Business Pro-Lizenz zu bereits bestehenden Lizenzen (Enterprise oder Enterprise+Pro) hinzugefügt werden. Bei Nutzer:innen, die bereits über eine Enterprise-Lizenz verfügen, wird die Pro-Lizenz hinzugefügt. Bei Nutzer:innen, die bereits über eine Enterprise+Pro-Lizenz verfügen, werden keine weiteren Lizenzen hinzugefügt.
Nachfolgend ein Beispiel, was eingegeben werden muss, um nur das Feld Lizenztypen bei einem:einer bestehenden Nutzer:in festzulegen:
PATCH /scim/v2/Users/<scim-user-uuid> HTTP/1.1 Host: myorganization.udemy.com Accept: application/scim+json Authorization: Bearer <enter your Bearer token here> Content-Type: application/scim+json { "schemas": [ "urn:ietf:params:scim:api:messages:2.0:PatchOp", "urn:ietf:params:scim:schemas:extension:udemy:2.0:User", ], "Operations": [ { "op": "add", "urn:ietf:params:scim:schemas:extension:udemy:2.0:User": { "licenseTypes": ["Pro"] } } ] }WÜberschreiben aller derzeit aktiven Lizenzen eines Nutzers bzw. einer Nutzerin
Mit dem Befehl replace können alle derzeit aktiven Lizenzen eines Nutzers bzw. einer Nutzerin überschrieben werden. Dafür muss folgende Eingabe vorgenommen werden:
PATCH /scim/v2/Users/<scim-user-uuid> HTTP/1.1 Host: myorganization.udemy.com Accept: application/scim+json Authorization: Bearer <enter your Bearer token here> Content-Type: application/scim+json { "schemas": [ "urn:ietf:params:scim:api:messages:2.0:PatchOp", "urn:ietf:params:scim:schemas:extension:udemy:2.0:User", ], "Operations": [ { "op": "replace", "urn:ietf:params:scim:schemas:extension:udemy:2.0:User": { "licenseTypes": ["Enterprise", "Pro"] } } ] }