servicePrincipal-Ressourcentyp
Namespace: microsoft.graph
Stellt eine Instanz einer Anwendung in einem Verzeichnis dar. Erbt von directoryObject.
Diese Ressource unterstützt die Verwendung einer Delta-Abfrage zum Nachverfolgen von inkrementellen Hinzufügungen, Löschungen und Aktualisierungen durch Bereitstellen einer delta-Funktion. Diese Ressource ist ein offener Typ, mit dem andere Eigenschaften übergeben werden können.
Methoden
Methode | Rückgabetyp | Beschreibung |
---|---|---|
List | servicePrincipal-Auflistung | Abrufen einer Liste von servicePrincipal-Objekten. |
Create | servicePrincipal | Erstellt ein neues servicePrincipal-Objekt. |
Get | servicePrincipal | Dient zum Lesen der Eigenschaften und Beziehungen des servicePrincipal-Objekts. |
Update | servicePrincipal | Aktualisieren des servicePrincipal-Objekts. |
Upsert | servicePrincipal | Erstellen Sie einen neuen servicePrincipal, falls dieser nicht vorhanden ist, oder aktualisieren Sie die Eigenschaften eines vorhandenen servicePrincipal.Create a new servicePrincipal if it't exist, or update the properties of an existing servicePrincipal. |
Delete | Keine | Löschen des servicePrincipal-Objekts. |
Get delta | servicePrincipal-Auflistung | Ruft inkrementelle Änderungen für Dienstprinzipale ab. |
Erstellte Objekte auflisten | directoryObject-Sammlung | Abrufen einer createdObject-Objektauflistung. |
Objekte im Besitz auflisten | directoryObject collection | Holen Sie sich eine ownObject-Objektsammlung. |
Gelöschte Elemente | ||
List | directoryObject-Sammlung | Dient zum Abrufen einer Liste von kürzlich gelöschten servicePrincipal-Objekten. |
Get | directoryObject | Dient zum Abrufen der Eigenschaften eines kürzlich gelöschten servicePrincipal-Objekts. |
Wiederherstellen | directoryObject | Dient zum Wiederherstellen eines kürzlich gelöschten servicePrincipal-Objekts. |
Endgültig löschen | Keine | Dienst zum endgültigen Löschen eines servicePrincipal-Objekts. |
App-Rollenzuweisungen | ||
List appRoleAssignments | appRoleAssignment-Auflistung | Ruft die App-Rollen ab, denen dieser Dienstprinzipal zugewiesen ist. |
appRoleAssignment hinzufügen | appRoleAssignment | Zuweisen einer App-Rolle zu diesem Dienstprinzipal. |
appRoleAssignment entfernen | Keine | Entfernen einer App-Rollenzuweisung von diesem Dienstprinzipal. |
List appRoleAssignedTo | appRoleAssignment-Auflistung | Abrufen der Benutzer, Gruppen und Dienstprinzipale, denen für diesen Dienstprinzipal App-Rollen zugewiesen wurden. |
Add appRoleAssignedTo | appRoleAssignment | Zuweisen einer App-Rolle für diesen Dienstprinzipal zu einem Benutzer, einer Gruppe oder einem Dienstprinzipal. |
Remove appRoleAssignedTo | Keine | Entfernen einer App-Rollenzuweisung für diesen Dienstprinzipal von einem Benutzer, einer Gruppe oder einem Dienstprinzipal. |
Zertifikate und Geheimnisse | ||
Add password | passwordCredential | Fügen Sie einem servicePrincipal ein sicheres Kennwort oder Geheimnis hinzu. |
Remove password | passwordCredential | Entfernen eines Kennworts oder Geheimnisses aus einem servicePrincipal. |
Add key | keyCredential | Hinzufügen von Schlüsselanmeldeinformationen zu einem Dienstprinzipal. |
Remove key | Keine | Entfernen von Schlüsselanmeldeinformation aus einem Dienstprinzipal. |
Hinzufügen eines Tokensignaturzertifikats | selfSignedCertificate | Fügen Sie dem Dienstprinzipal ein selbstsigniertes Zertifikat hinzu. Wird hauptsächlich zum Konfigurieren von SAML-basierten SSO-Anwendungen aus dem Microsoft Entra-Katalog verwendet. |
Delegierte Berechtigungsklassifizierungen | ||
List | delegatedPermissionClassification-Sammlung | Rufen Sie die Berechtigungsklassifizierungen für delegierte Berechtigungen ab, die von diesem Dienstprinzipal verfügbar gemacht werden. |
Add | delegatedPermissionClassification | Fügen Sie eine Berechtigungsklassifizierung für eine delegierte Berechtigung hinzu, die von diesem Dienstprinzipal verfügbar gemacht wird. |
Remove | Keine | Entfernen Sie eine Berechtigungsklassifizierung für delegierte Berechtigungen, die von diesem Dienstprinzipal verfügbar gemacht wird. |
Delegierte (OAuth2)-Berechtigungszuweisungen | ||
List | oAuth2PermissionGrant-Auflistung | Abrufen der Gewährungen delegierter Genehmigungen, mit denen dieser Dienstprinzipal für den Zugriff auf eine API im Auftrag eines angemeldeten Benutzers autorisiert wird. |
Mitgliedschaft | ||
List memberOf | directoryObject-Sammlung | Ruft die Gruppen, bei denen dieser Dienstprinzipal direktes Mitglied ist, aus der memberOf-Navigationseigenschaft ab. |
Auflisten transitiver Mitglieder von | directoryObject-Sammlung | Auflisten der Gruppen, denen dieser Dienstprinzipal angehört. Dieser Vorgang ist transitiv und schließt die Gruppen ein, in denen dieser Dienstprinzipal ein geschachteltes Mitglied. |
Mitgliedergruppen prüfen | String-Sammlung | Sucht nach einer Mitgliedschaft in einer angegebenen Liste von Gruppen. |
Überprüfen von Mitgliederobjekten | String-Sammlung | Überprüfen Sie die Mitgliedschaft in einer bestimmten Liste von Gruppen, Verzeichnis-Rollen oder Verwaltungsobjekten. |
Mitgliedergruppen abrufen | String-Sammlung | Abruf einer Liste der Gruppen, denen dieser Dienstprinzipal angehört. |
Mitgliedsobjekte abrufen | String collection | Dient zum Abrufen der Liste der Gruppen, administrativen Einheiten und Verzeichnisrollen, in denen dieser Dienstprinzipal Mitglied ist. |
Besitzer | ||
List | directoryObject collection | Ruft die Besitzer eines Dienstprinzipals ab. |
Add | directoryObject | Weisen Sie einem Dienstprinzipal einen Besitzer zu. Dienstprinzipalbesitzer können Benutzer oder andere Dienstprinzipale sein. |
Remove | Keine | Entfernen Sie einen Besitzer aus einem Dienstprinzipal. Als empfohlene bewährte Methode sollten Dienstprinzipale mindestens zwei Besitzer haben. |
Eigenschaften
Wichtig
Die spezifische Verwendung von $filter
und des Abfrageparameters $search
wird nur unterstützt, wenn Sie die Kopfzeile ConsistencyLevel verwenden, die auf eventual
und $count
festgelegt ist. Weitere Informationen finden Sie unter Erweiterte Abfragefunktionen für Verzeichnisobjekte.
Eigenschaft | Typ | Beschreibung |
---|---|---|
accountEnabled | Boolesch |
true , wenn das Dienstprinzipalkonto aktiviert ist; andernfalls false . Wenn auf false festgelegt ist, können sich keine Benutzer bei dieser App anmelden, auch wenn sie ihr zugewiesen sind. Unterstützt $filter (eq , ne , not , in ). |
addIns | addIn-Sammlung | 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 aufrufen, an dem der Benutzer arbeitet. |
alternativeNames | Zeichenfolgenauflistung | Wird verwendet, um Dienstprinzipale nach Abonnement abzurufen, Ressourcengruppen- und vollständige Ressourcen-IDs für verwaltete Identitäten zu identifizieren. Unterstützt $filter (eq , not , ge , le , startsWith ). |
appDescription | Zeichenfolge | Die von der verknüpften Anwendung verfügbar gemachte Beschreibung. |
appDisplayName | Zeichenfolge | Der von der verknüpften Anwendung verfügbar gemachte Anzeigename. |
appId | Zeichenfolge | Die eindeutige ID für die verknüpfte Anwendung (die appId-Eigenschaft). Sekundärschlüssel. Unterstützt $filter (eq , ne , not , in , startsWith ). |
applicationTemplateId | Zeichenfolge | Eindeutiger Bezeichner der applicationTemplate. Unterstützt $filter (eq , not , ne ). Schreibgeschützt.
null , wenn der Dienstprinzipal nicht aus einer Anwendungsvorlage erstellt wurde. |
appOwnerOrganizationId | Guid | Enthält die Mandanten-ID, in der die Anwendung registriert ist. Dies gilt nur für Dienstprinzipale, die von Anwendungen unterstützt werden. Unterstützt $filter (eq , ne , NOT , ge , le ). |
appRoleAssignmentRequired | Boolesch | Gibt an, ob Benutzern oder anderen Dienstprinzipalen eine App-Rollenzuweisung für diesen Dienstprinzipal erteilt werden muss, bevor Benutzer sich anmelden oder Apps Token erhalten können. Der Standardwert ist false . Lässt keine Nullwerte zu. Unterstützt $filter (eq , ne , NOT ). |
appRoles | appRole-Sammlung | Die Rollen, die von der Anwendung verfügbar gemacht werden, die mit diesem Dienstprinzipal verknüpft ist. Weitere Informationen finden Sie in der AppRoles-Eigenschaftsdefinition für die Anwendungsentität . 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. Lässt NULL-Werte zu. Wird nur auf $select zurückgegeben. Unterstützt $filter (eq , ne , not , startsWith ). Beim Filterwert wird die Groß-/Kleinschreibung beachtet. |
deletedDateTime | DateTimeOffset | Datum und Uhrzeit, zu denen der Dienstprinzipal gelöscht wurde. Schreibgeschützt. |
description | String | Freies Textfeld zur Eingabe einer internen Beschreibung für Endbenutzer des Dienstprinzipals. Endbenutzerportale wie MyApps zeigen die Anwendungsbeschreibung in diesem Feld an. Die maximal zulässige Größe beträgt 1.024 Zeichen. Unterstützt $filter (eq , ne , not , ge , le , startsWith ) und $search . |
disabledByMicrosoftStatus | Zeichenfolge | Gibt an, ob Microsoft die registrierte Anwendung deaktiviert hat. Mögliche Werte sind: null (Standardwert), NotDisabled und DisabledDueToViolationOfServicesAgreement (Gründe sind verdächtige, missbräuchliche oder böswillige Aktivitäten oder ein Verstoß gegen den Microsoft-Servicevertrag). Unterstützt $filter (eq , ne , not ). |
displayName | Zeichenfolge | Der Anzeigename für den Dienstprinzipal. Unterstützt $filter (eq , ne , not , ge , le , in , startsWith und eq für null -Werte), $search und $orderby . |
homepage | String | Startseite der Anwendung. |
id | Zeichenfolge | Der eindeutige Bezeichner für den Dienstprinzipal. Geerbt von directoryObject. Key. Lässt keine Nullwerte zu. Schreibgeschützt. Unterstützt $filter (eq , ne , not , in ). |
info | informationalUrl | Grundlegende Profilinformationen der erhaltenen Anwendung, wie z. B. die URLs für Marketing, Support, Nutzungsbedingungen und Datenschutzerklärung der App. Die Nutzungsbedingungen und Datenschutzbestimmungen werden auf der Oberfläche für die Benutzerzustimmung angezeigt. Weitere Informationen finden Sie unter Vorgehensweise: Hinzufügen von Nutzungsbedingungen und Datenschutzbestimmungen für registrierte Microsoft Entra-Apps. Unterstützt $filter (eq , ne , not , ge , le und eq für null -Werte). |
keyCredentials | keyCredential-Auflistung | Die Auflistung der wichtigsten Anmeldeinformationen, die mit dem Dienstprinzipal verknüpft sind. Lässt keine NULL-Werte zu. Unterstützt $filter (eq , not , ge , le ). |
loginUrl | Zeichenfolge | Gibt die URL an, unter der der Dienstanbieter den Benutzer an Microsoft Entra ID umleitet, um sich zu authentifizieren. Microsoft Entra ID verwendet die URL, um die Anwendung aus Microsoft 365 oder dem Microsoft Entra Meine Apps zu starten. Wenn leer, führt Microsoft Entra ID idP-initiierte Anmeldung für Anwendungen aus, die mit SAML-basiertem einmaligem Anmelden konfiguriert sind. Der Benutzer startet die Anwendung über Microsoft 365, die Microsoft Entra Meine Apps oder die Microsoft Entra SSO-URL. |
logoutUrl | Zeichenfolge | Gibt die URL an, die der Autorisierungsdienst von Microsoft verwendet, um einen Benutzer mithilfe von OpenID Connect-Frontkanal-, Back-Channel- oder SAML-Abmeldeprotokollen abzumelden. |
notes | String | Freies Textfeld zum Erfassen von Informationen zum Dienstprinzipal, das normalerweise für betriebliche Zwecke verwendet wird. Die maximal zulässige Größe beträgt 1.024 Zeichen. |
notificationEmailAddresses | Zeichenfolgenauflistung | Gibt die Liste der E-Mail-Adressen an, an die Microsoft Entra ID eine Benachrichtigung sendet, wenn sich das aktive Zertifikat dem Ablaufdatum nähert. Dies gilt nur für die Zertifikate, die zum Signieren des SAML-Tokens verwendet werden, das für Microsoft Entra Gallery-Anwendungen ausgestellt wurde. |
oauth2PermissionScopes | permissionScope-Sammlung | Die von der Anwendung zur Verfügung gestellten delegierten Berechtigungen. Weitere Informationen finden Sie unter der oauth2PermissionScopes-Eigenschaft für die API-Eigenschaft der Anwendungsentität. Lässt keine NULL-Werte zu. |
passwordCredentials | passwordCredential-Sammlung | Die Sammlung der Kennwortanmeldeinformationen, die mit der Anwendung verknüpft sind. Lässt keine Nullwerte zu. |
preferredSingleSignOnMode | Zeichenfolge | Gibt den Modus für einmaliges Anmelden an, der für diese Anwendung konfiguriert ist. Microsoft Entra ID verwendet den bevorzugten Modus für einmaliges Anmelden, um die Anwendung über Microsoft 365 oder das Meine Apps-Portal zu starten. Unterstützte Werte sind: password , saml , notSupported und oidc .
Anmerkung: Dieses Feld kann null für ältere SAML-Apps und für OIDC-Anwendungen gelten, bei denen es nicht automatisch festgelegt wird. |
preferredTokenSigningKeyThumbprint | Zeichenfolge | Diese Eigenschaft kann für SAML-Anwendungen (Apps, für die preferredSingleSignOnMode auf saml festgelegt ist) verwendet werden, um zu steuern, welches Zertifikat zum Signieren der SAML-Antworten verwendet wird. Schreiben Sie für Anwendungen, die nicht SAML sind, nicht auf diese Eigenschaft, oder verlassen Sie sich auf andere Weise auf diese Eigenschaft. |
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 NULL-Werte zu. |
resourceSpecificApplicationPermissions | resourceSpecificPermission-Sammlung | Die ressourcenspezifischen Anwendungsberechtigungen, die von dieser Anwendung verfügbar gemacht werden. Derzeit werden ressourcenspezifische Berechtigungen nur für Teams Apps unterstützt, die über Microsoft Graph auf bestimmte Chats und Teams zugreifen. Schreibgeschützt. |
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. Diese Werte können verwendet werden, um die Berechtigungen zu identifizieren, die von dieser App innerhalb Microsoft Entra ID verfügbar gemacht werden. Beispiel:
Der "any"-Operator ist für Filterausdrücke für mehrwertige Eigenschaften erforderlich. Lässt keine NULL-Werte zu. Unterstützt $filter (eq , not , ge , le , startsWith ). |
servicePrincipalType | Zeichenfolge | Gibt an, ob der Dienstprinzipal eine Anwendung, eine verwaltete Identität oder eine Legacyanwendung darstellt. Dies wird von Microsoft Entra ID intern festgelegt. Die servicePrincipalType-Eigenschaft kann auf drei verschiedene Werte festgelegt werden:
|
signInAudience | Zeichenfolge | Gibt die Microsoft-Konten an, die für die aktuelle Anwendung unterstützt werden. Schreibgeschützt. Unterstützte Werte:
|
tags | String-Sammlung | Benutzerdefinierte Zeichenfolgen, die zum Kategorisieren und Identifizieren des Dienstprinzipals verwendet werden können. Lässt keine Nullwerte zu. Der Wert ist die Vereinigung von Zeichenfolgen, die hier und in der tags-Eigenschaft der zugeordneten Anwendungsentität festgelegt sind. Unterstützt $filter (eq , not , ge , le , startsWith ). |
tokenEncryptionKeyId | Zeichenfolge | Gibt die keyId eines öffentlichen Schlüssels aus der keyCredentials-Sammlung an. Nach der Konfiguration gibt Microsoft Entra ID Token für diese Anwendung aus, die mit dem von dieser Eigenschaft angegebenen Schlüssel verschlüsselt wurden. 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. |
verifiedPublisher | verifiedPublisher | Gibt den überprüften Herausgeber der Anwendung an, die mit diesem Dienstprinzipal verknüpft ist. |
Beziehungen
Wichtig
Die spezifische Verwendung des $filter
Abfrageparameters wird nur unterstützt, wenn Sie den ConsistencyLevel-Header verwenden, der auf eventual
und $count
festgelegt ist. Weitere Informationen finden Sie unter Erweiterte Abfragefunktionen für Verzeichnisobjekte.
Beziehung | Typ | Beschreibung |
---|---|---|
appManagementPolicies | appManagementPolicy-Sammlung | Die auf diese Anwendung angewendete appManagementPolicy. |
appRoleAssignedTo | appRoleAssignment | App-Rollenzuweisungen für diese App oder diesen Dienst, die Benutzern, Gruppen und anderen Dienstprinzipien gewährt werden. Unterstützt $expand . |
appRoleAssignments | appRoleAssignment-Auflistung | App-Rollenzuweisung für eine andere App oder einen anderen Dienst, die diesem Dienstprinzipal gewährt wird. Unterstützt $expand . |
claimsMappingPolicies | claimsMappingPolicy-Sammlung | Die diesem Dienstprinzipal zugewiesenen claimsMappingPolicies. Unterstützt $expand . |
createdObjects | directoryObject-Sammlung | Verzeichnisobjekte, die von diesem Dienstprinzipal erstellt werden. Schreibgeschützt. Nullwerte zulassend. |
federatedIdentityCredentials | federatedIdentityCredential Sammlung | Verbundidentitäten für einen bestimmten Dienstprinzipaltyp – verwaltete Identität. Unterstützt $expand und $filter (/$count eq 0 , /$count ne 0 ). |
homeRealmDiscoveryPolicies | homeRealmDiscoveryPolicy-Sammlung | Die diesem Dienstprinzipal zugewiesenen homeRealmDiscoveryPolicies. Unterstützt $expand . |
memberOf | directoryObject-Sammlung | Rollen, denen dieser Dienstprinzipal angehört. HTTP-Methoden: GET; schreibgeschützt. Nullwerte zulassend. Unterstützt $expand . |
oauth2PermissionGrants | oAuth2PermissionGrant-Auflistung | Delegierte Berechtigungen, die diesen Dienstprinzipal für den Zugriff auf eine API im Auftrag eines angemeldeten Benutzers autorisieren. Schreibgeschützt. Lässt NULL-Werte zu. |
ownedObjects | directoryObject collection | Verzeichnisobjekte, die dieser Dienstprinzipal besitzt. Schreibgeschützt. Nullwerte zulassend. Unterstützt $expand , $select geschachtelt in $expand , und $filter (/$count eq 0 , /$count ne 0 , /$count eq 1 , /$count ne 1 ). |
owners | directoryObject-Sammlung | Verzeichnisobjekte, die Besitzer dieses Dienstprinzipals sind. Die Besitzer sind eine Gruppe von Nicht-Administratorbenutzern oder servicePrincipals, die dieses Objekt ändern dürfen. Schreibgeschützt. Nullwerte zulassend. Unterstützt $expand , $filter (/$count eq 0 , /$count ne 0 , /$count eq 1 , /$count ne 1 ) und $select geschachtelt in $expand . |
remoteDesktopSecurityConfiguration | remoteDesktopSecurityConfiguration | Das remoteDesktopSecurityConfiguration-Objekt, das auf diesen Dienstprinzipal angewendet wird. Unterstützt $filter (eq ) für die eigenschaft isRemoteDesktopProtocolEnabled . |
Synchronisation | Synchronisierung | Stellt die Funktion für die Microsoft Entra Identitätssynchronisierung über die Microsoft Graph-API dar. |
tokenIssuancePolicies | tokenIssuancePolicy-Sammlung | Die diesem Dienstprinzipal zugewiesenen tokenIssuancePolicies. |
tokenLifetimePolicies | tokenLifetimePolicy-Sammlung | Die diesem Dienstprinzipal zugewiesenen tokenLifetimePolicies. |
JSON-Darstellung
Die folgende JSON-Darstellung veranschaulicht den Ressourcentyp.
{
"accountEnabled": true,
"addIns": [{"@odata.type": "microsoft.graph.addIn"}],
"alternativeNames": ["String"] ,
"appDisplayName": "String",
"appId": "String",
"appOwnerOrganizationId": "Guid",
"appRoleAssignmentRequired": true,
"appRoles": [{"@odata.type": "microsoft.graph.appRole"}],
"customSecurityAttributes": {
"@odata.type": "microsoft.graph.customSecurityAttributeValue"
},
"disabledByMicrosoftStatus": "String",
"displayName": "String",
"homepage": "String",
"id": "String (identifier)",
"info": {"@odata.type": "microsoft.graph.informationalUrl"},
"keyCredentials": [{"@odata.type": "microsoft.graph.keyCredential"}],
"logoutUrl": "String",
"notes": "String",
"oauth2PermissionScopes": [{"@odata.type": "microsoft.graph.permissionScope"}],
"passwordCredentials": [{"@odata.type": "microsoft.graph.passwordCredential"}],
"preferredTokenSigningKeyThumbprint": "String",
"replyUrls": ["String"],
"resourceSpecificApplicationPermissions": [{"@odata.type": "microsoft.graph.resourceSpecificPermission"}],
"servicePrincipalNames": ["String"],
"servicePrincipalType": "String",
"tags": ["String"],
"tokenEncryptionKeyId": "String",
"verifiedPublisher": {"@odata.type": "microsoft.graph.verifiedPublisher"}
}