Edit

Share via

tenant resource type

  • Article

Namespace: microsoft.graph.managedTenants

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.

Represents a tenant associated with the managing entity.

Methods

Method Return type Description
List tenants microsoft.graph.managedTenants.tenant collection Get a list of the tenant objects and their properties.
Get tenant microsoft.graph.managedTenants.tenant Read the properties and relationships of a tenant object.
Offboard tenant microsoft.graph.managedTenants.tenant Off boards a tenant from the multi-tenant management platform.
Reset tenant onboarding status microsoft.graph.managedTenants.tenant Resets the tenant onboarding status with the multi-tenant management platform.

Properties

Property Type Description
contract microsoft.graph.managedTenants.tenantContract The relationship details for the tenant with the managing entity.
createdDateTime DateTimeOffset The date and time the tenant was created in the multi-tenant management platform. Optional. Read-only.
displayName String The display name for the tenant. Required. Read-only.
id String The Microsoft Entra tenant identifier for the tenant. Required. Read-only.
lastUpdatedDateTime DateTimeOffset The date and time the tenant was last updated within the multi-tenant management platform. Optional. Read-only.
tenantId String The Microsoft Entra tenant identifier for the managed tenant. Optional. Read-only.
tenantStatusInformation microsoft.graph.managedTenants.tenantStatusInformation The onboarding status information for the tenant. Optional. Read-only.

Relationships

None.

JSON representation

The following JSON representation shows the resource type.

{
  "@odata.type": "#microsoft.graph.managedTenants.tenant",
  "contract": {"@odata.type": "microsoft.graph.managedTenants.tenantContract"},
  "createdDateTime": "String (timestamp)",
  "displayName": "String",
  "id": "String (identifier)",
  "lastUpdatedDateTime": "String (timestamp)",
  "tenantId": "String",
  "tenantStatusInformation": {"@odata.type": "microsoft.graph.managedTenants.tenantStatusInformation"}
}