Erstellen Sie roleEligibilityScheduleRequests

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.

Erstellen Sie ein neues unifiedRoleEligibilityScheduleRequest-Objekt . Dieser Vorgang ermöglicht es sowohl Administratoren als auch berechtigten Benutzern, berechtigte Zuweisungen hinzuzufügen, zu widerrufen oder zu erweitern.

Diese API ist in den folgenden nationalen Cloudbereitstellungen verfügbar.

Weltweiter Service US Government L4 US Government L5 (DOD) China, betrieben von 21Vianet
✅ ✅ ✅ ✅

Berechtigungen

Wählen Sie die Berechtigungen aus, die für diese API als am wenigsten privilegiert markiert sind. Verwenden Sie eine höhere Berechtigung oder Berechtigungen nur, wenn Ihre App dies erfordert. Ausführliche Informationen zu delegierten Berechtigungen und Anwendungsberechtigungen finden Sie unter Berechtigungstypen. Weitere Informationen zu diesen Berechtigungen finden Sie in der Berechtigungsreferenz.

Berechtigungstyp Berechtigungen mit den geringsten Berechtigungen Berechtigungen mit höheren Berechtigungen
Delegiert (Geschäfts-, Schul- oder Unikonto) RoleEligibilitySchedule.ReadWrite.Directory RoleManagement.ReadWrite.Directory
Delegiert (persönliches Microsoft-Konto) Nicht unterstützt Nicht unterstützt
Application RoleEligibilitySchedule.ReadWrite.Directory RoleManagement.ReadWrite.Directory

Wichtig

Für den delegierten Zugriff mit Geschäfts-, Schul- oder Unikonten muss dem angemeldeten Benutzer eine unterstützte Microsoft Entra-Rolle oder eine benutzerdefinierte Rolle zugewiesen werden, die die für diesen Vorgang erforderlichen Berechtigungen gewährt. Dieser Vorgang unterstützt die folgenden integrierten Rollen, die nur die geringstmöglichen Berechtigungen gewähren:

  • Für Lesevorgänge: Globaler Leser, Sicherheitsoperator, Sicherheitsleseberechtigter, Sicherheitsadministrator oder Administrator mit privilegierten Rollen
  • Für Schreibvorgänge: Administrator mit privilegierter Rolle

HTTP-Anforderung

POST /roleManagement/directory/roleEligibilityScheduleRequests

Anforderungsheader

Name Beschreibung
Authorization Bearer {token}. Erforderlich. Erfahren Sie mehr über Authentifizierung und Autorisierung.
Content-Type application/json. Erforderlich.

Anforderungstext

Geben Sie im Anforderungstext eine JSON-Darstellung des unifiedRoleEligibilityScheduleRequest-Objekts an.

Die folgende Tabelle zeigt die optionalen und erforderlichen Eigenschaften, wenn Sie die unifiedRoleEligibilityScheduleRequest erstellen.

Eigenschaft Typ Beschreibung
Aktion Zeichenfolge Stellt den Typ des Vorgangs in der Rollenberechtigungszuweisung dar. Die folgenden Werte sind möglich:
  • AdminAssign: Für Administratoren, um Benutzern die Rollenberechtigung oder Gruppen zuzuweisen.
  • AdminExtend: Für Administratoren, um ablaufende Zuweisungen zu verlängern.
  • AdminUpdate: Für Administratoren zum Ändern vorhandener Rollenzuweisungen.
  • AdminRenew: Für Administratoren, um abgelaufene Zuweisungen zu erneuern.
  • AdminRemove: Für Administratoren zum Entfernen von Benutzern oder Gruppen aus berechtigten Rollen.
  • UserAdd: Damit Benutzer ihre berechtigten Zuweisungen aktivieren können.
  • UserExtend: Für Benutzer, um eine Verlängerung ihrer ablaufenden berechtigten Zuweisungen anzufordern.
  • UserRemove: Damit Benutzer ihre aktiven berechtigten Zuweisungen deaktivieren können.
  • UserRenew: Damit Benutzer die Erneuerung ihrer abgelaufenen berechtigten Zuweisungen anfordern können.
appScopeId Zeichenfolge Bezeichner des App-spezifischen Bereichs, wenn der Zuweisungsbereich app-spezifisch ist. Der Umfang einer Zuweisung bestimmt die Gruppe von Ressourcen, auf die dem Prinzipal Zugriff gewährt wurde. App-Bereiche sind Bereiche, die nur von dieser Anwendung definiert und verstanden werden. Wird für mandantenweite App-Bereiche verwendet / . Verwenden Sie directoryScopeId , um den Bereich auf bestimmte Verzeichnisobjekte zu beschränken, z. B. Verwaltungseinheiten oder alle Benutzer.
directoryScopeId Zeichenfolge Bezeichner des Verzeichnisobjekts, der den Umfang der Zuweisung darstellt. Der Umfang einer Zuweisung bestimmt die Gruppe von Ressourcen, auf die dem Prinzipal Zugriff gewährt wurde. Verzeichnisbereiche sind freigegebene Bereiche, die im Verzeichnis gespeichert sind und von mehreren Anwendungen verstanden werden. Verwendung / für den gesamten mandantenweiten Bereich. Verwenden Sie appScopeId , um den Bereich auf eine Anwendung zu beschränken.
isValidationOnly Boolean Ein boolescher Wert, der bestimmt, ob der Aufruf eine Überprüfung oder ein tatsächlicher Aufruf ist. Legen Sie diese Eigenschaft nur fest, wenn Sie vor dem eigentlichen Übermitteln der Anforderung prüfen möchten, ob eine Aktivierung zusätzlichen Regeln wie MFA unterliegt.
Begründung Zeichenfolge Eine Meldung, die von Benutzern und Administratoren beim Erstellen der Anforderung bereitgestellt wird, über die Gründe für die Erforderlichkeit. Optional, wenn Aktion ist AdminRemove.
principalId Zeichenfolge Bezeichner des Prinzipals, dem die Zuweisung erteilt wird. Zum Beispiel ein Benutzer oder eine Gruppe. Für Gruppen müssen sie Rollen zugewiesen werden können, d. h. die isAssignableToRole der Gruppeneigenschaft ist auf truefestgelegt.
roleDefinitionId Zeichenfolge Bezeichner der unifiedRoleDefinition, für die die Zuweisung vorgesehen ist. Erforderlich. Schreibgeschützt.
scheduleInfo requestSchedule Das Zeitplanobjekt der Rollenzuweisungsanforderung. Diese Eigenschaft ist nicht erforderlich, wenn die Aktion ist AdminRemove.
ticketInfo ticketInfo Das ticketInfo-Objekt, das an die Rollenzuweisungsanforderung angehängt ist und Details zur Ticketnummer und zum Ticketsystem enthält. Optional.

Antwort

Bei erfolgreicher Ausführung gibt diese Methode einen 201 Created Antwortcode und ein unifiedRoleEligibilityScheduleRequest-Objekt im Antworttext zurück.

Beispiele

Beispiel 1: Admin zum Zuweisen einer Anforderung eines Rollenberechtigungszeitplans

In der folgenden Anforderung erstellt der Administrator eine Anforderung, um einem durch die ID07706ff1-46c7-4847-ae33-3003830675a1 identifizierten Prinzipal die Berechtigung einer identifizierten Rolle fdd7a751-b60b-444a-984c-02652fe8fa1c zuzuweisen. Der Umfang der Berechtigung umfasst alle Verzeichnisobjekte im Mandanten bis zum 30. Juni 2022 um Mitternacht UTC-Zeit.

Anforderung

POST https://graph.microsoft.com/beta/roleManagement/directory/roleEligibilityScheduleRequests
Content-Type: application/json

{
  "action": "AdminAssign",
  "justification": "Assign User Admin eligibility to IT Helpdesk (User) group",
  "roleDefinitionId": "fdd7a751-b60b-444a-984c-02652fe8fa1c",
  "directoryScopeId": "/",
  "principalId": "07706ff1-46c7-4847-ae33-3003830675a1",
  "scheduleInfo": {
    "startDateTime": "2021-07-01T00:00:00Z",
    "expiration": {
      "endDateTime": "2022-06-30T00:00:00Z",
      "type": "AfterDateTime"
    }
  }
}

Antwort

Das folgende Beispiel zeigt die Antwort.

Hinweis: Das hier gezeigte Antwortobjekt kann zur besseren Lesbarkeit gekürzt werden.

HTTP/1.1 201 Created
Content-Type: application/json

{
    "@odata.context": "https://graph.microsoft.com/beta/$metadata#roleManagement/directory/roleEligibilityScheduleRequests/$entity",
    "id": "672c03bf-226a-42ec-a8b7-3bfab96064a1",
    "status": "Provisioned",
    "createdDateTime": "2021-07-26T18:08:03.1299669Z",
    "completedDateTime": "2021-07-26T18:08:06.2081758Z",
    "approvalId": null,
    "customData": null,
    "action": "AdminAssign",
    "principalId": "07706ff1-46c7-4847-ae33-3003830675a1",
    "roleDefinitionId": "fdd7a751-b60b-444a-984c-02652fe8fa1c",
    "directoryScopeId": "/",
    "appScopeId": null,
    "isValidationOnly": false,
    "targetScheduleId": "672c03bf-226a-42ec-a8b7-3bfab96064a1",
    "justification": "Assign User Admin eligibility to IT Helpdesk (User) group",
    "createdBy": {
        "application": null,
        "device": null,
        "user": {
            "displayName": null,
            "id": "fc9a2c2b-1ddc-486d-a211-5fe8ca77fa1f"
        }
    },
    "scheduleInfo": {
        "startDateTime": "2021-07-26T18:08:06.2081758Z",
        "recurrence": null,
        "expiration": {
            "type": "afterDateTime",
            "endDateTime": "2022-06-30T00:00:00Z",
            "duration": null
        }
    },
    "ticketInfo": {
        "ticketNumber": null,
        "ticketSystem": null
    }
}

Beispiel 2: Admin zum Entfernen einer vorhandenen Anforderung eines Rollenberechtigungszeitplans

In der folgenden Anforderung erstellt der Administrator eine Anforderung zum Widerrufen der Berechtigung einer Rolle, die von fdd7a751-b60b-444a-984c-02652fe8fa1c einem durch die ID07706ff1-46c7-4847-ae33-3003830675a1 identifizierten Prinzipal identifiziert wurde.

Anforderung

POST https://graph.microsoft.com/beta/roleManagement/directory/roleEligibilityScheduleRequests
Content-Type: application/json

{
    "action": "AdminRemove",
    "justification": "Assign User Admin eligibility to IT Helpdesk (User) group",
    "roleDefinitionId": "fdd7a751-b60b-444a-984c-02652fe8fa1c",
    "directoryScopeId": "/",
    "principalId": "07706ff1-46c7-4847-ae33-3003830675a1",
    "scheduleInfo": {
        "startDateTime": "2021-07-26T18:08:06.2081758Z",
        "expiration": {
            "endDateTime": "2022-06-30T00:00:00Z",
            "type": "AfterDateTime"
        }
    }
}

Antwort

Das folgende Beispiel zeigt die Antwort. Die Anforderung gibt ein Antwortobjekt zurück, das den Status zuvor berechtigter Zuweisungsänderungen als Revokedanzeigt. Der Prinzipal sieht seine zuvor berechtigte Rolle nicht mehr.

Hinweis: Das hier gezeigte Antwortobjekt kann zur besseren Lesbarkeit gekürzt werden.

HTTP/1.1 201 Created
Content-Type: application/json

{
    "@odata.context": "https://graph.microsoft.com/beta/$metadata#roleManagement/directory/roleEligibilityScheduleRequests/$entity",
    "id": "7f88a144-f9a9-4f8c-9623-39c321ae93c2",
    "status": "Revoked",
    "createdDateTime": "2021-08-06T17:59:12.4263499Z",
    "completedDateTime": null,
    "approvalId": null,
    "customData": null,
    "action": "AdminRemove",
    "principalId": "07706ff1-46c7-4847-ae33-3003830675a1",
    "roleDefinitionId": "fdd7a751-b60b-444a-984c-02652fe8fa1c",
    "directoryScopeId": "/",
    "appScopeId": null,
    "isValidationOnly": false,
    "targetScheduleId": null,
    "justification": "Assign User Admin eligibility to IT Helpdesk (User) group",
    "createdBy": {
        "application": null,
        "device": null,
        "user": {
            "displayName": null,
            "id": "fc9a2c2b-1ddc-486d-a211-5fe8ca77fa1f"
        }
    },
    "scheduleInfo": {
        "startDateTime": "2021-07-26T18:08:06.2081758Z",
        "recurrence": null,
        "expiration": {
            "type": "afterDateTime",
            "endDateTime": "2022-06-30T00:00:00Z",
            "duration": null
        }
    },
    "ticketInfo": {
        "ticketNumber": null,
        "ticketSystem": null
    }
}