Criar b2cIdentityUserFlow

Namespace: microsoft.graph

Importante

As APIs na versão /beta no Microsoft Graph estão sujeitas a alterações. Não há suporte para o uso dessas APIs em aplicativos de produção. Para determinar se uma API está disponível na v1.0, use o seletor Versão.

Crie um novo objeto b2cIdentityUserFlow .

Essa API está disponível nas seguintes implantações nacionais de nuvem.

Serviço global Governo dos EUA L4 GOVERNO DOS EUA L5 (DOD) China operada pela 21Vianet

Permissões

Escolha a permissão ou as permissões marcadas como menos privilegiadas para essa API. Use uma permissão ou permissões privilegiadas mais altas somente se o aplicativo exigir. Para obter detalhes sobre permissões delegadas e de aplicativo, consulte Tipos de permissão. Para saber mais sobre essas permissões, consulte a referência de permissões.

Tipo de permissão Permissões menos privilegiadas Permissões privilegiadas mais altas
Delegado (conta corporativa ou de estudante) IdentityUserFlow.ReadWrite.All Indisponível.
Delegado (conta pessoal da Microsoft) Sem suporte. Sem suporte.
Aplicativo IdentityUserFlow.ReadWrite.All Indisponível.

A conta corporativa ou de estudante precisa pertencer ao menos à função Administrador de Fluxo de Usuário de ID ExternaMicrosoft Entra função.

Solicitação HTTP

POST /identity/b2cUserFlows

Cabeçalhos de solicitação

Nome Descrição
Autorização {token} de portador. Obrigatório. Saiba mais sobre autenticação e autorização.
Content-Type application/json. Obrigatório.

Corpo da solicitação

No corpo da solicitação, forneça uma representação JSON de um b2cIdentityUserFlow.

Propriedade Tipo Descrição
id Cadeia de caracteres Obrigatório. O nome do fluxo de usuário. O nome será pré-criado após B2C_1_ a criação se o prefixo não tiver sido adicionado ao nome durante sua solicitação.
userFlowType Cadeia de caracteres Obrigatório. O tipo de fluxo de usuário que você está criando. Os valores com suporte para userFlowType são:
  • signUp
  • signIn
  • signUpOrSignIn
  • passwordReset
  • profileUpdate
  • resourceOwner
userFlowTypeVersion Flutuação Obrigatório. A versão do fluxo de usuário.
isLanguageCustomizationEnabled Booliano Opcional. Determina se a personalização do idioma está habilitada no fluxo de usuário B2C Azure AD. A personalização do idioma não está habilitada por padrão para Azure AD fluxos de usuário B2C.
defaultLanguageTag Cadeia de caracteres Opcional. Especifica o idioma padrão do b2cIdentityUserFlow que é usado quando nenhuma ui_locale marca é especificada na solicitação. Esse campo é RFC 5646 compatível.
identityProviders Coleção identityProvider Opcional. Os provedores de identidade que você deseja incluir no fluxo de usuário.

Resposta

Se for bem-sucedido, esse método retornará um 201 Created código de resposta e um cabeçalho Local com um URI para o objeto b2cIdentityUserFlow criado para essa solicitação, com o B2C_1_ prefixo adicionado ao nome. Se não tiver êxito, um 4xx erro será retornado com detalhes específicos.

Exemplos

Exemplo 1: criar um fluxo de usuário com os valores padrão

Solicitação

Aqui está um exemplo da solicitação.

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

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

Resposta

Veja um exemplo de resposta.

Observação: o objeto de resposta mostrado aqui pode ser encurtado para legibilidade.

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": {}
}

Exemplo 2: criar um fluxo de usuário com os valores padrão e um provedor de identidade

Solicitação

Aqui está um exemplo da solicitação.

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"
        }
    ]
}

Resposta

Veja um exemplo de resposta.

Observação: o objeto de resposta mostrado aqui pode ser encurtado para legibilidade.

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": {}
}

Exemplo 3: criar um fluxo de usuário com os valores e a configuração padrão para conectores de API

Solicitação

Aqui está um exemplo da solicitação.

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}"
        }
    }
}

Resposta

Veja um exemplo de resposta.

Observação: o objeto de resposta mostrado aqui pode ser encurtado para legibilidade.

Nota: A apiConnectorConfiguration propriedade sempre retorna um valor '{}'. Para ver o valor completo com as propriedades de navegação, use esta API.

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": {}
}