Show / Hide Table of Contents

Organization.Read.All

Allows the app to read the organization and related resources, on behalf of the signed-in user. Related resources include things like subscribed skus and tenant branding information.

Graph Methods

Type: A = Application Permission, D = Delegate Permission

Ver Type Method
V1 A,D GET /organization
V1 A,D GET /organization/{id}/certificateBasedAuthConfiguration
V1 A,D GET /organization/{id}/certificateBasedAuthConfiguration/{id}
V1 A,D GET /organization/{organizationId}/branding
V1 A,D GET /organization/{organizationId}/branding/localizations
V1 A,D GET /organization/{organizationId}/branding/localizations/{organizationalBrandingLocalizationId}
V1 D GET /organization/{organizationId}/settings/contactInsights
V1 D GET /organization/{organizationId}/settings/microsoftApplicationDataAccess
V1 A,D GET /subscribedSkus
V1 A,D GET /subscribedSkus/{id}

Delegate Permission

Id 4908d5b9-3fb2-4b1e-9336-1888b7937185
Consent Type Admin
Display String Read organization information
Description Allows the app to read the organization and related resources, on behalf of the signed-in user. Related resources include things like subscribed skus and tenant branding information.

Application Permission

Id 498476ce-e0fe-48b0-b801-37ba7e2685c6
Display String Read organization information
Description Allows the app to read the organization and related resources, without a signed-in user. Related resources include things like subscribed skus and tenant branding information.

Resources

certificateBasedAuthConfiguration

Property Type Description
certificateAuthorities certificateAuthority collection Collection of certificate authorities which creates a trusted certificate chain.
id String The unique identifier of the certificate based auth configuration. Read-only.

insightsSettings

Property Type Description
isEnabledInOrganization Boolean true if the specified type of insights are enabled for the organization; false if the specified type of insights are disabled for all users without exceptions. Default is true. Optional.
disabledForGroup String The ID of an Azure Active Directory group, of which the specified type of insights are disabled for its members. Default is empty. Optional.

microsoftApplicationDataAccessSettings

Property Type Description
isEnabledForAllMicrosoftApplications Boolean When set to true, all users in the organization can access in a Microsoft app any Microsoft 365 data that the user has been authorized to access. The Microsoft app can be a Microsoft 365 app (for example, Excel, Outlook) or non-Microsoft 365 app (for example, Edge). The default is true.
It is possible to disable this access for a subset of users in an Azure AD security group, by specifying the group in the disabledForGroup property.
When set to false, all users can access authorized Microsoft 365 data only in a Microsoft 365 app.
disabledForGroup String The ID of an Azure Active Directory (Azure AD) security group for which the members are allowed to access Microsoft 365 data using only Microsoft 365 apps, but not other Microsoft apps such as Edge.
This is only applicable if **i

organization

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 is a string collection, only one number can be set for this property.
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 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 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 Azure AD 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.
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 is not Multi-Geo enabled; null (default). Read-only. For more information, see OneDrive Online Multi-Geo.
marketingNotificationEmails String collection Not nullable.
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. Read-only.
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 has never been synced from an on-premises directory (default).
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
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.
tenantType String Not nullable. The tenant type option that was selected when the tenant was created. The possible values are:
  • AAD - An enterprise identity access management (IAM) service that serves business-to-employee and business-to-business (B2B) scenarios.
  • AAD B2C A customer identity access management (CIAM) service that serves business-to-consumer (B2C) scenarios.
  • verifiedDomains VerifiedDomain collection The collection of domains associated with this tenant. Not nullable.

    organizationalBranding

    Property Type Description
    backgroundColor String Color that will appear in place of the background image in low-bandwidth connections. We recommend that you use the primary color of your banner logo or your organization color. Specify this in hexadecimal format, for example, white is #FFFFFF. Inherited from organizationalBrandingProperties.
    backgroundImage Stream Image that appears as the background of the sign-in page. The allowed types are PNG or JPEG not smaller than 300 KB and not larger than 1920 × 1080 pixels. A smaller image will reduce bandwidth requirements and make the page load faster. Inherited from organizationalBrandingProperties. Returned only on $select.
    backgroundImageRelativeUrl String A relative URL for the backgroundImage property that is combined with a CDN base URL from the cdnList to provide the version served by a CDN. Read-only. Inherited from organizationalBrandingProperties.
    bannerLogo Stream A banner version of your company logo that appears on the sign-in page. The allowed types are PNG or JPEG no larger than 36 × 245 pixels. We recommend using a transparent image with no padding around the logo. Inherited from organizationalBrandingProperties. Returned only on $select.
    bannerLogoRelativeUrl String A relative url for the bannerLogo property that is combined with a CDN base URL from the cdnList to provide the read-only version served by a CDN. Read-only. Inherited from organizationalBrandingProperties.
    cdnList String collection A list of base URLs for all available CDN providers that are serving the assets of the current resource. Several CDN providers are used at the same time for high availability of read requests. Read-only. Inherited from organizationalBrandingProperties.
    id String An identifier that represents the locale specified using culture names. Culture names follow the RFC 1766 standard in the format "languagecode2-country/regioncode2", where "languagecode2" is a lowercase two-letter code derived from ISO 639-1 and "country/regioncode2" is an uppercase two-letter code derived from ISO 3166. For example, U.S. English is en-US. The id for the default /branding is always the String types 0 or default. Read-only.

    NOTE: Multiple branding for a single locale are currently not supported. Inherited from organizationalBrandingProperties.
    signInPageText String Text that appears at the bottom of the sign-in box. You can use this to communicate additional information, such as the phone number to your help desk or a legal statement. This text must be Unicode and not exceed 1024 characters. Inherited from organizationalBrandingProperties.
    squareLogo Stream A square version of your company logo that appears in Windows 10 out-of-box experiences (OOBE) and when Windows Autopilot is enabled for deployment. Allowed types are PNG or JPEG no larger than 240 x 240 pixels and no more than 10 KB in size. We recommend using a transparent image with no padding around the logo. Inherited from organizationalBrandingProperties. Returned only on $select.
    squareLogoRelativeUrl String A relative url for the squareLogo property that is combined with a CDN base URL from the cdnList to provide the version served by a CDN. Read-only. Inherited from organizationalBrandingProperties.
    usernameHintText String String that shows as the hint in the username textbox on the sign-in screen. This text must be a Unicode, without links or code, and can't exceed 64 characters. Inherited from organizationalBrandingProperties.

    organizationalBrandingLocalization

    Property Type Description
    backgroundColor String Color that will appear in place of the background image in low-bandwidth connections. We recommend that you use the primary color of your banner logo or your organization color. Specify this in hexadecimal format, for example, white is #FFFFFF. Inherited from organizationalBrandingProperties.
    backgroundImage Stream Image that appears as the background of the sign-in page. The allowed types are PNG or JPEG not smaller than 300 KB and not larger than 1920 × 1080 pixels. A smaller image will reduce bandwidth requirements and make the page load faster. Inherited from organizationalBrandingProperties.
    backgroundImageRelativeUrl String A relative URL for the backgroundImage property that is combined with a CDN base URL from the cdnList to provide the version served by a CDN. Read-only. Inherited from organizationalBrandingProperties.
    bannerLogo Stream A banner version of your company logo that appears on the sign-in page. The allowed types are PNG or JPEG no larger than 36 × 245 pixels. We recommend using a transparent image with no padding around the logo. Inherited from organizationalBrandingProperties.
    bannerLogoRelativeUrl String A relative url for the bannerLogo property that is combined with a CDN base URL from the cdnList to provide the read-only version served by a CDN. Read-only. Inherited from organizationalBrandingProperties.
    cdnList String collection A list of base URLs for all available CDN providers that are serving the assets of the current resource. Several CDN providers are used at the same time for high availability of read requests. Read-only. Inherited from organizationalBrandingProperties.
    id String An identifier that represents the locale specified using culture names. Culture names follow the RFC 1766 standard in the format "languagecode2-country/regioncode2", where "languagecode2" is a lowercase two-letter code derived from ISO 639-1 and "country/regioncode2" is an uppercase two-letter code derived from ISO 3166. For example, U.S. English is en-US. The id for the default /branding is always the String types 0 or default. Read-only.

    NOTE: Multiple branding for a single locale are currently not supported. Inherited from organizationalBrandingProperties.
    signInPageText String Text that appears at the bottom of the sign-in box. You can use this to communicate additional information, such as the phone number to your help desk or a legal statement. This text must be Unicode and not exceed 1024 characters. Inherited from organizationalBrandingProperties.
    squareLogo Stream A square version of your company logo that appears in Windows 10 out-of-box experiences (OOBE) and when Windows Autopilot is enabled for deployment. Allowed types are PNG or JPEG no larger than 240 x 240 pixels and no more than 10 KB in size. We recommend using a transparent image with no padding around the logo. Inherited from organizationalBrandingProperties.
    squareLogoRelativeUrl String A relative url for the squareLogo property that is combined with a CDN base URL from the cdnList to provide the version served by a CDN. Read-only. Inherited from organizationalBrandingProperties.
    usernameHintText String String that shows as the hint in the username textbox on the sign-in screen. This text must be a Unicode, without links or code, and can't exceed 64 characters. Inherited from organizationalBrandingProperties.

    subscribedSku

    Property Type Description
    appliesTo String For example, "User" or "Company".
    capabilityStatus String Possible values are: Enabled, Warning, Suspended, Deleted, LockedOut. The capabilityStatus is Enabled if the prepaidUnits property has at least 1 unit that is enabled, and LockedOut if the customer cancelled their subscription.
    consumedUnits Int32 The number of licenses that have been assigned.
    id String The unique identifier for the subscribed sku object. Key, not nullable.
    prepaidUnits licenseUnitsDetail Information about the number and status of prepaid licenses.
    servicePlans servicePlanInfo collection Information about the service plans that are available with the SKU. Not nullable
    skuId Guid The unique identifier (GUID) for the service SKU.
    skuPartNumber String The SKU part number; for example: "AAD_PREMIUM" or "RMSBASIC". To get a list of commercial subscriptions that an organization has acquired, see List subscribedSkus.
    In This Article
    Back to top Created by merill | Submit feedback