Share via


Criar b2xIdentityUserFlow

Namespace: microsoft.graph

Crie um novo objeto b2xIdentityUserFlow .

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.
Application 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/b2xUserFlows

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 b2xIdentityUserFlow.

Propriedade Tipo Descrição
id Cadeia de caracteres Obrigatório. O nome do fluxo de usuário. O nome será pré-criado após B2X_1 a criação.
userFlowType Cadeia de caracteres Obrigatório. O tipo de fluxo de usuário que você está criando. Esse valor sempre será signUpOrSignIn.
userFlowTypeVersion Flutuação Obrigatório. A versão do fluxo de usuário. Esse valor sempre será 1.
apiConnectorConfiguration userFlowApiConnectorConfiguration Opcional. Configuração para habilitar um conector de API para uso como parte do fluxo do 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 b2xIdentityUserFlow criado para essa solicitação, com o B2X_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

O exemplo a seguir mostra uma solicitação.

POST https://graph.microsoft.com/v1.0/identity/b2xUserFlows
Content-type: application/json

{
    "id": "Partner",
    "userFlowType": "signUpOrSignIn",
    "userFlowTypeVersion": 1
}

Resposta

O exemplo a seguir mostra a resposta.

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

HTTP/1.1 201 Created
Location: https://graph.microsoft.com/v1.0/identity/b2xUserFlows/B2X_1_Partner
Content-type: application/json

{
    "id": "B2X_1_Partner",
    "userFlowType": "signUpOrSignIn",
    "userFlowTypeVersion": 1
}

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

Solicitação

O exemplo a seguir mostra uma solicitação.

POST https://graph.microsoft.com/v1.0/identity/b2xUserFlows
Content-type: application/json

{
    "id": "Partner",
    "userFlowType": "signUpOrSignIn",
    "userFlowTypeVersion": 1,
    "identityProviders": [
        {
            "id": "Facebook-OAuth",
            "type": "Facebook",
            "name": "Facebook"
        }
    ]
}

Resposta

O exemplo a seguir mostra a resposta.

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

HTTP/1.1 201 Created
Location: https://graph.microsoft.com/v1.0/identity/b2xUserFlows/B2X_1_Partner
Content-type: application/json

{
    "id": "B2X_1_Partner",
    "userFlowType": "signUpOrSignIn",
    "userFlowTypeVersion": 1
}

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

Solicitação

O exemplo a seguir mostra uma solicitação.

POST https://graph.microsoft.com/v1.0/identity/b2xUserFlows
Content-type: application/json

{
    "id": "UserFlowWithAPIConnector",
    "userFlowType": "signUpOrSignIn",
    "userFlowTypeVersion": 1,
    "apiConnectorConfiguration":{
        "postFederationSignup":{
            "@odata.id": "https://graph.microsoft.com/v1/identity/apiConnectors/{id}"
        },
        "postAttributeCollection":{
            "@odata.id": "https://graph.microsoft.com/v1/identity/apiConnectors/{id}"
        }
    }
}

Resposta

O exemplo a seguir mostra a 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/v1.0/identity/b2xUserFlows/B2X_1_Partner
Content-type: application/json

{
    "@odata.context": "https://graph.microsoft.com/v1.0/$metadata#identity/b2xUserFlows/$entity",
    "id": "B2X_1_UserFlowWithAPIConnector",
    "userFlowType": "signUpOrSignIn",
    "userFlowTypeVersion": 1,
    "apiConnectorConfiguration": {}
}