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 servicePrincipals | servicePrincipal-Auflistung | Abrufen einer Liste von servicePrincipal-Objekten. |
| Create servicePrincipal | servicePrincipal | Erstellt ein neues servicePrincipal-Objekt. |
| Get servicePrincipal | servicePrincipal | Dient zum Lesen der Eigenschaften und Beziehungen des servicePrincipal-Objekts. |
| Update servicePrincipal | servicePrincipal | Aktualisieren des servicePrincipal-Objekts. |
| Delete servicePrincipal | Keine | Löschen des servicePrincipal-Objekts. |
| Gelöschten servicePrincipal auflisten | directoryObject-Sammlung | Abrufen einer Liste von servicePrincipal-Objekten. |
| Gelöschten servicePrincipal abrufen | directoryObject | Dient zum Abrufen der Eigenschaften eines kürzlich gelöschten servicePrincipal-Objekts. |
| servicePrincipal permanent löschen | Keine | Löschen Sie ein servicePrincipal-Objekt endgültig. |
| Gelöschten servicePrincipal wiederherstellen | directoryObject | Stellen Sie ein kürzlich gelöschtes servicePrincipal-Objekt wieder her. |
| createdObjects auflisten | directoryObject-Sammlung | Abrufen einer createdObject-Objektauflistung. |
| List ownedObjects | directoryObject collection | Holen Sie sich eine ownObject-Objektsammlung. |
| Get delta | servicePrincipal-Auflistung | Ruft inkrementelle Änderungen für Dienstprinzipale ab. |
| App-Rollenzuweisungen | ||
| List appRoleAssignments | appRoleAssignment-Auflistung | Abrufen der App-Rollen, denen dieser Dienstprinzipal zugewiesen wurde. |
| 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. |
| Add tokenSigningCertificate | selfSignedCertificate | Fügen Sie dem Dienstprinzipal ein selbstsigniertes Zertifikat hinzu. Wird hauptsächlich zum Konfigurieren SAML-basierter SSO-Anwendungen aus dem Azure AD-Katalog verwendet. |
| 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. |
| Delegierte Berechtigungsklassifizierungen | ||
| Liste der delegierten Berechtigungsklassifizierungen | delegatedPermissionClassification-Sammlung | Rufen Sie die Berechtigungsklassifizierungen für delegierte Berechtigungen ab, die von diesem Dienstprinzipal verfügbar gemacht werden. |
| Hinzufügen delegierter Berechtigungsklassifizierungen | delegatedPermissionClassification | Fügen Sie eine Berechtigungsklassifizierung für eine delegierte Berechtigung hinzu, die von diesem Dienstprinzipal verfügbar gemacht wird. |
| Entfernen delegierter Berechtigungsklassifizierungen | Keine | Entfernen Sie eine Berechtigungsklassifizierung für delegierte Berechtigungen, die von diesem Dienstprinzipal verfügbar gemacht wird. |
| Gewähren delegierter Genehmigungen | ||
| List oauth2PermissionGrants | 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. |
| List transitive memberOf | 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. |
| checkMemberGroups | String-Sammlung | Sucht nach einer Mitgliedschaft in einer angegebenen Liste von Gruppen. |
| checkMemberObjects | String-Sammlung | Überprüfen Sie die Mitgliedschaft in einer bestimmten Liste von Gruppen, Verzeichnis-Rollen oder Verwaltungsobjekten. |
| getMemberGroups | String-Sammlung | Abruf einer Liste der Gruppen, denen dieser Dienstprinzipal angehört. |
| getMemberObjects | String collection | Dient zum Abrufen der Liste der Gruppen, administrativen Einheiten und Verzeichnisrollen, in denen dieser Dienstprinzipal Mitglied ist. |
| Besitzer | ||
| Besitzer auflisten | directoryObject-Sammlung | Dient zum Abrufen einer Besitzerobjektsammlung. |
| Besitzer hinzufügen | directoryObject | Dient zum Erstellen eines neuen Besitzers durch Veröffentlichen in der Benutzersammlung. |
| Besitzer entfernen | Keine | Entfernen eines Besitzers aus einem Dienstprinzipal. |
| Richtlinien | ||
| Assign claimsMappingPolicy | claimsMappingPolicy-Sammlung | Weist diesem Objekt eine claimsMappingPolicy zu. |
| List claimsMappingPolicies | claimsMappingPolicy-Sammlung | Ruft alle claimsMappingPolicies ab, die diesem Objekt zugeordnet sind. |
| Remove claimsMappingPolicy | claimsMappingPolicy-Sammlung | Entfernt eine claimsMappingPolicy aus diesem Objekt. |
| Assign homeRealmDiscoveryPolicy | homeRealmDiscoveryPolicy-Sammlung | Weist diesem Objekt eine homeRealmDiscoveryPolicy zu. |
| List homeRealmDiscoveryPolicies | homeRealmDiscoveryPolicy-Sammlung | Ruft alle homeRealmDiscoveryPolicies ab, die diesem Objekt zugeordnet sind. |
| Remove homeRealmDiscoveryPolicy | homeRealmDiscoveryPolicy-Sammlung | Entfernt eine homeRealmDiscoveryPolicy von diesem Objekt. |
| Zuweisen der tokenIssuancePolicy | tokenIssuancePolicy-Sammlung | Diesem Objekt eine tokenIssuancePolicy zuweisen. |
| tokenIssuancePolicies auflisten | tokenIssuancePolicy-Sammlung | Anrufen aller tokenIssuancePolicies, die diesem Objekt zugeordnet sind. |
| Entfernen der tokenIssuancePolicy | tokenIssuancePolicy-Sammlung | Entfernen einer tokenLifetimePolicy von diesem Objekt. |
| Assign tokenLifetimePolicy | tokenLifetimePolicy-Sammlung | Weist diesem Objekt eine tokenLifetimePolicy zu. |
| List tokenLifetimePolicies | tokenLifetimePolicy-Sammlung | Ruft alle tokenLifetimePolicies ab, die diesem Objekt zugeordnet sind. |
| Remove tokenLifetimePolicy | tokenLifetimePolicy-Sammlung | Entfernt einer tokenLifetimePolicy von diesem Objekt. |
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 Azure AD-Verzeichnisobjekte.
| Eigenschaft | Typ | Beschreibung |
|---|---|---|
| accountEnabled | Boolescher Wert | true, wenn das Dienstprinzipalkonto aktiviert ist; andernfalls false. 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, 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. 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 | String | Der eindeutige Bezeichner für die zugeordnete Anwendung (ihre appId-Eigenschaft). Unterstützt $filter (eq, ne, not, in, startsWith). |
| applicationTemplateId | Zeichenfolge | Eindeutiger Bezeichner des applicationTemplate, aus dem der servicePrincipal erstellt wurde. Schreibgeschützt. Unterstützt $filter (eq, ne, NOT, startsWith). |
| appOwnerOrganizationId | Guid | Enthält die Mandanten-ID, bei dem 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 | Boolescher Wert | 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 dieser Dienstprinzipal darstellt. Weitere Informationen finden Sie in der appRoles-Eigenschaftsdefinition in der application-Entität. Lässt keine Nullwerte zu. |
| deletedDateTime | DateTimeOffset | Datum und Uhrzeit, wann der Dienstprinzipal gelöscht wurde. Schreibgeschützt. |
| description | String | Freies Textfeld zur Eingabe einer internen Beschreibung für Endbenutzer des Dienstprinzipals. In Endbenutzerportalen wie MyApps wird in diesem Feld die Anwendungsbeschreibung angezeigt. Die maximal zulässige Länge 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 können verdächtige, missbräuchliche oder schädliche Aktivitäten oder ein Verstoß gegen die Microsoft-Servicevertrag sein). 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. Schlüssel. 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 Nutzungsbedingungen und Datenschutzerklärung für registrierte Azure Active Directory-Apps. Unterstützt $filter (eq, ne, not, ge, le und eq für null-Werte). |
| keyCredentials | keyCredential-Auflistung | Die Sammlung der wichtigsten Anmeldeinformationen, die mit dem Dienstprinzipal verknüpft sind. Lässt keine Nullwerte zu. Unterstützt $filter (eq, not, ge, le). |
| 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 | String | Gibt die URL an, die vom Autorisierungsdienst von Microsoft verwendet wird, um einen Benutzer mithilfe von OpenId Connect-front-channel-, -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 Länge beträgt 1024 Zeichen. |
| 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. |
| oauth2PermissionScopes | permissionScope-Sammlung | Die von der Anwendung zur Verfügung gestellten delegierten Berechtigungen. Weitere Informationen finden Sie in der oauth2PermissionScopes-Eigenschaft in der api-Eigenschaft der application-Entität. Lässt keine NULL-Werte zu. |
| passwordCredentials | passwordCredential-Auflistung | Die Sammlung der Kennwortanmeldeinformationen, die mit der Anwendung verknüpft sind. 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. Unterstützte Werte sind: password, saml, notSupported und oidc. |
| 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. Mithilfe dieser Werte können Sie die Berechtigungen identifizieren, die von dieser App in Azure AD 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 intern von Azure AD 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. Unterstützt $filter (eq, not, ge, le, startsWith). |
| 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. |
| verifiedPublisher | verifiedPublisher | Gibt den verifizierten Herausgeber der Anwendung an, die dieser Dienstprinzipal darstellt. |
Beziehungen
| Beziehung | Typ | Beschreibung |
|---|---|---|
| appRoleAssignedTo | appRoleAssignment | App-Rollenzuweisungen für diese App oder diesen Dienst, die Benutzern, Gruppen und anderen Dienstprinzipalen 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 collection | Verzeichnisobjekte, die von diesem Dienstprinzipal erstellt werden. Schreibgeschützt. Nullwerte zulassend. |
| homeRealmDiscoveryPolicies | homeRealmDiscoveryPolicy-Sammlung | Die diesem Dienstprinzipal zugewiesenen homeRealmDiscoveryPolicies. Unterstützt $expand. |
| memberOf | directoryObject-Sammlung | Rollen, bei denen dieser Dienstprinzipal Mitglied ist. HTTP-Methoden: GET. Schreibgeschützt. Nullwerte zulassend. Unterstützt $expand. |
| oauth2PermissionGrants | oAuth2PermissionGrant-Auflistung | Delegierte Gewährung von Berechtigungen, die diesen Dienstprinzipal für den Zugriff auf eine API im Auftrag eines angemeldeten Benutzers autorisieren. Schreibgeschützt. Nullwerte zulassend. |
| ownedObjects | directoryObject collection | Verzeichnisobjekte, die im Besitz dieses Dienstprinzipals sind. Schreibgeschützt. Nullwerte zulassend. Unterstützt $expand. |
| owners | directoryObject-Sammlung | Verzeichnisobjekte, die Besitzer dieses Dienstprinzipals sind. Bei den Besitzern handelt es sich um eine Reihe von Benutzern oder Dienstprinzipalen, die keine Administratoren sind und die berechtigt sind, dieses Objekt zu ändern. Schreibgeschützt. Nullwerte zulassend. Unterstützt $expand. |
| tokenIssuancePolicies | tokenIssuancePolicy-Sammlung | Die diesem Dienstprinzipal zugewiesenen tokenIssuancePolicies. |
| tokenLifetimePolicies | tokenLifetimePolicy-Sammlung | Die diesem Dienstprinzipal zugewiesenen tokenLifetimePolicies. |
JSON-Darstellung
Es folgt eine JSON-Darstellung der Ressource.
{
"accountEnabled": true,
"addIns": [{"@odata.type": "microsoft.graph.addIn"}],
"alternativeNames": ["String"] ,
"appDisplayName": "String",
"appId": "String",
"appOwnerOrganizationId": "Guid",
"appRoleAssignmentRequired": true,
"appRoles": [{"@odata.type": "microsoft.graph.appRole"}],
"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"}],
"replyUrls": ["String"],
"resourceSpecificApplicationPermissions": [{"@odata.type": "microsoft.graph.resourceSpecificPermission"}],
"servicePrincipalNames": ["String"],
"servicePrincipalType": "String",
"tags": ["String"],
"tokenEncryptionKeyId": "String",
"verifiedPublisher": {"@odata.type": "microsoft.graph.verifiedPublisher"}
}
Feedback
Feedback senden und anzeigen für