federation_configurations

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

Overview

Name	federation_configurations
Type	Resource
Id	entra_id.directory.federation_configurations

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.
displayName	string	The display name of the identity provider.

list

Retrieved collection

Name	Datatype	Description
id	string	The unique identifier for an entity. Read-only.
displayName	string	The display name of the identity provider.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	identity_provider_base_id		Configure domain federation with organizations whose identity provider (IdP) supports either the SAML or WS-Fed protocol.
list	select			Configure domain federation with organizations whose identity provider (IdP) supports either the SAML or WS-Fed protocol.
insert	insert
update	update	identity_provider_base_id
delete	delete	identity_provider_base_id	If-Match	Delete a samlOrWsFedExternalDomainFederation 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
identity_provider_base_id	string	The unique identifier of identityProviderBase
If-Match	string	ETag

SELECT examples

get

Configure domain federation with organizations whose identity provider (IdP) supports either the SAML or WS-Fed protocol.

SELECT
id,
displayName
FROM entra_id.directory.federation_configurations
WHERE identity_provider_base_id = '{{ identity_provider_base_id }}' -- required
;

list

Configure domain federation with organizations whose identity provider (IdP) supports either the SAML or WS-Fed protocol.

SELECT
id,
displayName
FROM entra_id.directory.federation_configurations
;

INSERT examples

insert

No description available.

INSERT INTO entra_id.directory.federation_configurations (
id,
displayName
)
SELECT 
'{{ id }}',
'{{ displayName }}'
RETURNING
id,
displayName
;

Manifest

# Description fields are for documentation purposes
- name: federation_configurations
props:
  - name: id
    value: "{{ id }}"
    description: |
      The unique identifier for an entity. Read-only.
  - name: displayName
    value: "{{ displayName }}"
    description: |
      The display name of the identity provider.

UPDATE examples

update

No description available.

UPDATE entra_id.directory.federation_configurations
SET 
id = '{{ id }}',
displayName = '{{ displayName }}'
WHERE 
identity_provider_base_id = '{{ identity_provider_base_id }}' --required
RETURNING
id,
displayName;

DELETE examples

delete

Delete a samlOrWsFedExternalDomainFederation object.

DELETE FROM entra_id.directory.federation_configurations
WHERE identity_provider_base_id = '{{ identity_provider_base_id }}' --required
AND If-Match = '{{ If-Match }}'
;