Partilhar via


tipo de recurso externalUsersSelfServiceSignUpEventsFlow

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 autoatendimento para identidades externas dentro de um ID externa do Microsoft Entra na força de trabalho ou locatários externos. Um fluxo de usuário é implementado como uma política de vários eventos executando os eventos específicos em pontos específicos de interação do usuário.

Herda da autenticaçãoEventsFlow.

Métodos

Nenhum.

Para obter a lista de operações de API para gerenciar esse tipo de recurso, consulte o tipo de recurso authenticationEventsFlow.

Propriedades

Propriedade Tipo Descrição
id Cadeia de caracteres O identificador exclusivo da entidade. Somente leitura. Herdado da entidade.
displayName Cadeia de caracteres Obrigatório. O nome de exibição da política de eventos. Deve ser exclusivo. Herdado da autenticaçãoEventsFlow.
description String Opcional. A descrição da política de eventos. Herdado da autenticaçãoEventsFlow.
conditions authenticationConditions Opcional. As condições que representam o contexto da solicitação de autenticação que é usada para decidir se a política de eventos é invocada. Herdado da autenticaçãoEventsFlow.
prioridade Int32 Opcional. A prioridade a ser usada para cada evento individual da política de eventos. Se vários ouvintes concorrentes de um evento tiverem a mesma prioridade, um será escolhido e um erro será registrado silenciosamente. O padrão é 500. Herdado da autenticaçãoEventsFlow.
onInteractiveAuthFlowStart onInteractiveAuthFlowStartHandler Obrigatório. A configuração para o que invocar quando um fluxo de autenticação estiver pronto para ser iniciado.
onAttributeCollection onAttributeCollectionHandler A configuração para o que invocar quando os atributos estiverem prontos para serem coletados do usuário.
onAttributeCollectionStart onAttributeCollectionStartHandler A configuração para o que invocar quando a coleção de atribuição tiver começado.
onAttributeCollectionSubmit onAttributeCollectionSubmitHandler A configuração para o que invocar quando os atributos foram enviados no final da coleção de atribuição.
onAuthenticationMethodLoadStart onAuthenticationMethodLoadStartHandler Obrigatório. A configuração para o que invocar quando os métodos de autenticação estiverem prontos para serem apresentados ao usuário. Deve ter pelo menos um provedor de identidade vinculado.
onUserCreateStart onUserCreateStartHandler A configuração para o que invocar durante a criação do usuário.

Relações

Nenhum

Representação JSON

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

{
  "@odata.type": "#microsoft.graph.externalUsersSelfServiceSignUpEventsFlow",
  "id": "String (identifier)",
  "displayName": "String",
  "description": "String",
  "conditions": {
    "@odata.type": "microsoft.graph.authenticationConditions"
  },
  "priority": "Integer",
  "onInteractiveAuthFlowStart": {
    "@odata.type": "microsoft.graph.onInteractiveAuthFlowStartHandler"
  },
  "onAuthenticationMethodLoadStart": {
    "@odata.type": "microsoft.graph.onAuthenticationMethodLoadStartHandler"
  },
  "onAttributeCollection": {
    "@odata.type": "microsoft.graph.onAttributeCollectionHandler"
  },
  "onAttributeCollectionStart": {
    "@odata.type": "microsoft.graph.onAttributeCollectionStartHandler"
  },
  "onAttributeCollectionSubmit": {
    "@odata.type": "microsoft.graph.onAttributeCollectionSubmitHandler"
  },
  "onUserCreateStart": {
    "@odata.type": "microsoft.graph.onUserCreateStartHandler"
  }
}