multi_tenant_organization_join_request
Creates, updates, deletes, gets or lists a multi_tenant_organization_join_request resource.
Overview
| Name | multi_tenant_organization_join_request |
| Type | Resource |
| Id | entra_id.tenant_relationships.multi_tenant_organization_join_request |
Fields
The following fields are returned by SELECT queries:
- get
Retrieved navigation property
| Name | Datatype | Description |
|---|---|---|
id | string | The unique identifier for an entity. Read-only. |
addedByTenantId | string | Tenant ID of the Microsoft Entra tenant that added a tenant to the multitenant organization. To reset a failed join request, set addedByTenantId to 00000000-0000-0000-0000-000000000000. Required. |
memberState | | State of the tenant in the multitenant organization. The possible values are: pending, active, removed, unknownFutureValue. Tenants in the pending state must join the multitenant organization to participate in the multitenant organization. Tenants in the active state can participate in the multitenant organization. Tenants in the removed state are in the process of being removed from the multitenant organization. Read-only. |
role | | Role of the tenant in the multitenant organization. The possible values are: owner, member (default), unknownFutureValue. Tenants with the owner role can manage the multitenant organization. There can be multiple tenants with the owner role in a multitenant organization. Tenants with the member role can participate in a multitenant organization. |
transitionDetails | | Details of the processing status for a tenant joining a multitenant organization. Read-only. |
Methods
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
get | select | Get the status of a tenant joining a multitenant organization. | ||
update | update | Join a multitenant organization, after the owner of the multitenant organization has added your tenant to the multitenant organization as pending. Before a tenant added to a multitenant organization can participate in the multitenant organization, the administrator of the joining tenant must submit a join request. To allow for asynchronous processing, you must wait up to 2 hours before joining a multitenant organization is completed. |
Parameters
Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.
| Name | Datatype | Description |
|---|
SELECT examples
- get
Get the status of a tenant joining a multitenant organization.
SELECT
id,
addedByTenantId,
memberState,
role,
transitionDetails
FROM entra_id.tenant_relationships.multi_tenant_organization_join_request
;
UPDATE examples
- update
Join a multitenant organization, after the owner of the multitenant organization has added your tenant to the multitenant organization as pending. Before a tenant added to a multitenant organization can participate in the multitenant organization, the administrator of the joining tenant must submit a join request. To allow for asynchronous processing, you must wait up to 2 hours before joining a multitenant organization is completed.
UPDATE entra_id.tenant_relationships.multi_tenant_organization_join_request
SET
id = '{{ id }}',
addedByTenantId = '{{ addedByTenantId }}',
memberState = '{{ memberState }}',
role = '{{ role }}',
transitionDetails = '{{ transitionDetails }}'
RETURNING
id,
addedByTenantId,
memberState,
role,
transitionDetails;