List multiTenantOrganizationMembers
Namespace: microsoft.graph
List the tenants and their properties in the multitenant organization.
This API is available in the following national cloud deployments.
Global service | US Government L4 | US Government L5 (DOD) | China operated by 21Vianet |
---|---|---|---|
✅ | ❌ | ❌ | ❌ |
Permissions
Choose the permission or permissions marked as least privileged for this API. Use a higher privileged permission or permissions only if your app requires it. For details about delegated and application permissions, see Permission types. To learn more about these permissions, see the permissions reference.
Permission type | Least privileged permissions | Higher privileged permissions |
---|---|---|
Delegated (work or school account) | MultiTenantOrganization.ReadBasic.All | MultiTenantOrganization.ReadWrite.All, MultiTenantOrganization.Read.All |
Delegated (personal Microsoft account) | Not supported. | Not supported. |
Application | MultiTenantOrganization.Read.All | MultiTenantOrganization.ReadWrite.All |
If called with MultiTenantOrganization.Read.All or MultiTenantOrganization.ReadWrite.All permissions, this API returns both active and pending tenants. If called with MultiTenantOrganization.ReadBasic.All permission, the caller can only read the displayName and tenantId properties.
The signed-in user must also be assigned at least one of the following directory roles:
- Security Reader
- Global Reader
HTTP request
GET /tenantRelationships/multiTenantOrganization/tenants
Optional query parameters
This method supports the $select
and $filter
OData query parameters to help customize the response. For general information, see OData query parameters.
Request headers
Name | Description |
---|---|
Authorization | Bearer {token}. Required. |
Request body
Don't supply a request body for this method.
Response
If successful, this method returns a 200 OK
response code and a collection of multiTenantOrganizationMember objects in the response body.
Examples
The following example lists the tenants and their properties in the multitenant organization.
Request
GET https://graph.microsoft.com/v1.0/tenantRelationships/multiTenantOrganization/tenants
Response
HTTP/1.1 200 OK
Content-Type: application/json
{
"@odata.context": "https://graph.microsoft.com/v1.0/$metadata#tenantRelationships/multiTenantOrganization/tenants",
"value": [
{
"tenantId": "1fd6544e-e994-4de2-9f1b-787b51c7d325",
"displayName": "Contoso",
"addedDateTime": "2023-05-26T22:05:23Z",
"joinedDateTime": null,
"addedByTenantId": "1fd6544e-e994-4de2-9f1b-787b51c7d325",
"role": "owner",
"state": "active",
"transitionDetails": null
},
{
"tenantId": "4a12efe6-aa14-4d03-8dff-88fc89e2e2ad",
"displayName": "Fabrikam",
"addedDateTime": "2023-05-27T19:24:29Z",
"joinedDateTime": null,
"addedByTenantId": "1fd6544e-e994-4de2-9f1b-787b51c7d325",
"role": "member",
"state": "pending",
"transitionDetails": null
},
{
"tenantId": "5036a0a0-a7a4-4933-9086-5dd54535dd6e",
"displayName": "Woodgrove Bank",
"addedDateTime": "2023-05-27T20:41:56Z",
"joinedDateTime": null,
"addedByTenantId": "1fd6544e-e994-4de2-9f1b-787b51c7d325",
"role": "member",
"state": "pending",
"transitionDetails": null
}
]
}
Feedback
https://aka.ms/ContentUserFeedback.
Coming soon: Throughout 2024 we will be phasing out GitHub Issues as the feedback mechanism for content and replacing it with a new feedback system. For more information see:Submit and view feedback for