Skip to content

organization.md

Latest commit

 

History

History
145 lines (126 loc) · 9.73 KB

organization.md

File metadata and controls

145 lines (126 loc) · 9.73 KB
title organization resource type
description Represents the Microsoft Entra tenant that the user or application is authenticated to.
ms.localizationpriority medium
author suawat
ms.reviewer alvarorahul, iamut
ms.subservice entra-directory-management
doc_type resourcePageType
ms.date 05/23/2024

organization resource type

Namespace: microsoft.graph

[!INCLUDE beta-disclaimer]

Represents the Microsoft Entra tenant that the user or application is authenticated to. Only the read and update operations are supported on this resource. Inherits from directoryObject.

Methods

Method Return Type Description
List organization collection Read properties and relationships of the organization object.
Get organization collection Read properties and relationships of an organization object.
Update None Update an organization object.

Properties

Property Type Description
assignedPlans assignedPlan collection The collection of service plans associated with the tenant. Not nullable.
businessPhones String collection Telephone number for the organization. Although this property is a string collection, only one number can be set.
city String City name of the address for the organization.
country String Country/region name of the address for the organization.
countryLetterCode String Country or region abbreviation for the organization in ISO 3166-2 format.
createdDateTime DateTimeOffset Timestamp of when the organization was created. The value can't be modified and is automatically populated when the organization is created. 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.
defaultUsageLocation String Two-letter ISO 3166 country code indicating the default service usage location of an organization.
deletedDateTime DateTimeOffset Represents date and time of when the Microsoft Entra tenant was deleted 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.
directorySizeQuota directorySizeQuota The directory size quota information of an organization.
displayName String The display name for the tenant.
id String The tenant ID, a unique identifier representing the organization (or tenant). Inherited from directoryObject. Key. Not nullable. Read-only.
isMultipleDataLocationsForServicesEnabled Boolean true if organization is Multi-Geo enabled; false if organization isn't Multi-Geo enabled; null (default). Read-only. For more information, see OneDrive Online Multi-Geo.
marketingNotificationEmails String collection Not nullable.
onPremisesLastPasswordSyncDateTime DateTimeOffset The last time a password sync request was received for the tenant.
onPremisesLastSyncDateTime DateTimeOffset The time and date at which the tenant was last synced with the on-premises directory. 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.
onPremisesSyncEnabled Boolean true if this object is synced from an on-premises directory; false if this object was originally synced from an on-premises directory but is no longer synced; Nullable. null, if this object isn't synced from on-premises active directory (default).
partnerTenantType partnerTenantType The type of partnership this tenant has with Microsoft. The possible values are: microsoftSupport, syndicatePartner, breadthPartner, breadthPartnerDelegatedAdmin, resellerPartnerDelegatedAdmin, valueAddedResellerPartnerDelegatedAdmin, unknownFutureValue. Nullable. For more information about the possible types, see partnerTenantType values.
postalCode String Postal code of the address for the organization.
preferredLanguage String The preferred language for the organization. Should follow ISO 639-1 code; for example, en.
privacyProfile privacyProfile The privacy profile of an organization.
provisionedPlans provisionedPlan collection Not nullable.
securityComplianceNotificationMails String collection Not nullable.
securityComplianceNotificationPhones String collection Not nullable.
state String State name of the address for the organization.
street String Street name of the address for organization.
technicalNotificationMails String collection Not nullable.
tenantType String Not nullable. Can be one of the following types:
  • AAD - An enterprise identity access management (IAM) service that serves business-to-employee and business-to-business (B2B) scenarios.
  • AAD B2C An identity access management (IAM) service that serves business-to-consumer (B2C) scenarios.
  • CIAM - A customer identity & access management (CIAM) solution that provides an integrated platform to serve consumers, partners, and citizen scenarios.
verifiedDomains verifiedDomain collection The collection of domains associated with this tenant. Not nullable.

partnerTenantType values

Member Description
microsoftSupport Legacy support tenant of Microsoft that was used to provide administrative support to all customer tenants.
breadthPartner The partner can provide administrative support for their customers. However, the partner isn't allowed to resell to or request delegated admin permissions from customers.
breadthPartnerDelegatedAdmin Similar to Breadth Partner except they can request for delegated admin permissions (DAP) from customer tenants.
syndicatePartner The partner exclusively resells and manages Microsoft 365 and Intune for their customers. The customer can't buy more subscriptions directly or through other Microsoft partners.
resellerPartnerDelegatedAdmin The partner that can resell and manage Microsoft 365 and Intune for their customers. There's no exclusivity clause like for syndication partners. The customer can buy more subscriptions directly from Microsoft or through other Microsoft partners.
valueAddedResellerPartnerDelegatedAdmin They're Tier 2 partners. They're Microsoft partners that have a relationship with another Microsoft partner such as a reseller.
unknownFutureValue Evolvable enumeration sentinel value. Do not use.

Relationships

Relationship Type Description
certificateBasedAuthConfiguration certificateBasedAuthConfiguration collection Navigation property to manage certificate-based authentication configuration. Only a single instance of certificateBasedAuthConfiguration can be created in the collection.
extensions extension collection The collection of open extensions defined for the organization resource. Nullable.
branding organizationalBranding Resource to manage the default branding for the organization. Nullable.
settings organizationSettings Retrieve the properties and relationships of organizationSettings object. Nullable.

JSON representation

The following JSON representation shows the resource type.

{
  "assignedPlans": [{"@odata.type": "microsoft.graph.assignedPlan"}],
  "businessPhones": ["String"],
  "city": "String",
  "country": "String",
  "countryLetterCode": "String",
  "createdDateTime": "String (timestamp)",
  "defaultUsageLocation": "String",
  "deletedDateTime": "String (timestamp)",
  "directorySizeQuota": {"@odata.type": "microsoft.graph.directorySizeQuota"},
  "displayName": "String",
  "id": "String (identifier)",
  "isMultipleDataLocationsForServicesEnabled": "Boolean",
  "marketingNotificationEmails": ["String"],
  "onPremisesLastPasswordSyncDateTime": "String (timestamp)",
  "onPremisesLastSyncDateTime": "String (timestamp)",
  "onPremisesSyncEnabled": true,
  "partnerTenantType": "String",
  "postalCode": "String",
  "preferredLanguage": "String",
  "privacyProfile": {"@odata.type": "microsoft.graph.privacyProfile"},
  "provisionedPlans": [{"@odata.type": "microsoft.graph.provisionedPlan"}],
  "securityComplianceNotificationMails": ["String"],
  "securityComplianceNotificationPhones": ["String"],
  "state": "String",
  "street": "String",
  "technicalNotificationMails": ["String"],
  "tenantType": "string",
  "verifiedDomains": [{"@odata.type": "microsoft.graph.verifiedDomain"}]
}

Related content