Compartilhar via


Criar b2xIdentityUserFlow

Namespace: microsoft.graph

Crie um novo objeto b2xIdentityUserFlow .

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.

A conta escolar ou profissional tem de pertencer, pelo menos, à função Administrador do Fluxo de Utilizador de ID Externomicrosoft Entra.

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 do pedido, 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á precedido após B2X_1 a criação.
userFlowType Cadeia de caracteres Obrigatório. O tipo de fluxo de utilizador que está a criar. Este valor será signUpOrSignInsempre .
userFlowTypeVersion Flutuação Obrigatório. A versão do fluxo de usuário. Este valor será sempre 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, este método devolve um 201 Created código de resposta e um cabeçalho de Localização com um URI para o objeto b2xIdentityUserFlow criado para este pedido, com o B2X_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

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 utilizador com os valores predefinidos e um fornecedor 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 utilizador com os valores predefinidos e a configuraçã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 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/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": {}
}