Create identity

Namespace: microsoft.graph.externalConnectors

Create an identity resource for a new member in an externalGroup.

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) ExternalItem.ReadWrite.OwnedBy ExternalItem.ReadWrite.All
Delegated (personal Microsoft account) Not supported. Not supported.
Application ExternalItem.ReadWrite.OwnedBy ExternalItem.ReadWrite.All

HTTP request

POST /external/connections/{connectionsId}/groups/{externalGroupId}/members

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, supply a JSON representation of the identity object.

You can specify the following properties when creating an identity resource for a member in an externalGroup.

Property Type Description
id String The unique id of the member. It would be the objectId in case of Microsoft Entra users or groups and the externalGroupId in case of external groups. Required.
type microsoft.graph.externalConnectors.identityType The type of member added to the external group. Possible values are: user,group, externalGroup. Required.

Response

If successful, this method returns a 201 Created response code and an identity object in the response body.

Examples

Example 1: Add a Microsoft Entra user as a member

Request

POST https://graph.microsoft.com/v1.0/external/connections/contosohr/groups/31bea3d537902000/members
Content-Type: application/json

{
  "id": "e811976d-83df-4cbd-8b9b-5215b18aa874",
  "type": "user"
}

Response

HTTP/1.1 201 Created
Content-Type: application/json

{
  "id": "e811976d-83df-4cbd-8b9b-5215b18aa874",
  "type": "user"
}

Example 2: Add a Microsoft Entra group as a member

Request

POST https://graph.microsoft.com/v1.0/external/connections/contosohr/groups/31bea3d537902000/members
Content-Type: application/json

{
  "id": "e5477431-1038-484e-bf69-1dfedb97a110",
  "type": "group"
}

Response

HTTP/1.1 201 Created
Content-Type: application/json

{
  "id": "e5477431-1038-484e-bf69-1dfedb97a110",
  "type": "group"
}

Example 3: Add another external group as a member

Request

POST https://graph.microsoft.com/v1.0/external/connections/contosohr/groups/31bea3d537902000/members
Content-Type: application/json

{
  "id": "1431b9c38ee647f6a",
  "type": "externalGroup",
}

Response

HTTP/1.1 201 Created
Content-Type: application/json

{
  "id": "14m1b9c38qe647f6a",
  "type": "externalGroup"
}