Freigeben über


Erstellen von b2cIdentityUserFlow

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.

Erstellen Sie ein neues b2cIdentityUserFlow-Objekt .

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

Wichtig

In delegierten Szenarien mit Geschäfts-, Schul- oder Unikonten muss dem angemeldeten Benutzer eine unterstützte Microsoft Entra Rolle oder eine benutzerdefinierte Rolle mit einer unterstützten Rollenberechtigung zugewiesen werden. External ID Benutzerflowadministrator ist die Rolle mit den geringsten Berechtigungen, die für diesen Vorgang unterstützt wird.

HTTP-Anforderung

POST /identity/b2cUserFlows

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 JSON-Darstellung eines b2cIdentityUserFlow an.

Eigenschaft Typ Beschreibung
id String Erforderlich. Der Name des Benutzerablaufs. Dem Namen wird nach der Erstellung vorangestellt B2C_1_ , wenn das Präfix während der Anforderung nicht dem Namen hinzugefügt wurde.
userFlowType Zeichenfolge Erforderlich. Der Typ des Benutzerflows, den Sie erstellen. Die unterstützten Werte für userFlowType lauten:
  • signUp
  • signIn
  • signUpOrSignIn
  • passwordReset
  • profileUpdate
  • resourceOwner
userFlowTypeVersion Gleitkommazahl Erforderlich. Die Version des Benutzerablaufs.
isLanguageCustomizationEnabled Boolesch Optional. Bestimmt, ob die Sprachanpassung innerhalb des Azure AD B2C-Benutzerflows aktiviert ist. Die Sprachanpassung ist für Azure AD B2C-Benutzerflows standardmäßig nicht aktiviert.
defaultLanguageTag String Optional. Gibt die Standardsprache von b2cIdentityUserFlow an, die verwendet wird, wenn in der Anforderung kein ui_locale Tag angegeben wird. Dieses Feld ist RFC 5646-kompatibel.
identityProviders identityProvider-Sammlung Optional. Die Identitätsanbieter, die Sie in den Benutzerflow einschließen möchten.

Antwort

Bei erfolgreicher Ausführung gibt die Methode einen 201 Created Antwortcode und einen Location-Header mit einem URI für das für diese Anforderung erstellte b2cIdentityUserFlow-Objekt zurück, wobei dem Namen das B2C_1_ Präfix hinzugefügt wurde. Wenn der Fehler nicht erfolgreich ist, wird ein 4xx Fehler mit bestimmten Details zurückgegeben.

Beispiele

Beispiel 1: Erstellen eines Benutzerflows mit den Standardwerten

Anforderung

Hier sehen Sie ein Beispiel für die Anforderung.

POST https://graph.microsoft.com/beta/identity/b2cUserFlows
Content-type: application/json

{
    "id": "Customer",
    "userFlowType": "signUpOrSignIn",
    "userFlowTypeVersion": 3
}

Antwort

Hier ist ein Beispiel für die Antwort.

Hinweis: Das hier gezeigte Antwortobjekt kann zur besseren Lesbarkeit gekürzt werden.

HTTP/1.1 201 Created
Location: https://graph.microsoft.com/beta/identity/b2cUserFlows('B2C_1_Customer')
Content-type: application/json

{
    "@odata.context": "https://graph.microsoft.com/beta/$metadata#identity/b2cUserFlows/$entity",
    "id": "B2C_1_Customer",
    "userFlowType": "signUpOrSignIn",
    "userFlowTypeVersion": 3,
    "isLanguageCustomizationEnabled": false,
    "defaultLanguageTag": "en",
    "authenticationMethods": "emailWithPassword",
    "tokenClaimsConfiguration": {
        "isIssuerEntityUserFlow": false
    },
    "apiConnectorConfiguration": {}
}

Beispiel 2: Erstellen eines Benutzerflows mit den Standardwerten und einem Identitätsanbieter

Anforderung

Hier sehen Sie ein Beispiel für die Anforderung.

POST https://graph.microsoft.com/beta/identity/b2cUserFlows
Location: https://graph.microsoft.com/beta/identity/b2cUserFlows('B2C_1_Customer')
Content-type: application/json

{
    "id": "Customer",
    "userFlowType": "signUpOrSignIn",
    "userFlowTypeVersion": 3,
    "identityProviders": [
        {
            "id": "Facebook-OAuth"
        }
    ]
}

Antwort

Hier ist ein Beispiel für 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/beta/$metadata#identity/b2cUserFlows/$entity",
    "id": "B2C_1_Customer",
    "userFlowType": "signUpOrSignIn",
    "userFlowTypeVersion": 3,
    "isLanguageCustomizationEnabled": false,
    "defaultLanguageTag": "en",
    "authenticationMethods": "0",
    "tokenClaimsConfiguration": {
        "isIssuerEntityUserFlow": false
    },
    "apiConnectorConfiguration": {}
}

Beispiel 3: Erstellen eines Benutzerflows mit den Standardwerten und der Konfiguration für API-Connectors

Anforderung

Hier sehen Sie ein Beispiel für die Anforderung.

POST https://graph.microsoft.com/beta/identity/b2cUserFlows
Content-type: application/json

{
    "id": "UserFlowWithAPIConnector",
    "userFlowType": "signUpOrSignIn",
    "userFlowTypeVersion": 1,
    "apiConnectorConfiguration":{
        "postFederationSignup":{
            "@odata.id": "{apiConnectorId}"
        },
        "postAttributeCollection":{
            "@odata.id": "{apiConnectorId}"
        }
    }
}

Antwort

Hier ist ein Beispiel für die Antwort.

Hinweis: Das hier gezeigte Antwortobjekt kann zur besseren Lesbarkeit gekürzt werden.

Anmerkung: Die apiConnectorConfiguration -Eigenschaft gibt immer einen "{}"-Wert zurück. Verwenden Sie diese API, um den vollständigen Wert mit den Navigationseigenschaften anzuzeigen.

HTTP/1.1 201 Created
Location: https://graph.microsoft.com/beta/identity/b2cUserFlows/B2C_1_Partner
Content-type: application/json

{
    "@odata.context": "https://graph.microsoft.com/beta/$metadata#identity/b2cUserFlows/$entity",
    "id": "B2C_1_UserFlowWithAPIConnector",
    "userFlowType": "signUpOrSignIn",
    "userFlowTypeVersion": 1,
    "apiConnectorConfiguration": {}
}