Agregar atributo (al flujo de usuario)

Espacio de nombres: microsoft.graph

Importante

Las API de la versión /beta de Microsoft Graph están sujetas a cambios. No se admite el uso de estas API en aplicaciones de producción. Para determinar si una API está disponible en la versión 1.0, use el selector de Versión.

Agregar un atributo a un flujo de usuario de registro de autoservicio de identidades externas representado por un objeto externalUsersSelfServiceSignupEventsFlow . Puede agregar atributos personalizados e integrados a un flujo de usuario.

El atributo se añade tanto a losatributosattributeCollection> como a lasvisualizacionesattributeCollection>attributeCollectionPage> en el flujo de usuario. En la colección de vistas , se asigna la configuración predeterminada al atributo. Puede aplicar REVISIONES al flujo de usuario para personalizar la configuración del atributo en el objeto views , por ejemplo, marcándolo como obligatorio o actualizando los tipos de entrada permitidos.

Esta API está disponible en las siguientes implementaciones en la nube nacional.

Servicio global Administración pública de EE. UU. Gobierno de EE. UU. L5 (DOD) China operado por 21Vianet
✅ ❌ ❌ ✅

Permissions

Elija el permiso o los permisos marcados como con privilegios mínimos para esta API. Use uno o varios permisos con privilegios más altos solo si la aplicación lo requiere. Para obtener más información sobre los permisos delegados y de aplicación, consulte Tipos de permisos. Para obtener más información sobre estos permisos, consulte la referencia de permisos.

Tipo de permiso Permisos con privilegios mínimos Permisos con privilegios más altos
Delegado (cuenta profesional o educativa) EventListener.ReadWrite.All No disponible.
Delegado (cuenta personal de Microsoft) No admitida. No admitida.
Aplicación EventListener.ReadWrite.All No disponible.

Importante

Para el acceso delegado con cuentas profesionales o educativas, el usuario que ha iniciado sesión debe ser propietario o miembro del grupo o tener asignado un rol compatible de Microsoft Entra o un rol personalizado que conceda los permisos necesarios para esta operación. Id. externa Administrador de flujo de usuario es el rol con privilegios mínimos admitido para esta operación.

Solicitud HTTP

POST /identity/authenticationEventsFlows/{authenticationEventsFlow-id}/microsoft.graph.externalUsersSelfServiceSignUpEventsFlow/onAttributeCollection/microsoft.graph.onAttributeCollectionExternalUsersSelfServiceSignUp/attributes/$ref

Encabezados de solicitud

Nombre Descripción
Authorization {token} de portador. Obligatorio. Obtenga más información sobre autenticación y autorización.
Content-Type application/json. Obligatorio.

Cuerpo de la solicitud

En el cuerpo de la solicitud, proporcione una propiedad odata.id con el ID del objeto identityUserFlowAttribute para agregarlo al flujo de usuario.

Respuesta

Si se ejecuta correctamente, este método devuelve un código de respuesta 204 No Content. Si falla, se devolverá un error 4xx con detalles específicos.

Ejemplos

Solicitud

En el ejemplo siguiente se muestra una solicitud que agrega city como atributo para el paso de recopilación de atributos de un flujo de usuario de registro de autoservicio de identidades externas. Si la solicitud se realiza correctamente, el atributo se agrega tanto a losatributosattributeCollection> como a las colecciones attributeCollection>attributeCollectionPage>en el flujo de usuario. Después de agregar el atributo al flujo de usuario, puede PARCHEAR el flujo de usuario para personalizar la configuración del atributo en el objeto views , es decir, personalizar el diseño de página.

POST https://graph.microsoft.com/beta/identity/authenticationEventsFlows/0313cc37-d421-421d-857b-87804d61e33e/microsoft.graph.externalUsersSelfServiceSignUpEventsFlow/onAttributeCollection/microsoft.graph.onAttributeCollectionExternalUsersSelfServiceSignUp/attributes/$ref

{
    "@odata.id":"https://graph.microsoft.com/beta/identity/userFlowAttributes/city"
} 

Respuesta

En el ejemplo siguiente se muestra la respuesta.

HTTP/1.1 204 No Content