List externalUserProfiles
Namespace: microsoft.graph
Important
APIs under the /beta
version in Microsoft Graph are subject to change. Use of these APIs in production applications is not supported. To determine whether an API is available in v1.0, use the Version selector.
Retrieve the properties of all externalUserProfiles
This API is available in the following national cloud deployments.
Global service | US Government L4 | US Government L5 (DOD) | China operated by 21Vianet |
---|---|---|---|
✅ | ❌ | ❌ | ❌ |
Permissions
Choose the permission or permissions marked as least privileged for this API. Use a higher privileged permission or permissions only if your app requires it. For details about delegated and application permissions, see Permission types. To learn more about these permissions, see the permissions reference.
Permission type | Least privileged permissions | Higher privileged permissions |
---|---|---|
Delegated (work or school account) | ExternalUserProfile.Read.All | ExternalUserProfile.ReadWrite.All |
Delegated (personal Microsoft account) | Not supported. | Not supported. |
Application | ExternalUserProfile.Read.All | ExternalUserProfile.ReadWrite.All |
In delegated scenarios with work or school accounts, the signed-in user must be assigned a supported Microsoft Entra role or a custom role with a supported role permission. The following least privileged roles are supported for this operation:
- Global Reader
- Extended Directory User Administrator
- Teams Service Administrator
HTTP request
GET /directory/externalUserProfiles/{id}
Optional query parameters
You can use $filter
to only return specific external user profiles. The following properties can be used to $filter
:
- companyName
- supervisorId
For more information, see OData query parameters.
Request headers
Name | Description |
---|---|
Authorization | Bearer {token}. Required. Learn more about authentication and authorization. |
Request body
Don't supply a request body for this method.
Response
If successful, this method returns a 200 OK
response code and a JSON representation of the externalUserProfile in the response body.
Examples
Example 1: Get all external user profiles
Request
The following example shows a request.
GET https://graph.microsoft.com/beta/directory/externalUserProfiles
Response
The following example shows the response.
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
}
]
}
Example 2: List all external user profiles that are discoverable
Request
The following example shows a request.
GET https://graph.microsoft.com/beta/directory/externalUserProfiles$filter=isDiscoverable eq true
Response
The following example shows the response.
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
}
]
}