Partilhar via


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 .

Esta API está disponível nas seguintes implementações de cloud nacionais.

Serviço global US Government L4 US Government L5 (DOD) China operada pela 21Vianet

Permissões

Escolha a permissão ou permissões marcadas como menos privilegiadas para esta API. Utilize uma permissão ou permissões com privilégios mais elevados apenas se a sua aplicação o exigir. Para obter detalhes sobre as permissões delegadas e de aplicação, veja Tipos de permissão. Para saber mais sobre estas permissões, veja a referência de permissões.

Tipo de permissão Permissões com menos privilégios Permissões com privilégios superiores
Delegado (conta corporativa ou de estudante) IdentityUserFlow.ReadWrite.All Indisponível.
Delegado (conta pessoal da Microsoft) Sem suporte. Sem suporte.
Application IdentityUserFlow.ReadWrite.All Indisponível.

Importante

Em cenários delegados com contas escolares ou profissionais, o utilizador com sessão iniciada tem de ter uma função de Microsoft Entra suportada ou uma função personalizada com uma permissão de função suportada. ID externa Administrador de Fluxo de Utilizador é a função com menos privilégios suportada para esta operaçã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 do pedido, 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á anexado após B2C_1_ a criação se o prefixo não tiver sido adicionado ao nome durante o pedido.
userFlowType Cadeia de caracteres Obrigatório. O tipo de fluxo de utilizador que está a criar. 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á ativada no fluxo de utilizador Azure AD B2C. A personalização de idioma não está ativada por predefinição para Azure AD fluxos de utilizador B2C.
defaultLanguageTag Cadeia de caracteres Opcional. Especifica o idioma predefinido do b2cIdentityUserFlow que é utilizado quando não é especificada nenhuma ui_locale etiqueta no pedido. Esse campo é RFC 5646 compatível.
identityProviders Coleção identityProvider Opcional. Os fornecedores de identidade que pretende incluir no fluxo de utilizador.

Resposta

Se for bem-sucedido, este método devolve um 201 Created código de resposta e um cabeçalho de Localização com um URI para o objeto b2cIdentityUserFlow criado para este pedido, com o B2C_1_ prefixo adicionado ao nome. Se não for bem-sucedido, é devolvido um 4xx erro com detalhes específicos.

Exemplos

Exemplo 1: Criar um fluxo de utilizador com os valores predefinidos

Solicitação

Eis um exemplo do pedido.

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 utilizador com os valores predefinidos e um fornecedor de identidade

Solicitação

Eis um exemplo do pedido.

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 utilizador com os valores predefinidos e a configuração para conectores de API

Solicitação

Eis um exemplo do pedido.

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 devolve sempre um valor "{}". Para ver o valor total com as propriedades de navegação, utilize 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": {}
}