externalUserProfile resource type
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.
Represents the profile of an external user in a Microsoft Entra tenant. This profile is created when a user redeems their pendingExternalUserProfile. The pending external user profile can be created through the Create pendingExternalUserProfile API.
Inherits from externalProfile.
Methods
| Method | Return Type | Description |
|---|---|---|
| Get | externalUserProfile | Gets the properties of an external user profile. |
| List | externalUserProfile collection | Gets a list of all external user profiles. |
| Update | None | Update an external user profile. |
| Delete | None | Delete an external user profile. |
| List deleted items | directoryObject collection | Retrieve a list of recently deleted external user profiles from a collection of directory objects. |
| Get deleted item | directoryObject | Retrieve the properties of a recently deleted external user profile object. |
| Restore deleted item | directoryObject | Restore a recently deleted external user profile object. |
| Permanently delete item | None | Permanently delete an external user profile. |
Properties
| Property | Type | Description |
|---|---|---|
| address | physicalOfficeAddress | The office address of the external user profile. Inherited from externalProfile. |
| createdBy | String | The object ID of the user who created the external user profile. Inherited from externalProfile. Read-only. Not nullable. |
| createdDateTime | DateTimeOffset | Date and time when this external user was created. Inherited from externalProfile. Not nullable. Read-only. |
| companyName | String | The company name of the external user profile. Inherited from externalProfile. Supports $filter (eq, startswith). |
| deletedDateTime | DateTimeOffset | Date and time when this external user profile was deleted. Always null when the object isn't deleted. Inherited from externalProfile. |
| department | String | The department of the external user profile. Inherited from externalProfile. |
| displayName | String | The display name of the external user profile. Inherited from externalProfile. |
| id | String | The unique identifier for the external user profile. For example, 12345678-9abc-def0-1234-56789abcde. The value of the id property is often but not exclusively in the form of a GUID; treat it as an opaque identifier and don't rely on it being a GUID. Key. Not nullable. Read-only. |
| isDiscoverable | Boolean | Represents whether the external user profile is discoverable in the directory. When true, this external profile shows up in Teams search. When false, this external profile doesn't show up in Teams search. Inherited from externalProfile. |
| isEnabled | Boolean | Represents whether the external user profile is enabled in the directory. This property is peer to the accountEnabled property on the User object. |
| jobTitle | String | The job title of the external user profile. Inherited from externalProfile. |
| phoneNumber | String | The phone number of the external user profile. Must be in E164 format. Inherited from externalProfile. |
| supervisorId | String | The object ID of the supervisor of the external user profile. Inherited from externalProfile. Supports $filter (eq, startswith). |
Relationships
None.
JSON representation
The following JSON representation shows the resource type.
{
"@odata.type": "#microsoft.graph.externalUserProfile",
"id": "String (identifier)",
"deletedDateTime": "String (timestamp)",
"createdDateTime": "String (timestamp)",
"createdBy": "String",
"companyName": "String",
"displayName": "String",
"jobTitle": "String",
"isDiscoverable": "Boolean",
"isEnabled": "Boolean",
"department": "String",
"phoneNumber": "String",
"address": {
"@odata.type": "microsoft.graph.physicalOfficeAddress"
},
"supervisorId": "String"
}