organization resource type

Important: APIs under the /beta version in Microsoft Graph are in preview and are subject to change. Use of these APIs in production applications is not supported.

Represents an Azure Active Directory tenant.

This resource lets you add your own data to custom properties using extensions.

Only the read and update operations are supported on tenants; create and delete are not supported. Inherits from directoryObject.

Methods

Method Return Type Description
Get organization organization Read properties and relationships of organization object.
Update organization Update organization object. The only properties that can be updated are: marketingNotificationMails, technicalNotificationMails, securityComplianceNotificationMails, securityComplianceNotificationPhones and privacyProfile.
Open extensions
Create open extension openTypeExtension Create an open extension and add custom properties to a new or existing resource.
Get open extension openTypeExtension collection Get an open extension identified by the extension name.
Schema extensions
Add schema extension values Create a schema extension definition and then use it to add custom typed data to a resource.

Properties

Property Type Description
assignedPlans assignedPlan collection The collection of service plans associated with the tenant. Not nullable.
city String City name of the address for the organization
companyLastDirSyncTime DateTimeOffset The time and date at which the tenant was last synced with the on-premise 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 would look like this: '2014-01-01T00:00:00Z'
country String Country/region name of the address for the organization
countryLetterCode String Country/region abbreviation for the organization
createdDateTime DateTimeOffset Timestamp of when the organization was created. The value cannot 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 would look like this: '2014-01-01T00:00:00Z'. Read-only.
deletionTimestamp 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 would look like this: '2014-01-01T00:00:00Z'
dirSyncEnabled 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; null if this object has never been synced from an on-premises directory (default).
displayName String The display name for the tenant.
id String The unique identifier for the tenant. Inherited from directoryObject. Key. Not nullable. Read-only.
isMultipleDataLocationsForServicesEnabled Boolean true if organization is Multi-Geo enabled; false if organization is not Multi-Geo enabled; null (default). Read-only. For more information, see OneDrive Online Multi-Geo.
marketingNotificationEmails String collection Not nullable.
objectType String A string that identifies the object type. For tenants the value is always “Company”.
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.
provisioningErrors ProvisioningError collection Not nullable.
securityComplianceNotificationMails String collection
securityComplianceNotificationPhones String collection
state String State name of the address for the organization
street String Street name of the address for organization
technicalNotificationMails String collection Not nullable.
telephoneNumber String Telephone number for the organization
verifiedDomains VerifiedDomain collection The collection of domains associated with this tenant. Not nullable.

Relationships

|extensions|extension collection|The collection of open extensions defined for the organization resource. Nullable.|

JSON representation

Here is a JSON representation of the resource

{
  "assignedPlans": [{"@odata.type": "microsoft.graph.assignedPlan"}],
  "businessPhones": ["string"],
  "city": "string",
  "country": "string",
  "countryLetterCode": "string",
  "displayName": "string",
  "id": "string (identifier)",
  "isMultipleDataLocationsForServicesEnabled": "boolean",
  "marketingNotificationEmails": ["string"],
  "onPremisesLastSyncDateTime": "String (timestamp)",
  "onPremisesSyncEnabled": true,
  "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"],
  "verifiedDomains": [{"@odata.type": "microsoft.graph.verifiedDomain"}]
}

See also