tipo de recurso b2xIdentityUserFlow

  • Artigo

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.

Representa um fluxo de usuário de inscrição por autoatendimento em um locatário Microsoft Entra.

Os fluxos de usuário são usados para habilitar uma experiência de inscrição de autoatendimento para usuários convidados em um aplicativo. Os fluxos de usuário definem a experiência que o usuário final vê ao se inscrever, inclusive quais provedores de identidade ele pode usar para autenticação, juntamente com quais atributos são coletados como parte do processo de inscrição.

Métodos

Método Tipo de retorno Descrição
Listar fluxos de usuário Coleção b2xIdentityUserFlow Recupere todos os fluxos de usuário B2X.
Obter fluxo de usuário b2xIdentityUserFlow Recupere as propriedades de um fluxo de usuário B2X.
Criar fluxo de usuário b2xIdentityUserFlow Crie um novo fluxo de usuário B2X.
Excluir fluxo de usuário Nenhum Exclua um fluxo de usuário B2X.
Listar os provedores de identidade Coleção identityProvider Recupere todos os provedores de identidade em um fluxo de usuário B2X.
Adicionar provedor de identidade Nenhum Adicione um provedor de identidade a um fluxo de usuário B2X.
Remover provedor de identidade Nenhum Remova um provedor de identidade de um fluxo de usuário B2X.
Listar os provedores de identidade (preterido) Coleção identityProvider Recupere todos os provedores de identidade em um fluxo de usuário B2X.
Adicionar provedor de identidade (preterido) Nenhum Adicione um provedor de identidade a um fluxo de usuário B2X.
Remover provedor de identidade (preterido) Nenhum Remova um provedor de identidade de um fluxo de usuário B2X.
Listar as atribuições de atributo de usuário ColeçãoidentityUserFlowAttributeAssignment Recupere todas as atribuições de atributos do usuário em um fluxo de usuário B2X.
Criar uma tarefa de atributo de usuário identityUserFlowAttributeAssignment Crie uma atribuição de atributo de usuário em um fluxo de usuário B2X.
Idiomas da lista coleção userFlowLanguageConfiguration Recupere todos os idiomas dentro de um fluxo de usuário B2X.
Obtenha a configuração dos conectores de API para o fluxo do usuário userFlowApiConnectorConfiguration Obtenha a configuração dos conectores de API usados no fluxo do usuário. Não há suporte para o parâmetro de consulta $expand para esse método.
Configurar um conector de API em um fluxo de usuários Nenhum Configure um conector de API para etapas específicas em um fluxo de usuário, atualizando a propriedade apiConnectorConfiguration.

Propriedades

Propriedade Tipo Descrição
id Cadeia de caracteres O nome do fluxo de usuário. Esse é um valor obrigatório e imutável após sua criação. O nome será antecedido pelo valor de B2X_1_ após a criação.
userFlowType userFlowType O tipo de fluxo de usuário. Para fluxos de usuário de inscrição de autoatendimento, o valor só pode ser signUpOrSignIn e não pode ser modificado após a criação.
userFlowTypeVersion Único A versão do fluxo de usuário. Para fluxos de usuário de inscrição de autoatendimento, a versão é sempre 1.
apiConnectorConfiguration userFlowApiConnectorConfiguration Configuração para habilitar um conector de API para uso como parte do fluxo de usuário de inscrição de autoatendimento. Você somente pode obter o valor deste objeto usando Obter a userFlowApiConnectorConfiguration .

Relações

Relação Tipo Descrição
userflowIdentityProviders Coleção identityProviderBase Os provedores de identidade incluídos no fluxo de usuários.
IdentityProviders (preterido) Coleção identityProvider Os provedores de identidade incluídos no fluxo de usuário.
userAttributeAssignments ColeçãoidentityUserFlowAttributeAssignment As atribuições de atributo de usuário incluídas no fluxo do usuário.
idiomas coleção userFlowLanguageConfiguration Os idiomas com suporte para personalização dentro do fluxo do usuário. A personalização do idioma é habilitada por padrão no fluxo do usuário de inscrição de autoatendimento. Você não pode criar idiomas personalizados em fluxos de usuário de inscrição de autoatendimento.

Representação JSON

A representação JSON a seguir mostra o tipo de recurso.

{
    "id": "String (identifier)",
    "userFlowType": "String",
    "userFlowTypeVersion": "Single",
    "userflowIdentityProviders": [{"@odata.type": "microsoft.graph.identityProviderBase"}],
    "identityProviders": [{"@odata.type": "microsoft.graph.identityProvider"}],
    "userAttributeAssignments": [{"@odate.type": "microsoft.graph.identityUserFlowAttributeAssignment"}],
    "languages": [{"@odata.type": "microsoft.graph.userFlowLanguageConfiguration"}],
    "apiConnectorConfiguration": {
      "@odata.type": "microsoft.graph.userFlowApiConnectorConfiguration"
    }
}