Enumerar externalUserProfiles
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.
Recuperar las propiedades de todos los externalUserProfiles
Esta API está disponible en las siguientes implementaciones nacionales de nube.
Servicio global | Gobierno de EE. UU. L4 | Us Government L5 (DOD) | China operada por 21Vianet |
---|---|---|---|
✅ | ❌ | ❌ | ❌ |
Permissions
Elija el permiso o los permisos marcados como con privilegios mínimos para esta API. Use un permiso o permisos con privilegios superiores 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) | ExternalUserProfile.Read.All | ExternalUserProfile.ReadWrite.All |
Delegado (cuenta personal de Microsoft) | No admitida. | No admitida. |
Aplicación | ExternalUserProfile.Read.All | ExternalUserProfile.ReadWrite.All |
Importante
En escenarios delegados con cuentas profesionales o educativas, al usuario que ha iniciado sesión se le debe asignar un rol de Microsoft Entra compatible o un rol personalizado con un permiso de rol admitido. Se admiten los siguientes roles con privilegios mínimos para esta operación:
- Lector global
- Administrador de usuarios de directorio extendido
- Administrador de servicios de Teams
Solicitud HTTP
GET /directory/externalUserProfiles/{id}
Parámetros de consulta opcionales
Puede usar $filter
para devolver solo perfiles de usuario externos específicos. Las siguientes propiedades se pueden usar para $filter
:
- CompanyName
- supervisorId
Para más información, vea Parámetros de consulta OData.
Encabezados de solicitud
Nombre | Descripción |
---|---|
Authorization | {token} de portador. Obligatorio. Obtenga más información sobre la autenticación y la autorización. |
Cuerpo de la solicitud
No proporcione un cuerpo de solicitud para este método.
Respuesta
Si se ejecuta correctamente, este método devuelve un 200 OK
código de respuesta y una representación JSON del externalUserProfile en el cuerpo de la respuesta.
Ejemplos
Ejemplo 1: Obtener todos los perfiles de usuario externos
Solicitud
En el ejemplo siguiente se muestra la solicitud.
GET https://graph.microsoft.com/beta/directory/externalUserProfiles
Respuesta
En el ejemplo siguiente se muestra la respuesta.
HTTP/1.1 200 OK
Content-type: application/json
{
"value": [
{
"id":"1e4ba82a-5f0c-423c-83e1-fc8ad69d8f02",
"isEnabled":true,
"createdDateTime":"2020-11-12T17:53:48Z",
"deletedDateTime":null,
"department":null,
"displayName":"Bob Henry",
"isDiscoverable":true,
"jobTitle":null,
"phoneNumber":"4257034568",
"address":{
"city":"Redmond",
"countryOrRegion":"USA",
"officeLocation":"B28",
"postalCode":"98052",
"state":"WA",
"street":"One Microsoft Way"
},
"createdBy":"67670e18-bf37-416c-b5c8-3bfdaad757cc",
"supervisorId":null,
"companyName":null
},
{
"id":"fffba82a-fffc-ff3c-83e1-fc8ff9dfff",
"isEnabled":true,
"createdDateTime":"2020-11-12T17:53:48Z",
"deletedDateTime":null,
"department":null,
"displayName":"Jack Hill",
"isDiscoverable":false,
"jobTitle":null,
"phoneNumber":"4257034788",
"address":{
"city":"Redmond",
"countryOrRegion":"USA",
"officeLocation":"B28",
"postalCode":"98052",
"state":"WA",
"street":"One Microsoft Way"
},
"createdBy":"67670e18-bf37-416c-b5c8-3bfdaad757cc",
"supervisorId":null,
"companyName":null
}
]
}
Ejemplo 2: Enumerar todos los perfiles de usuario externos que se pueden detectar
Solicitud
En el ejemplo siguiente se muestra la solicitud.
GET https://graph.microsoft.com/beta/directory/externalUserProfiles$filter=isDiscoverable eq true
Respuesta
En el ejemplo siguiente se muestra la respuesta.
HTTP/1.1 200 OK
Content-type: application/json
{
"value": [
{
"id":"1e4ba82a-5f0c-423c-83e1-fc8ad69d8f02",
"isEnabled":true,
"createdDateTime":"2020-11-12T17:53:48Z",
"deletedDateTime":null,
"department":null,
"displayName":"Bob Henry",
"isDiscoverable":true,
"jobTitle":null,
"phoneNumber":"4257034568",
"address":{
"city":"Redmond",
"countryOrRegion":"USA",
"officeLocation":"B28",
"postalCode":"98052",
"state":"WA",
"street":"One Microsoft Way"
},
"createdBy":"67670e18-bf37-416c-b5c8-3bfdaad757cc",
"supervisorId":null,
"companyName":null
}
]
}