Create pendingExternalUserProfile
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.
Create a new pendingExternalUserProfile object.
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) | PendingExternalUserProfile.ReadWrite.All | Not available. |
Delegated (personal Microsoft account) | Not supported. | Not supported. |
Application | PendingExternalUserProfile.ReadWrite.All | Not available. |
Important
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:
- Extended Directory User Administrator
- Teams Service Administrator
HTTP request
POST /directory/pendingExternalUserProfiles
Request headers
Name | Description |
---|---|
Authorization | Bearer {token}. Required. Learn more about authentication and authorization. |
Content-Type | application/json. Required. |
Request body
In the request body, provide a JSON representation of a pendingExternalUserProfile.
Property | Type | Description |
---|---|---|
address | physicalOfficeAddress | The office address of the pending external user profile. |
createdBy | String | The object id of the user who created the pending external user profile. Read-only. Not nullable. |
createdDateTime | DateTimeOffset | Date and time when this pending external user profile was created. Not nullable. Read-only. |
companyName | String | The company name of the pending external user profile. |
deletedDateTime | DateTimeOffset | Date and time when the pending external user profile was deleted. Always null when the object isn't deleted. |
department | String | The department of the pending external user profile. |
displayName | String | The display name of the pending external user profile. Required. |
epoch | Int | The version number of the pending external user profile. Incremented with each update to the entity. Read-only. Not nullable. |
id | String | The unique identifier for the pending 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 do not rely on it being a GUID. Key. Not nullable. Read-only. |
isDiscoverable | Boolean | Represents whether the pending external user profile is discoverable in the directory. |
isEnabled | Boolean | Represents whether the pending external user profile is enabled in the directory. |
jobTitle | String | The job title of the external user profile. |
phoneNumber | String | The phone number of the pending external user profile. Must be in E164 format. Required. |
supervisorId | String | The object id of the supervisor of the pending external user profile. |
Response
If successful, this method returns a 201 Created
response code and a pendingExternalUserProfile object. If unsuccessful, a 4xx
error is returned with specific details.
Example
Request
The following example shows a request.
POST https://graph.microsoft.com/beta/directory/pendingExternalUserProfiles
Content-type: application/json
{
"phoneNumber": "+15555555555",
"displayName": "Bob Henry"
}
Response
The following example shows the response.
Note: The response object shown here might be shortened for readability.
HTTP/1.1 201 Created
Content-type: application/json
{
"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": null,
"countryOrRegion": null,
"officeLocation": null,
"postalCode": null,
"state": null,
"street": null
},
"epoch":1,
"createdBy":"67670e18-bf37-416c-b5c8-3bfdaad757cc",
"supervisorId":null,
"companyName":null
}