connectedOrganization 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.

In Microsoft Entra entitlement management, a connected organization is a reference to a directory or domain of another organization whose users can request access.

Methods

Method	Return type	Description
List	connectedOrganization collection	Retrieve a list of connectedOrganization objects.
Create	connectedOrganization	Create a new connectedOrganization object.
Get	connectedOrganization	Read properties and relationships of a connectedOrganization object.
Update		Update a connectedOrganization.
Delete	None	Delete a connectedOrganization.
External sponsors
List external sponsors	directoryObject collection	Retrieve a list of a connectedOrganization's external sponsors.
Add external sponsors	None	Add a user or group to a connectedOrganization's external sponsors.
Remove external sponsors	None	Remove a user or group from a connectedOrganization's external sponsors.
Internal sponsors
List internal sponsors	directoryObject collection	Retrieve a list of a connectedOrganization's internal sponsors.
Add internal sponsors	None	Add a user or group to a connectedOrganization's internal sponsors.
Remove internal sponsors	None	Remove a user or group from a connectedOrganization's internal sponsors.

Properties

Property	Type	Description
createdBy	String	UPN of the user who created this resource. Read-only.
createdDateTime	DateTimeOffset	The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. Read-only.
description	String	The description of the connected organization.
displayName	String	The display name of the connected organization. Supports $filter (eq).
id	String	Read-only.
modifiedBy	String	UPN of the user who last modified this resource. Read-only.
modifiedDateTime	DateTimeOffset	The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. Read-only.
state	connectedOrganizationState	The state of a connected organization defines whether assignment policies with requestor scope type AllConfiguredConnectedOrganizationSubjects are applicable or not. Possible values are: configured, proposed.
identitySources	identitySource collection	The identity sources in this connected organization, one of azureActiveDirectoryTenant, crossCloudAzureActiveDirectoryTenant, domainIdentitySource, externalDomainFederation, or socialIdentitySource. Read-only. Nullable. Supports $select and $filter(eq). To filter by the derived types, you must declare the resource using its full OData cast, for example, $filter=identitySources/any(is:is/microsoft.graph.azureActiveDirectoryTenant/tenantId eq 'bcfdfff4-cbc3-43f2-9000-ba7b7515054f').

Relationships

Relationship	Type	Description
internalSponsors	directoryObject collection	Nullable.
externalSponsors	directoryObject collection	Nullable.

JSON representation

The following JSON representation shows the resource type.

{
  "id": "String (identifier)",
  "displayName": "String",
  "description": "String",
  "createdBy": "String",
  "createdDateTime": "String (timestamp)",
  "modifiedBy": "String",
  "modifiedDateTime": "String (timestamp)",
  "identitySources": [
    {
      "@odata.type": "microsoft.graph.azureActiveDirectoryTenant",
      "tenantId": "String (identifier)",
      "displayName": "String"
    }
  ],
  "state": "String"
}