Create roleAssignmentScheduleRequests

Namespace: microsoft.graph

Führen Sie in PIM die folgenden Vorgänge über das unifiedRoleAssignmentScheduleRequest-Objekt aus:

  • Fordern Sie aktive und persistente Rollenzuweisungen für einen Prinzipal mit oder ohne Ablaufdatum an.
  • Aktivieren, Deaktivieren, Erweitern oder Verlängern einer berechtigten Rollenzuweisung für einen Prinzipal.

Um diese API zum Aktualisieren, Erneuern und Erweitern von Zuweisungen für sich selbst aufzurufen, müssen Sie die mehrstufige Authentifizierung (Multi-Factor Authentication, MFA) erzwungen haben und die Abfrage in einer Sitzung ausführen, in der sie zur MFA aufgefordert wurden. Weitere Informationen finden Sie unter Aktivieren von benutzerspezifischen Microsoft Entra mehrstufiger Authentifizierung zum Schützen von Anmeldeereignissen.

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

Globaler Dienst US Government L4 US Government L5 (DOD) China, betrieben von 21Vianet

Berechtigungen

Wählen Sie für diese API die Als am wenigsten privilegierten Berechtigungen gekennzeichneten Berechtigungen aus. Verwenden Sie nur dann eine Berechtigung mit höheren Berechtigungen , wenn dies für Ihre App erforderlich ist. 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) RoleAssignmentSchedule.ReadWrite.Directory RoleAssignmentSchedule.Remove.Directory, RoleEligibilitySchedule.Remove.Directory, RoleManagement.ReadWrite.Directory
Delegiert (persönliches Microsoft-Konto) Nicht unterstützt Nicht unterstützt
Anwendung RoleManagement.ReadWrite.Directory RoleAssignmentSchedule.Remove.Directory, RoleEligibilitySchedule.Remove.Directory

In delegierten Szenarien muss dem angemeldeten Benutzer außerdem mindestens eine der folgenden Microsoft Entra Rollen zugewiesen sein:

  • Für Lesevorgänge: Globaler Leser, Sicherheitsoperator, Sicherheitsleseberechtigter, Sicherheitsadministrator oder Administrator für privilegierte Rollen
  • Für Schreibvorgänge: Administrator für privilegierte Rollen

HTTP-Anforderung

POST /roleManagement/directory/roleAssignmentScheduleRequests

Anforderungsheader

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

Anforderungstext

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

Sie können die folgenden Eigenschaften angeben, wenn Sie eine unifiedRoleAssignmentScheduleRequest erstellen.

Eigenschaft Typ Beschreibung
Aktion unifiedRoleScheduleRequestActions Stellt den Typ des Vorgangs für die Rollenzuweisungsanforderung dar. Mögliche Werte sind: adminAssign, adminUpdate, adminRemove, selfActivate, selfDeactivate, adminExtend, adminRenew, selfExtend, selfRenew, unknownFutureValue.
  • adminAssign: Administratoren können Benutzern oder Gruppen Rollen zuweisen.
  • adminRemove: Administratoren können Benutzer oder Gruppen aus Rollen entfernen.
  • adminUpdate: Administratoren können vorhandene Rollenzuweisungen ändern.
  • adminExtend: Administratoren können ablaufende Zuweisungen erweitern.
  • adminRenew: Administratoren können abgelaufene Zuweisungen verlängern.
  • selfActivate: Benutzer können ihre Zuweisungen aktivieren.
  • selfDeactivate: Damit Benutzer ihre aktiven Zuweisungen deaktivieren können.
  • selfExtend: Benutzer können eine Verlängerung ihrer ablaufenden Zuweisungen anfordern.
  • selfRenew: Damit Benutzer die Verlängerung ihrer abgelaufenen Zuweisungen anfordern können.
Customdata String Freitextfeld zum Definieren von benutzerdefinierten Daten für die Anforderung. Optional.
principalId String Bezeichner des Prinzipals, dem die Zuweisung gewährt wurde. Erforderlich.
roleDefinitionId String Bezeichner des unifiedRoleDefinition-Objekts , das zugewiesen wird. Erforderlich.
directoryScopeId String Bezeichner des Verzeichnisobjekts, das den Bereich der Zuweisung darstellt. Der Bereich einer Zuweisung bestimmt die Gruppe von Ressourcen, für die dem Prinzipal Zugriff gewährt wurde. Verzeichnisbereiche sind freigegebene Bereiche, die im Verzeichnis gespeichert sind und von mehreren Anwendungen verstanden werden. Verwenden Sie / für mandantenweiten Bereich. Verwenden Sie appScopeId , um den Bereich nur auf eine Anwendung zu beschränken. Entweder directoryScopeId oder appScopeId ist erforderlich.
appScopeId String Bezeichner des app-spezifischen Bereichs, wenn die Zuweisung auf eine App festgelegt ist. Der Bereich einer Zuweisung bestimmt die Gruppe von Ressourcen, für 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. Auf Verwaltungseinheiten. Entweder directoryScopeId oder appScopeId ist erforderlich.
Rechtfertigung String Eine Nachricht, die von Benutzern und Administratoren beim Erstellen des unifiedRoleAssignmentScheduleRequest-Objekts bereitgestellt wird.

Optional für selfDeactivate - und adminRemove -Aktionen; kann für andere Aktionstypen optional oder erforderlich sein, abhängig von den Regeln in der Richtlinie, die mit der Microsoft Entra Rolle verknüpft ist. Weitere Informationen finden Sie unter Regeln in PIM.
scheduleInfo requestSchedule Der Zeitraum der Rollenzuweisungsanforderung. Wiederkehrende Zeitpläne werden derzeit nicht unterstützt. Erforderlich.
ticketInfo ticketInfo Ticketdetails, die mit der Rollenzuweisungsanforderung verknüpft sind, einschließlich Details der Ticketnummer und des Ticketsystems.

Optional für selfDeactivate - und adminRemove -Aktionen; kann für andere Aktionstypen optional oder erforderlich sein, abhängig von den Regeln in der Richtlinie, die mit der Microsoft Entra Rolle verknüpft ist. Weitere Informationen finden Sie unter Regeln in PIM.

Antwort

Bei erfolgreicher Ausführung gibt die Methode den 201 Created Antwortcode und ein unifiedRoleAssignmentScheduleRequest-Objekt im Antworttext zurück.

Beispiele

Beispiel 1: Admin Zuweisen einer Verzeichnisrolle zu einem Prinzipal

In der folgenden Anforderung erstellt der Administrator eine Anforderung zum Zuweisen einer Rolle, die von fdd7a751-b60b-444a-984c-02652fe8fa1c einem Prinzipal identifiziert wird, der durch die ID 071cc716-8147-4397-a5ba-b2105951cc0bidentifiziert wird. Der Bereich ihrer Rolle besteht aus allen Verzeichnisobjekten im Mandanten, und die Zuweisung ist dauerhaft.

Anforderung

POST https://graph.microsoft.com/v1.0/roleManagement/directory/roleAssignmentScheduleRequests
Content-Type: application/json

{
    "action": "adminAssign",
    "justification": "Assign Groups Admin to IT Helpdesk group",
    "roleDefinitionId": "fdd7a751-b60b-444a-984c-02652fe8fa1c",
    "directoryScopeId": "/",
    "principalId": "071cc716-8147-4397-a5ba-b2105951cc0b",
    "scheduleInfo": {
        "startDateTime": "2022-04-10T00:00:00Z",
        "expiration": {
            "type": "NoExpiration"
        }
    }
}

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/v1.0/$metadata#roleManagement/directory/roleAssignmentScheduleRequests/$entity",
    "id": "95c690fb-3eb3-4942-a03f-4524aed6f31e",
    "status": "Provisioned",
    "createdDateTime": "2022-04-11T11:50:03.9014347Z",
    "completedDateTime": "2022-04-11T11:50:05.9999343Z",
    "approvalId": null,
    "customData": null,
    "action": "adminAssign",
    "principalId": "071cc716-8147-4397-a5ba-b2105951cc0b",
    "roleDefinitionId": "fdd7a751-b60b-444a-984c-02652fe8fa1c",
    "directoryScopeId": "/",
    "appScopeId": null,
    "isValidationOnly": false,
    "targetScheduleId": "95c690fb-3eb3-4942-a03f-4524aed6f31e",
    "justification": "Assign Groups Admin to IT Helpdesk group",
    "createdBy": {
        "application": null,
        "device": null,
        "user": {
            "displayName": null,
            "id": "3fbd929d-8c56-4462-851e-0eb9a7b3a2a5"
        }
    },
    "scheduleInfo": {
        "startDateTime": "2022-04-11T11:50:05.9999343Z",
        "recurrence": null,
        "expiration": {
            "type": "noExpiration",
            "endDateTime": null,
            "duration": null
        }
    },
    "ticketInfo": {
        "ticketNumber": null,
        "ticketSystem": null
    }
}

Beispiel 2: Benutzer, der seine berechtigte Rolle aktiviert

Anforderung

In der folgenden Anforderung aktiviert ein durch principalId071cc716-8147-4397-a5ba-b2105951cc0b identifizierter Benutzer seine eigene berechtigte Rolle für eine Microsoft Entra Rolle, die durch die ID 8424c6f0-a189-499e-bbd0-26c1753c96d4identifiziert wird. Der Bereich ihrer Rolle besteht aus allen Verzeichnisobjekten im Mandanten, und die Zuweisung dauert fünf Stunden. Um diese Anforderung auszuführen, muss der aufrufende Benutzer die mehrstufige Authentifizierung (Multi-Factor Authentication, MFA) erzwungen haben und die Abfrage in einer Sitzung ausführen, in der er zur MFA aufgefordert wurde.

Um die Details seiner Berechtigungsanforderungen abzurufen und die Berechtigung für die Aktivierung zu identifizieren, ruft der Benutzer die unifiedRoleEligibilitySchedule: filterByCurrentUser-API auf.

POST https://graph.microsoft.com/v1.0/roleManagement/directory/roleAssignmentScheduleRequests/
Content-Type: application/json

{
    "action": "selfActivate",
    "principalId": "071cc716-8147-4397-a5ba-b2105951cc0b",
    "roleDefinitionId": "8424c6f0-a189-499e-bbd0-26c1753c96d4",
    "directoryScopeId": "/",
    "justification": "I need access to the Attribute Administrator role to manage attributes to be assigned to restricted AUs",
    "scheduleInfo": {
        "startDateTime": "2022-04-14T00:00:00.000Z",
        "expiration": {
            "type": "AfterDuration",
            "duration": "PT5H"
        }
    },
    "ticketInfo": {
        "ticketNumber": "CONTOSO:Normal-67890",
        "ticketSystem": "MS Project"
    }
}

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/v1.0/$metadata#roleManagement/directory/roleAssignmentScheduleRequests/$entity",
    "id": "911bab8a-6912-4de2-9dc0-2648ede7dd6d",
    "status": "Granted",
    "createdDateTime": "2022-04-13T08:52:32.6485851Z",
    "completedDateTime": "2022-04-14T00:00:00Z",
    "approvalId": null,
    "customData": null,
    "action": "selfActivate",
    "principalId": "071cc716-8147-4397-a5ba-b2105951cc0b",
    "roleDefinitionId": "8424c6f0-a189-499e-bbd0-26c1753c96d4",
    "directoryScopeId": "/",
    "appScopeId": null,
    "isValidationOnly": false,
    "targetScheduleId": "911bab8a-6912-4de2-9dc0-2648ede7dd6d",
    "justification": "I need access to the Attribute Administrator role to manage attributes to be assigned to restricted AUs",
    "createdBy": {
        "application": null,
        "device": null,
        "user": {
            "displayName": null,
            "id": "071cc716-8147-4397-a5ba-b2105951cc0b"
        }
    },
    "scheduleInfo": {
        "startDateTime": "2022-04-14T00:00:00Z",
        "recurrence": null,
        "expiration": {
            "type": "afterDuration",
            "endDateTime": null,
            "duration": "PT5H"
        }
    },
    "ticketInfo": {
        "ticketNumber": "CONTOSO:Normal-67890",
        "ticketSystem": "MS Project"
    }
}