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 de versão.

Crie um novo objeto b2cIdentityUserFlow.

Permissões

Uma das seguintes permissões é obrigatória para chamar esta API. Para saber mais, incluindo como escolher permissões, confira Permissões.

Tipo de permissão Permissões (da com menos para a com mais privilégios)
Delegado (conta corporativa ou de estudante) IdentityUserFlow.ReadWrite.All
Delegado (conta pessoal da Microsoft) Sem suporte.
Aplicativo IdentityUserFlow.ReadWrite.All

A conta de trabalho ou de estudante precisa pertencer a uma das seguintes funções:

  • Administrador global
  • Administrador de identidade externa Flow usuário

Solicitação HTTP

POST /identity/b2cUserFlows

Cabeçalhos de solicitação

Nome Descrição
Autorização {token} de portador. Obrigatório.
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 String Obrigatório. O nome do fluxo de usuário. O nome será pré-canetado após a criação se o prefixo não tiver sido adicionado B2C_1_ ao nome durante a solicitação.
userFlowType String 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 de idioma está habilitada no fluxo de usuários do Azure AD B2C. A personalização de idioma não está habilitada por padrão para fluxos de usuários do Azure AD B2C.
defaultLanguageTag String Opcional. Especifica o idioma padrão do b2cIdentityUserFlow que é usado quando nenhuma marca é ui_locale 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ários.

Resposta

Se tiver êxito, este método retornará um código de resposta e um header Location com um URI para o 201 Created objeto b2cIdentityUserFlow criado para essa solicitação, com o prefixo adicionado ao B2C_1_ nome. Caso não consiga, 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

Este é um exemplo de solicitação.

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

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

Resposta

Este é 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

Este é um exemplo de 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

Este é 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 padrão e configuração para conectores de API

Solicitação

Este é um exemplo de 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

Este é um exemplo de resposta.

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

Observação: 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": {}
}