multi_tenant_organization_tenants

Creates, updates, deletes, gets or lists a multi_tenant_organization_tenants resource.

Overview

Name	multi_tenant_organization_tenants
Type	Resource
Id	entra_id.tenant_relationships.multi_tenant_organization_tenants

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 (uuid)	Tenant ID of the tenant that added the tenant to the multitenant organization. Read-only. (pattern: ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$)
addedDateTime	string (date-time)	Date and time when the tenant was added to the multitenant organization. Read-only. (pattern: ^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$)
deletedDateTime	string (date-time)	Date and time when this object was deleted. Always null when the object hasn't been deleted. (pattern: ^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$)
displayName	string	Display name of the tenant added to the multitenant organization.
joinedDateTime	string (date-time)	Date and time when the tenant joined the multitenant organization. Read-only. (pattern: ^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$)
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 but tenants with the member role can only participate in a multitenant organization. There can be multiple tenants with the owner role in a multitenant organization.
state		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.
tenantId	string	Tenant ID of the Microsoft Entra tenant added to the multitenant organization. Set at the time tenant is added.Supports $filter. Key.
transitionDetails		Details of the processing status for a tenant in a multitenant organization. Read-only. Nullable.

list

Retrieved collection

Name	Datatype	Description
id	string	The unique identifier for an entity. Read-only.
addedByTenantId	string (uuid)	Tenant ID of the tenant that added the tenant to the multitenant organization. Read-only. (pattern: ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$)
addedDateTime	string (date-time)	Date and time when the tenant was added to the multitenant organization. Read-only. (pattern: ^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$)
deletedDateTime	string (date-time)	Date and time when this object was deleted. Always null when the object hasn't been deleted. (pattern: ^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$)
displayName	string	Display name of the tenant added to the multitenant organization.
joinedDateTime	string (date-time)	Date and time when the tenant joined the multitenant organization. Read-only. (pattern: ^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$)
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 but tenants with the member role can only participate in a multitenant organization. There can be multiple tenants with the owner role in a multitenant organization.
state		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.
tenantId	string	Tenant ID of the Microsoft Entra tenant added to the multitenant organization. Set at the time tenant is added.Supports $filter. Key.
transitionDetails		Details of the processing status for a tenant in a multitenant organization. Read-only. Nullable.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	multi_tenant_organization_member_id		Get a tenant and its properties in the multitenant organization.
list	select			List the tenants and their properties in the multitenant organization.
insert	insert			Add a tenant to a multitenant organization. The administrator of an owner tenant has the permissions to add tenants to the multitenant organization. The added tenant is in the pending state until the administrator of the added tenant joins the multitenant organization by submitting a join request. A tenant can be part of only one multitenant organization.
update	update	multi_tenant_organization_member_id		Update the properties of a tenant in a multitenant organization. Only owner tenants can call this API.
delete	delete	multi_tenant_organization_member_id	If-Match	Remove a tenant from a multitenant organization. A tenant can be removed in the following scenarios:

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
multi_tenant_organization_member_id	string	The unique identifier of multiTenantOrganizationMember
If-Match	string	ETag

SELECT examples

get

Get a tenant and its properties in the multitenant organization.

SELECT
id,
addedByTenantId,
addedDateTime,
deletedDateTime,
displayName,
joinedDateTime,
role,
state,
tenantId,
transitionDetails
FROM entra_id.tenant_relationships.multi_tenant_organization_tenants
WHERE multi_tenant_organization_member_id = '{{ multi_tenant_organization_member_id }}' -- required
;

list

List the tenants and their properties in the multitenant organization.

SELECT
id,
addedByTenantId,
addedDateTime,
deletedDateTime,
displayName,
joinedDateTime,
role,
state,
tenantId,
transitionDetails
FROM entra_id.tenant_relationships.multi_tenant_organization_tenants
;

INSERT examples

insert

Add a tenant to a multitenant organization. The administrator of an owner tenant has the permissions to add tenants to the multitenant organization. The added tenant is in the pending state until the administrator of the added tenant joins the multitenant organization by submitting a join request. A tenant can be part of only one multitenant organization.

INSERT INTO entra_id.tenant_relationships.multi_tenant_organization_tenants (
id,
deletedDateTime,
addedByTenantId,
addedDateTime,
displayName,
joinedDateTime,
role,
state,
tenantId,
transitionDetails
)
SELECT 
'{{ id }}',
'{{ deletedDateTime }}',
'{{ addedByTenantId }}',
'{{ addedDateTime }}',
'{{ displayName }}',
'{{ joinedDateTime }}',
'{{ role }}',
'{{ state }}',
'{{ tenantId }}',
'{{ transitionDetails }}'
RETURNING
id,
addedByTenantId,
addedDateTime,
deletedDateTime,
displayName,
joinedDateTime,
role,
state,
tenantId,
transitionDetails
;

Manifest

# Description fields are for documentation purposes
- name: multi_tenant_organization_tenants
props:
  - name: id
    value: "{{ id }}"
    description: |
      The unique identifier for an entity. Read-only.
  - name: deletedDateTime
    value: "{{ deletedDateTime }}"
    description: |
      Date and time when this object was deleted. Always null when the object hasn't been deleted.
  - name: addedByTenantId
    value: "{{ addedByTenantId }}"
    description: |
      Tenant ID of the tenant that added the tenant to the multitenant organization. Read-only.
  - name: addedDateTime
    value: "{{ addedDateTime }}"
    description: |
      Date and time when the tenant was added to the multitenant organization. Read-only.
  - name: displayName
    value: "{{ displayName }}"
    description: |
      Display name of the tenant added to the multitenant organization.
  - name: joinedDateTime
    value: "{{ joinedDateTime }}"
    description: |
      Date and time when the tenant joined the multitenant organization. Read-only.
  - name: role
    value: "{{ role }}"
    description: |
      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 but tenants with the member role can only participate in a multitenant organization. There can be multiple tenants with the owner role in a multitenant organization.
  - name: state
    value: "{{ state }}"
    description: |
      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.
  - name: tenantId
    value: "{{ tenantId }}"
    description: |
      Tenant ID of the Microsoft Entra tenant added to the multitenant organization. Set at the time tenant is added.Supports $filter. Key.
  - name: transitionDetails
    value: "{{ transitionDetails }}"
    description: |
      Details of the processing status for a tenant in a multitenant organization. Read-only. Nullable.

UPDATE examples

update

Update the properties of a tenant in a multitenant organization. Only owner tenants can call this API.

UPDATE entra_id.tenant_relationships.multi_tenant_organization_tenants
SET 
id = '{{ id }}',
deletedDateTime = '{{ deletedDateTime }}',
addedByTenantId = '{{ addedByTenantId }}',
addedDateTime = '{{ addedDateTime }}',
displayName = '{{ displayName }}',
joinedDateTime = '{{ joinedDateTime }}',
role = '{{ role }}',
state = '{{ state }}',
tenantId = '{{ tenantId }}',
transitionDetails = '{{ transitionDetails }}'
WHERE 
multi_tenant_organization_member_id = '{{ multi_tenant_organization_member_id }}' --required
RETURNING
id,
addedByTenantId,
addedDateTime,
deletedDateTime,
displayName,
joinedDateTime,
role,
state,
tenantId,
transitionDetails;

DELETE examples

delete

Remove a tenant from a multitenant organization. A tenant can be removed in the following scenarios:

DELETE FROM entra_id.tenant_relationships.multi_tenant_organization_tenants
WHERE multi_tenant_organization_member_id = '{{ multi_tenant_organization_member_id }}' --required
AND If-Match = '{{ If-Match }}'
;