Sign in Subscribe
Entra ID

Entra ID Tenant Information API

We've developed and rolled out a new API, that'll allow you to retrieve the Entra ID tenant information for a given tenant ID or domain name.

Chris Greenacre

Chris Greenacre

— 2 min read
Entra ID Tenant Information API
Photo by Luca Bravo / Unsplash

The Tophhie Cloud API was originally designed as an internal tool, over time we're starting to release some of the APIs to the public, in hopes they'll help you with whatever tasks you may have.

With that in mind, we'd like to introduce the...

Entra ID Tenant Information API 🎉

ℹī¸
This API has been made publicly available, without authentication. This may however change in future, dependant on use and potential for abuse.

The API is available from this endpoint:
https://api.tophhie.cloud/tenantinfo

To utilise the API, you need one of the following:

  • The tenant ID
  • A domain name used within the tenant

Once you have either the tenant ID or the domain name, you're ready to use the API. Depending on which one of these you have, depends on the query parameter used.

If you have the tenant ID, specify "tenantID" as the query parameter:
https://api.tophhie.cloud/tenantinfo?tenantID={ENTRA ID TENANT ID}

If you have the domain name, specify "domainName" as the query parameter:
https://api.tophhie.cloud/tenantinfo?domainName={DOMAIN NAME}

Let's take the Microsoft tenant for example, to get information about the Microsoft tenant, you could use either of the following:

Once you call the API, you'll receive either a JSON object response (if the request is successful) or a standard text response with an error message.

The success response will always have a 200 status code.

The successful JSON object will look like:

{
    "tenantId": string,
    "federationBrandName": string or null,
    "tenantDisplayName": string,
    "defaultDomainName": string,
    "bannerLogo": string (may be empty),
    "tenantRegion": string,
    "desktopSsoEnabled": boolean,
    "verifiedEmailSignUpDisallowed": boolean or null,
    "tenantIsUnmanaged": boolean or null,
    "tenantUsesExo": boolean,
    "mxRecords": [string],
    "tenantUsesSpo": boolean,
    "spoDomains": [string],
    "verifiedDomains": integer,
    "additionalDomains": [string]
}

Any status other than 200, means there was an error, and the text will indicate what the error was.

Give it a try and let us know what you think! If you run into any issues, you can reach out to our API support email address at api-support@tophhie.cloud.

Until next time 👋

Read more