Feedback Bearbeiten

Update servicePrincipal

  • Artikel
  • 9 Minuten Lesedauer

Namespace: microsoft.graph

Wichtig

APIs unter der /beta Version in Microsoft Graph können geändert werden. Die Verwendung dieser APIs in Produktionsanwendungen wird nicht unterstützt. Um festzustellen, ob eine API in Version 1.0 verfügbar ist, verwenden Sie die Versionsauswahl .

Aktualisieren Sie die Eigenschaften des servicePrincipal-Objekts.

Wichtig

Die Verwendung von PATCH zum Festlegen vob passwordCredential wird nicht unterstützt. Verwenden Sie die addPassword- und removePassword-Methoden zum Aktualisieren des Kennworts für einen servicePrincipal.

Berechtigungen

Eine der nachfolgenden Berechtigungen ist erforderlich, um diese API aufrufen zu können. Weitere Informationen, unter anderem zur Auswahl von Berechtigungen, finden Sie im Artikel zum Thema Berechtigungen.

Berechtigungstyp Berechtigungen (von der Berechtigung mit den wenigsten Rechten zu der mit den meisten Rechten)
Delegiert (Geschäfts-, Schul- oder Unikonto) Application.ReadWrite.All, Directory.ReadWrite.All
Delegiert (persönliches Microsoft-Konto) Nicht unterstützt
Anwendung Application.ReadWrite.OwnedBy, Application.ReadWrite.All, Directory.ReadWrite.All

HTTP-Anforderung

PATCH /servicePrincipals/{id}

Anforderungsheader

Name Beschreibung
Authorization Bearer {token}. Erforderlich.
Content-Type application/json. Erforderlich.

Anforderungstext

Geben Sie im Anforderungstext die Werte für die relevanten Felder an, die aktualisiert werden sollen. Vorhandene Eigenschaften, die nicht im Anforderungstext enthalten sind, behalten ihre vorherigen Werte oder werden basierend auf Änderungen an anderen Eigenschaftswerten neu berechnet. Aus Gründen der Leistung sollten Sie vorhandene Werte, die nicht geändert wurden, nicht angeben.

Eigenschaft Typ Beschreibung
accountEnabled Boolescher Wert True, wenn das Dienstprinzipalkonto aktiviert ist; andernfalls false.
addIns addIn Definiert benutzerdefiniertes Verhalten, das von einem Verbraucherdienst verwendet werden kann, um eine App in bestimmten Kontexten aufzurufen. Beispielsweise können Anwendungen, die Datei-Streams rendern können, die addIns-Eigenschaft für deren "FileHandler"-Funktionalität festlegen. Dadurch können Dienste wie Microsoft 365 die Anwendung im Kontext eines Dokuments, an dem der Benutzer arbeitet, aufrufen.
alternativeNames Zeichenfolgenauflistung Wird zum Abrufen von Dienstprinzipalen nach Abonnement und zum Identifizieren von Ressourcengruppen und vollständigen Ressourcen-IDs für verwaltete Identitäten verwendet.
appRoleAssignmentRequired Boolescher Wert Gibt an, ob eine eppRoleAssignment für einen Benutzer oder eine Gruppe erforderlich ist, bevor Azure Active Directory einen Benutzer- oder Zugriffstoken für die Anwendung ausstellt. Lässt keine NULL-Werte zu.
appRoles appRole-Auflistung Die von der verknüpften Anwendung verfügbar gemachten Anwendungsrollen. Weitere Informationen finden Sie in der appRoles-Eigenschaftsdefinition in der application-Ressource. Lässt keine NULL-Werte zu.
customSecurityAttributes customSecurityAttributeValue Ein offener komplexer Typ, der den Wert eines benutzerdefinierten Sicherheitsattributs enthält, das einem Verzeichnisobjekt zugewiesen ist.

Um diese Eigenschaft zu aktualisieren, muss dem aufrufenden Prinzipal die Rolle "Attributzuweisungsadministrator" zugewiesen sein, und ihm muss die Berechtigung CustomSecAttributeAssignment.ReadWrite.All erteilt werden.
displayName Zeichenfolge Der Anzeigename für den Dienstprinzipal.
homepage String Startseite der Anwendung.
keyCredentials keyCredential-Auflistung Die Auflistung der wichtigsten Anmeldeinformationen, die mit dem Dienstprinzipal verknüpft sind. Lässt keine Nullwerte zu.
loginUrl Zeichenfolge Gibt die URL an, zu der der Dienstanbieter den Benutzer zur Authentifizierung bei Azure AD umgeleitet. Azure AD verwendet die URL zum Starten der Anwendung von Microsoft 365 oder von Azure AD My Apps. Wenn die Zeichenfolge leer ist, führt Azure AD die IdP-initiierte Anmeldung für Anwendungen aus, die mit SAML-basiertem einmaligen Anmelden konfiguriert sind. Der Benutzer startet die Anwendung über Microsoft 365, über Azure AD My Apps oder über die Azure AD SSO-URL.
logoutUrl Zeichenfolge Gibt die URL an, die vom Autorisierungsdienst von Microsoft verwendet wird, um einen Benutzer mithilfe von front-channel-, back-channel- oder SAML-Abmeldeprotokollen abzumelden.
notificationEmailAddresses Zeichenfolgenauflistung Gibt die Liste der E-Mail-Adressen an, an die Azure AD eine Benachrichtigung sendet, wenn sich das aktive Zertifikat dem Ablaufdatum nähert. Dies gilt nur für die Zertifikate, mit denen das SAML-Token signiert wird, das für Azure AD Gallery-Anwendungen ausgestellt wurde.
publishedPermissionScopes permissionScope-Sammlung Die von der verknüpften Anwendung verfügbar gemachten OAuth 2.0-Berechtigungen. Weitere Informationen finden Sie in der oauth2PermissionScopes-Eigenschaftsdefinition in der application-Ressource. Lässt keine NULL-Werte zu.
preferredSingleSignOnMode Zeichenfolge Gibt den Modus für einmaliges Anmelden an, der für diese Anwendung konfiguriert ist. Azure AD verwendet den bevorzugten Modus für einmaliges Anmelden zum Starten der Anwendung von Microsoft 365 oder von Azure AD My Apps aus. Die unterstützten Werte sind Kennwort, SAML, extern und oidc.
preferredTokenSigningKeyEndDateTime DateTimeOffset Gibt das Ablaufdatum für die „keyCredentials“ an, die für die Tokensignatur verwendet werden, gekennzeichnet durch preferredTokenSigningKeyThumbprint.
preferredTokenSigningKeyThumbprint Zeichenfolge Nur für die interne Verwendung reserviert. Schreiben Sie diese Eigenschaft nicht, und verwenden Sie diese Eigenschaft nicht anderweitig. Sie kann in zukünftigen Versionen möglicherweise entfernt werden.
publisherName Zeichenfolge Der Anzeigename des Mandanten, in dem verknüpfte Anwendung angegeben wird.
replyUrls Zeichenfolgenauflistung Die URLs, an die Benutzertoken zur Anmeldung bei der verknüpften Anwendung gesendet werden, oder die Umleitungs-URIs, an die die OAuth 2.0-Autorisierungscodes und Zugriffstoken für die verknüpfte Anwendung gesendet werden. Lässt keine Nullwerte zu.
samlSingleSignOnSettings samlSingleSignOnSettings Die Sammlung für Einstellungen im Zusammenhang mit der einmaligen SAML-Anmeldung.
servicePrincipalNames Zeichenfolgenauflistung Enthält die Liste der identifiersUris-, die aus der zugehörigen Anwendung kopiert werden. Hybridanwendungen können zusätzliche Werte hinzugefügt werden. Mithilfe dieser Werte können Sie die Berechtigungen identifizieren, die von dieser App in Azure AD verfügbar gemacht werden. Beispiel:
  • Client-Apps, die Berechtigungen für diese Ressource anfordern, können diese URIs verwenden, um die erforderlichen Berechtigungen in der requiredResourceAccess-Eigenschaft des Anwendungsmanifests oder im Blatt „API-Berechtigungen“ in der App-Registrierungsoberfläche anzugeben.
  • Client-Apps können einen Ressourcen-URI angeben, der auf den Werten dieser Eigenschaft basiert, um ein Zugriffstoken zu erhalten. Dies ist der im "aud"-Anspruch zurückgegebene URI.

Der Any-Operator ist für Filterausdrücke für mehrwertige Eigenschaften erforderlich. Lässt keine NULL-Werte zu.
tags Zeichenfolgenauflistung Lässt keine Nullwerte zu.
tokenEncryptionKeyId Zeichenfolge Gibt die keyId eines öffentlichen Schlüssels aus der keyCredentials-Sammlung an. Sofern konfiguriert, gibt Azure AD Token für diese Anwendung aus, die mit dem durch diese Eigenschaft angegebenen Schlüssel verschlüsselt sind. Der Anwendungscode, der das verschlüsselte Token erhält, muss das Token mit dem zugehörigen privaten Schlüssel entschlüsseln, bevor es für den angemeldeten Benutzer verwendet werden kann.

Antwort

Wenn die Methode erfolgreich verläuft, werden der Antwortcode 204 No Content und ein aktualisiertes servicePrincipal-Objekt im Antworttext zurückgegeben.

Beispiele

Beispiel 1: Aktualisieren der Eigenschaften des angegebenen Dienstprinzipals

Anforderung

Nachfolgend sehen Sie ein Beispiel der Anforderung.

PATCH https://graph.microsoft.com/beta/servicePrincipals/{id}
Content-type: application/json

{
  "appRoleAssignmentRequired": true
}

Antwort

Hier ist ein Beispiel für die Antwort. Hinweis: Das hier gezeigte Antwortobjekt wird möglicherweise zur besseren Lesbarkeit verkürzt.

HTTP/1.1 204 No Content

Beispiel 2: Zuweisen eines benutzerdefinierten Sicherheitsattributs mit einem Zeichenfolgenwert zu einem Dienstprinzipal

Das folgende Beispiel zeigt, wie einem Dienstprinzipal ein benutzerdefiniertes Sicherheitsattribut mit einem Zeichenfolgenwert zugewiesen wird.

  • Attributsatz: Engineering
  • Attribut: ProjectDate
  • Attributdatentyp: Zeichenfolge
  • Attributwert: "2022-10-01"

Um benutzerdefinierte Sicherheitsattribute zuzuweisen, muss dem aufrufenden Prinzipal die Rolle "Attributzuweisungsadministrator" zugewiesen werden, und dem aufrufenden Prinzipal muss die Berechtigung CustomSecAttributeAssignment.ReadWrite.All erteilt werden.

Weitere ähnliche Beispiele für Benutzer finden Sie unter Zuweisen, Aktualisieren oder Entfernen von benutzerdefinierten Sicherheitsattributen mithilfe der Microsoft Graph-API.

Anforderung

PATCH https://graph.microsoft.com/beta/servicePrincipals/{id}
Content-type: application/json

{
    "customSecurityAttributes":
    {
        "Engineering":
        {
            "@odata.type":"#Microsoft.DirectoryServices.CustomSecurityAttributeValue",
            "ProjectDate":"2022-10-01"
        }
    }
}

Antwort

HTTP/1.1 204 No Content