Ressourcentyp directoryRole
Namespace: microsoft.graph
Wichtig
Die APIs unter der /beta
Version in Microsoft Graph können sich ändern. Die Verwendung dieser APIs in Produktionsanwendungen wird nicht unterstützt. Um festzustellen, ob eine API in v1.0 verfügbar ist, verwenden Sie die Version Selektor.
Hinweis
Microsoft empfiehlt, anstelle dieser API die einheitliche RBAC-API zu verwenden. Die einheitliche RBAC-API bietet mehr Funktionalität und Flexibilität. Weitere Informationen finden Sie unter unifiedRoleDefinition-Ressourcentyp.
Stellt eine Microsoft Entra Verzeichnisrolle dar. Microsoft Entra Verzeichnisrollen werden auch als Administratorrollen bezeichnet. Weitere Informationen zu Verzeichnisrollen (Administratorrollen) finden Sie unter Zuweisen von Administratorrollen in Microsoft Entra ID. Mit Microsoft Graph können Sie Benutzer zu Verzeichnisrollen zuweisen, um ihnen Berechtigungen der Zielrolle zuzuweisen. Um eine Verzeichnisrolle zu lesen oder ihre Mitglieder zu aktualisieren, muss diese zuerst im Mandanten aktiviert werden. Nur die Unternehmensadministratoren sind standardmäßig aktiviert. Um andere verfügbare Verzeichnisrollen zu aktivieren, senden Sie eine POST-Anforderung mit der ID der directoryRoleTemplate , auf der die Verzeichnisrolle basiert. Listen Sie Verzeichnisrollenvorlagen auf, um alle anderen verfügbaren Verzeichnisrollen abzurufen. Erbt von directoryObject.
Standardmäßig sind Verzeichnisrollen mandantenweit festgelegt. Verzeichnisrollen (derzeit nur Der Benutzerkontoadministrator und Helpdeskadministrator) können jedoch auch auf Verwaltungseinheiten beschränkt werden.
Diese Ressource unterstützt Folgendes:
- Verwenden einer Delta-Abfrage zum Nachverfolgen von inkrementellen Hinzufügungen, Löschungen und Aktualisierungen durch Bereitstellen der delta-Funktion.
Methoden
Methode | Rückgabetyp | Beschreibung |
---|---|---|
Verzeichnisrolle abrufen | directoryRole | Dient zum Lesen der Eigenschaften und der Beziehungen des directoryRole-Objekts. |
Verzeichnisrollen auflisten | directoryRole-Sammlung | Dient zum Auflisten der Verzeichnisrollen, die im Mandanten aktiviert sind. |
Mitglied hinzufügen | directoryObject | Fügen Sie der Verzeichnisrolle einen Benutzer durch Veröffentlichen in der Mitgliedernavitionseingenschaft hinzu. |
Mitglieder auflisten | directoryObject-Sammlung | Ruft die Benutzer, die Mitglieder der Verzeichnisrolle sind, aus der Mitgliedernavigationseigenschaft ab. |
Mitglied entfernen | directoryObject | Dient zum Entfernen eines Benutzers aus der Verzeichnisrolle. |
Verzeichnisrolle aktivieren | directoryRole | Dient zum Aktivieren einer Verzeichnisrolle. |
Auflisten von bereichsbezogenen Mitgliedern | scopedRoleMembership-Sammlung | Listet die Mitglieder dieser Verzeichnisrolle auf, die auf administrative Einheiten beschränkt sind, und zwar über die Ressourcensammlung scopedRoleMembership. |
Delta abrufen | directoryRole-Sammlung | Abrufen inkrementeller Änderungen für Verzeichnisrollen. |
Eigenschaften
Eigenschaft | Typ | Beschreibung |
---|---|---|
description | String | Die Beschreibung für die Verzeichnisrolle. Schreibgeschützt. Unterstützt $filter (eq ), $search , $select . |
displayName | Zeichenfolge | Der Anzeigename für die Verzeichnisrolle. Schreibgeschützt. Unterstützt $filter (eq ), $search , $select . |
id | Zeichenfolge | Die eindeutige ID für die Verzeichnisrolle. Geerbt von directoryObject. Schlüssel, lässt keine Nullwerte zu, schreibgeschützt. Unterstützt $filter (eq ), $select . |
roleTemplateId | String | Die id der directoryRoleTemplate, auf der diese Rolle basiert. Die Eigenschaft muss angegeben werden, wenn eine Verzeichnisrolle mit einer POST-Operation in einem Mandanten aktiviert wird. Nach der Aktivierung der Verzeichnisrolle ist die Eigenschaft schreibgeschützt. Unterstützt $filter (eq ), $select . |
Beziehungen
Beziehung | Typ | Beschreibung |
---|---|---|
Elemente | directoryObject collection | Benutzer, die Mitglieder dieser Verzeichnisrolle sind. HTTP-Methoden: GET, POST, DELETE. Schreibgeschützt. Lässt NULL-Werte zu. Unterstützt $expand . |
scopedMembers | scopedRoleMembership-Sammlung | Mitglieder dieser Verzeichnisrolle, die auf administrative Einheiten beschränkt sind. Schreibgeschützt. Nullwerte zulassend. |
JSON-Darstellung
Die folgende JSON-Darstellung veranschaulicht den Ressourcentyp.
{
"description": "string",
"displayName": "string",
"id": "string (identifier)",
"roleTemplateId": "string"
}