entitlement_management_connected_organizations

Creates, updates, deletes, gets or lists an entitlement_management_connected_organizations resource.

Overview

Name	entitlement_management_connected_organizations
Type	Resource
Id	entra_id.identity_governance.entitlement_management_connected_organizations

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.
createdDateTime	string (date-time)	The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. 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])$)
description	string	The description of the connected organization.
displayName	string	The display name of the connected organization. Supports $filter (eq).
externalSponsors	array
identitySources	array	The identity sources in this connected organization, one of azureActiveDirectoryTenant, crossCloudAzureActiveDirectoryTenant, domainIdentitySource, externalDomainFederation, or socialIdentitySource. Nullable.
internalSponsors	array
modifiedDateTime	string (date-time)	The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. 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])$)
state		The state of a connected organization defines whether assignment policies with requestor scope type AllConfiguredConnectedOrganizationSubjects are applicable or not. The possible values are: configured, proposed, unknownFutureValue.

list

Retrieved collection

Name	Datatype	Description
id	string	The unique identifier for an entity. Read-only.
createdDateTime	string (date-time)	The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. 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])$)
description	string	The description of the connected organization.
displayName	string	The display name of the connected organization. Supports $filter (eq).
externalSponsors	array
identitySources	array	The identity sources in this connected organization, one of azureActiveDirectoryTenant, crossCloudAzureActiveDirectoryTenant, domainIdentitySource, externalDomainFederation, or socialIdentitySource. Nullable.
internalSponsors	array
modifiedDateTime	string (date-time)	The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. 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])$)
state		The state of a connected organization defines whether assignment policies with requestor scope type AllConfiguredConnectedOrganizationSubjects are applicable or not. The possible values are: configured, proposed, unknownFutureValue.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	connected_organization_id		Retrieve the properties and relationships of a connectedOrganization object.
list	select			Retrieve a list of connectedOrganization objects.
insert	insert			Create a new connectedOrganization object.
update	update	connected_organization_id		Update a connectedOrganization object to change one or more of its properties.
delete	delete	connected_organization_id	If-Match	Delete a connectedOrganization object.

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

SELECT examples

get

Retrieve the properties and relationships of a connectedOrganization object.

SELECT
id,
createdDateTime,
description,
displayName,
externalSponsors,
identitySources,
internalSponsors,
modifiedDateTime,
state
FROM entra_id.identity_governance.entitlement_management_connected_organizations
WHERE connected_organization_id = '{{ connected_organization_id }}' -- required
;

list

Retrieve a list of connectedOrganization objects.

SELECT
id,
createdDateTime,
description,
displayName,
externalSponsors,
identitySources,
internalSponsors,
modifiedDateTime,
state
FROM entra_id.identity_governance.entitlement_management_connected_organizations
;

INSERT examples

insert

Create a new connectedOrganization object.

INSERT INTO entra_id.identity_governance.entitlement_management_connected_organizations (
id,
createdDateTime,
description,
displayName,
identitySources,
modifiedDateTime,
state,
externalSponsors,
internalSponsors
)
SELECT 
'{{ id }}',
'{{ createdDateTime }}',
'{{ description }}',
'{{ displayName }}',
'{{ identitySources }}',
'{{ modifiedDateTime }}',
'{{ state }}',
'{{ externalSponsors }}',
'{{ internalSponsors }}'
RETURNING
id,
createdDateTime,
description,
displayName,
externalSponsors,
identitySources,
internalSponsors,
modifiedDateTime,
state
;

Manifest

# Description fields are for documentation purposes
- name: entitlement_management_connected_organizations
props:
  - name: id
    value: "{{ id }}"
    description: |
      The unique identifier for an entity. Read-only.
  - name: createdDateTime
    value: "{{ createdDateTime }}"
    description: |
      The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. Read-only.
  - name: description
    value: "{{ description }}"
    description: |
      The description of the connected organization.
  - name: displayName
    value: "{{ displayName }}"
    description: |
      The display name of the connected organization. Supports $filter (eq).
  - name: identitySources
    description: |
      The identity sources in this connected organization, one of azureActiveDirectoryTenant, crossCloudAzureActiveDirectoryTenant, domainIdentitySource, externalDomainFederation, or socialIdentitySource. Nullable.
    value:
  - name: modifiedDateTime
    value: "{{ modifiedDateTime }}"
    description: |
      The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. Read-only.
  - name: state
    value: "{{ state }}"
    description: |
      The state of a connected organization defines whether assignment policies with requestor scope type AllConfiguredConnectedOrganizationSubjects are applicable or not.  The possible values are: configured, proposed, unknownFutureValue.
  - name: externalSponsors
    value:
      - id: "{{ id }}"
        deletedDateTime: "{{ deletedDateTime }}"
  - name: internalSponsors
    value:
      - id: "{{ id }}"
        deletedDateTime: "{{ deletedDateTime }}"

UPDATE examples

update

Update a connectedOrganization object to change one or more of its properties.

UPDATE entra_id.identity_governance.entitlement_management_connected_organizations
SET 
id = '{{ id }}',
createdDateTime = '{{ createdDateTime }}',
description = '{{ description }}',
displayName = '{{ displayName }}',
identitySources = '{{ identitySources }}',
modifiedDateTime = '{{ modifiedDateTime }}',
state = '{{ state }}',
externalSponsors = '{{ externalSponsors }}',
internalSponsors = '{{ internalSponsors }}'
WHERE 
connected_organization_id = '{{ connected_organization_id }}' --required
RETURNING
id,
createdDateTime,
description,
displayName,
externalSponsors,
identitySources,
internalSponsors,
modifiedDateTime,
state;

DELETE examples

delete

Delete a connectedOrganization object.

DELETE FROM entra_id.identity_governance.entitlement_management_connected_organizations
WHERE connected_organization_id = '{{ connected_organization_id }}' --required
AND If-Match = '{{ If-Match }}'
;