Attribut hinzufügen (zum Benutzerfluss)

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.

Fügen Sie einem Self-Service-Registrierungsbenutzerflow für externe Identitäten ein Attribut hinzu, das durch ein externalUsersSelfServiceSignupEventsFlow-Objekt dargestellt wird. Sie können einem Benutzerflow sowohl benutzerdefinierte als auch integrierte Attribute hinzufügen.

Das Attribut wird sowohl denAttributenattributeCollection> als auch attributeCollection>attributeCollectionPage> hinzugefügt, die Sammlungen im Benutzerflussanzeigen. In der Ansichtensammlung werden dem Attribut die Standardeinstellungen zugewiesen. Sie können den Benutzerflow PATCHEN , um die Einstellungen des Attributs für das Ansichtsobjekt anzupassen, z. B. indem Sie es als erforderlich markieren oder die zulässigen Eingabetypen aktualisieren.

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) EventListener.ReadWrite.All Nicht verfügbar.
Delegiert (persönliches Microsoft-Konto) Nicht unterstützt Nicht unterstützt
Application EventListener.ReadWrite.All Nicht verfügbar.

Wichtig

Für den delegierten Zugriff mit Geschäfts-, Schul- oder Unikonten muss der angemeldete Benutzer Besitzer oder Mitglied der Gruppe sein oder ihm muss eine unterstützte Microsoft Entra-Rolle oder eine benutzerdefinierte Rolle zugewiesen werden, die die für diesen Vorgang erforderlichen Berechtigungen erteilt. External ID User Flow Administrator ist die Rolle mit den geringsten Berechtigungen, die für diesen Vorgang unterstützt wird.

HTTP-Anforderung

POST /identity/authenticationEventsFlows/{authenticationEventsFlow-id}/microsoft.graph.externalUsersSelfServiceSignUpEventsFlow/onAttributeCollection/microsoft.graph.onAttributeCollectionExternalUsersSelfServiceSignUp/attributes/$ref

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 odata.id Eigenschaft mit der ID des identityUserFlowAttribute-Objekts an, das dem Benutzerflow hinzugefügt werden soll.

Antwort

Wenn die Methode erfolgreich verläuft, wird der Antwortcode 204 No Content zurückgegeben. Wenn die Methode nicht erfolgreich ist, wird ein 4xx-Fehler mit bestimmten Details zurückgegeben.

Beispiele

Anforderung

Das folgende Beispiel zeigt eine Anforderung, die city als Attribut für den Attributsammlungsschritt eines Benutzerflusses für die Self-Service-Registrierung für externe Identitäten hinzufügt. Wenn die Anforderung erfolgreich ist, wird das Attribut sowohl denattributeCollection-Attributen> als auch denattributeCollection-AttributeCollectionPage-Ansichten>> im Benutzerflow hinzugefügt. Nach dem Hinzufügen des Attributs zum Benutzerflow können Sie den Benutzerflow patchen , um die Einstellungen des Attributs für das Ansichtsobjekt anzupassen, dh das Seitenlayout anzupassen.

POST https://graph.microsoft.com/beta/identity/authenticationEventsFlows/0313cc37-d421-421d-857b-87804d61e33e/microsoft.graph.externalUsersSelfServiceSignUpEventsFlow/onAttributeCollection/microsoft.graph.onAttributeCollectionExternalUsersSelfServiceSignUp/attributes/$ref

{
    "@odata.id":"https://graph.microsoft.com/beta/identity/userFlowAttributes/city"
} 

Antwort

Das folgende Beispiel zeigt die Antwort.

HTTP/1.1 204 No Content