| title | pendingExternalUserProfile resource type |
|---|---|
| description | Represents an external user profile in the Microsoft Entra tenant that hasn't consented to share data with the tenant. |
| ms.localizationpriority | high |
| author | jkdouglas |
| ms.reviewer | mapamu |
| ms.subservice | entra-directory-management |
| doc_type | resourcePageType |
| ms.date | 07/15/2024 |
Namespace: microsoft.graph
[!INCLUDE beta-disclaimer]
Represents an external user profile in the Microsoft Entra tenant that hasn't consented to share data with the tenant.
Inherits from externalProfile.
| Method | Return Type | Description |
|---|---|---|
| Get | pendingExternalUserProfile | Gets the properties of a pending external user profile. |
| List | pendingExternalUserProfile collection | Gets a list of all pending external user profiles. |
| Create | pendingExternalUserProfile | Creates a new pending external user profile. |
| Update | None | Update a pending external user profile. |
| Delete | None | Delete a pending 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. |
| Property | Type | Description |
|---|---|---|
| address | physicalOfficeAddress | The office address of the pending external user profile. Inherited from externalProfile. |
| createdBy | String | The object ID of the user or principal who created the pending external user profile or invited the external user. Inherited from externalProfile. Read-only. Not nullable. |
| createdDateTime | DateTimeOffset | Date and time when this pending external user profile was created. Inherited from externalProfile. Not nullable. Read-only. |
| companyName | String | The company name of the pending external user profile. Inherited from externalProfile. Supports the $filter (eq, startswith) query parameter. |
| deletedDateTime | DateTimeOffset | Date and time when the pending external user profile was deleted. Always null when the object isn't deleted. Inherited from externalProfile. |
| department | String | The department of the pending external user profile. Inherited from externalProfile. |
| displayName | String | The display name of the pending external user profile. Inherited from externalProfile. |
| id | String | The unique identifier for the pending external user profile. Not nullable. Read-only. |
| isDiscoverable | Boolean | Represents whether the pending external user profile is discoverable in the directory. When true, this external profile shows up in Teams search. Inherited from externalProfile. |
| isEnabled | Boolean | Represents whether the pending external user profile is enabled in the directory. Inherited from externalProfile. |
| jobTitle | String | The job title of the external user profile. Inherited from externalProfile. |
| phoneNumber | String | The phone number of the pending external user profile. Must be in E.164 format. Inherited from externalProfile. |
| supervisorId | String | The object ID of the supervisor of the pending external user profile. Inherited from externalProfile. Supports the $filter (eq, startswith) query parameter. |
None.
The following JSON representation shows the resource type.
{
"@odata.type": "#microsoft.graph.pendingExternalUserProfile",
"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"
}