Listar externalUserProfiles
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.
Obter as propriedades de todos os externalUserProfiles
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) | ExternalUserProfile.Read.All | ExternalUserProfile.ReadWrite.All |
Delegado (conta pessoal da Microsoft) | Sem suporte. | Sem suporte. |
Application | ExternalUserProfile.Read.All | ExternalUserProfile.ReadWrite.All |
Importante
Em cenários delegados com contas escolares ou profissionais, o utilizador com sessão iniciada tem de ter uma função de Microsoft Entra suportada ou uma função personalizada com uma permissão de função suportada. As seguintes funções com menos privilégios são suportadas para esta operação:
- Leitor Global
- Administrador de Utilizadores do Diretório Alargado
- Administrador de Serviço do Teams
Solicitação HTTP
GET /directory/externalUserProfiles/{id}
Parâmetros de consulta opcionais
Só pode utilizar $filter
para devolver perfis de utilizador externos específicos. As seguintes propriedades podem ser utilizadas para $filter
:
- CompanyName
- supervisorId
Para obter mais informações, consulte Parâmetros de consulta OData.
Cabeçalhos de solicitação
Nome | Descrição |
---|---|
Autorização | {token} de portador. Obrigatório. Saiba mais sobre autenticação e autorização. |
Corpo da solicitação
Não forneça um corpo de solicitação para esse método.
Resposta
Se for bem-sucedido, este método devolve um 200 OK
código de resposta e uma representação JSON do externalUserProfile no corpo da resposta.
Exemplos
Exemplo 1: Obter todos os perfis de utilizador externos
Solicitação
O exemplo a seguir mostra uma solicitação.
GET https://graph.microsoft.com/beta/directory/externalUserProfiles
Resposta
O exemplo a seguir mostra a resposta.
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
}
]
}
Exemplo 2: listar todos os perfis de utilizador externos que são detetáveis
Solicitação
O exemplo a seguir mostra uma solicitação.
GET https://graph.microsoft.com/beta/directory/externalUserProfiles$filter=isDiscoverable eq true
Resposta
O exemplo a seguir mostra a resposta.
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
}
]
}