Get multiTenantOrganizationJoinRequestRecord
Namespace: microsoft.graph
Get the status of a tenant joining a 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.Read.All | MultiTenantOrganization.ReadWrite.All |
Delegated (personal Microsoft account) | Not supported. | Not supported. |
Application | MultiTenantOrganization.Read.All | MultiTenantOrganization.ReadWrite.All |
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/joinRequest
Optional query parameters
This method supports the $select
OData query parameter to help customize the response. For general information, see OData query parameters.
Request headers
Name | Description |
---|---|
Authorization | Bearer {token}. Required. Learn more about authentication and authorization. |
Request body
Don't supply a request body for this method.
Response
If successful, this method returns a 200 OK
response code and a multiTenantOrganizationJoinRequestRecord object in the response body.
Examples
The following example gets the status of a tenant joining a multitenant organization.
Request
GET https://graph.microsoft.com/v1.0/tenantRelationships/multiTenantOrganization/joinRequest
Response
The following example shows the response before an added tenant joins a multitenant organization.
HTTP/1.1 200 OK
Content-Type: application/json
{
"@odata.context": "https://graph.microsoft.com/v1.0/$metadata#tenantRelationships/multiTenantOrganization/joinRequest/$entity",
"id": "7149c406-fac5-4be9-ad4b-f46fac7fe60c",
"addedByTenantId": "00000000-0000-0000-0000-000000000000",
"memberState": null,
"role": null,
"transitionDetails": null
}
The following example shows the response after an added tenant requests to join a multitenant organization and the state is still pending
.
HTTP/1.1 200 OK
Content-Type: application/json
{
"@odata.context": "https://graph.microsoft.com/v1.0/$metadata#tenantRelationships/multiTenantOrganization/joinRequest/$entity",
"id": "3e536776-7489-43e9-9637-742d62ec3fc5",
"addedByTenantId": "1fd6544e-e994-4de2-9f1b-787b51c7d325",
"memberState": "pending",
"role": null,
"transitionDetails": {
"desiredMemberState": "active",
"status": "notStarted",
"details": ""
}
}
The following example shows the response after an added tenant successfully joins a multitenant organization and the state is changed to active
.
HTTP/1.1 200 OK
Content-Type: application/json
{
"@odata.context": "https://graph.microsoft.com/v1.0/$metadata#tenantRelationships/multiTenantOrganization/joinRequest/$entity",
"id": "3e536776-7489-43e9-9637-742d62ec3fc5",
"addedByTenantId": "1fd6544e-e994-4de2-9f1b-787b51c7d325",
"memberState": "active",
"role": member,
"transitionDetails": null
}
The following example shows the response when an added tenant fails to join a multitenant organization. To reset a failed join request, see Update multiTenantOrganizationJoinRequestRecord.
HTTP/1.1 200 OK
Content-Type: application/json
{
"@odata.context": "https://graph.microsoft.com/v1.0/$metadata#tenantRelationships/multiTenantOrganization/joinRequest/$entity",
"id": "3e536776-7489-43e9-9637-742d62ec3fc5",
"addedByTenantId": "1fd6544e-e994-4de2-9f1b-787b51c7d325",
"memberState": "pending",
"role": null,
"transitionDetails": {
"desiredMemberState": "active",
"status": "failed",
"details": "DirectoryService Exception"
}
}
피드백
https://aka.ms/ContentUserFeedback
출시 예정: 2024년 내내 콘텐츠에 대한 피드백 메커니즘으로 GitHub 문제를 단계적으로 폐지하고 이를 새로운 피드백 시스템으로 바꿀 예정입니다. 자세한 내용은 다음을 참조하세요.다음에 대한 사용자 의견 제출 및 보기