custom_authentication_extensions

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

Overview

Name	custom_authentication_extensions
Type	Resource
Id	entra_id.identity.custom_authentication_extensions

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.
authenticationConfiguration		Configuration for securing the API call to the logic app. For example, using OAuth client credentials flow.
behaviorOnError		The behaviour on error for the custom authentication extension.
clientConfiguration		HTTP connection settings that define how long Microsoft Entra ID can wait for a connection to a logic app, how many times you can retry a timed-out connection and the exception scenarios when retries are allowed.
description	string	Description for the customCalloutExtension object.
displayName	string	Display name for the customCalloutExtension object.
endpointConfiguration		The type and details for configuring the endpoint to call the logic app's workflow.

list

Retrieved collection

Name	Datatype	Description
id	string	The unique identifier for an entity. Read-only.
authenticationConfiguration		Configuration for securing the API call to the logic app. For example, using OAuth client credentials flow.
behaviorOnError		The behaviour on error for the custom authentication extension.
clientConfiguration		HTTP connection settings that define how long Microsoft Entra ID can wait for a connection to a logic app, how many times you can retry a timed-out connection and the exception scenarios when retries are allowed.
description	string	Description for the customCalloutExtension object.
displayName	string	Display name for the customCalloutExtension object.
endpointConfiguration		The type and details for configuring the endpoint to call the logic app's workflow.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	custom_authentication_extension_id		Read the properties and relationships of a customAuthenticationExtension object. The following derived types are currently supported.
list	select			Get a list of the customAuthenticationExtension objects and their properties. The following derived types are supported.
insert	insert			Create a new customAuthenticationExtension object. The following derived types are currently supported.
update	update	custom_authentication_extension_id		Update the properties of a customAuthenticationExtension object. The following derived types are currently supported.
delete	delete	custom_authentication_extension_id	If-Match	Delete a customAuthenticationExtension object. The following derived types are currently supported.
validate_authentication_configuration	exec
validate_authentication_configuration_2	exec	custom_authentication_extension_id		An API to check validity of the endpoint and and authentication configuration for a customAuthenticationExtension object, which can represent one of the following derived types:

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

SELECT examples

get

Read the properties and relationships of a customAuthenticationExtension object. The following derived types are currently supported.

SELECT
id,
authenticationConfiguration,
behaviorOnError,
clientConfiguration,
description,
displayName,
endpointConfiguration
FROM entra_id.identity.custom_authentication_extensions
WHERE custom_authentication_extension_id = '{{ custom_authentication_extension_id }}' -- required
;

list

Get a list of the customAuthenticationExtension objects and their properties. The following derived types are supported.

SELECT
id,
authenticationConfiguration,
behaviorOnError,
clientConfiguration,
description,
displayName,
endpointConfiguration
FROM entra_id.identity.custom_authentication_extensions
;

INSERT examples

insert

Create a new customAuthenticationExtension object. The following derived types are currently supported.

INSERT INTO entra_id.identity.custom_authentication_extensions (
id,
authenticationConfiguration,
clientConfiguration,
description,
displayName,
endpointConfiguration,
behaviorOnError
)
SELECT 
'{{ id }}',
'{{ authenticationConfiguration }}',
'{{ clientConfiguration }}',
'{{ description }}',
'{{ displayName }}',
'{{ endpointConfiguration }}',
'{{ behaviorOnError }}'
RETURNING
id,
authenticationConfiguration,
behaviorOnError,
clientConfiguration,
description,
displayName,
endpointConfiguration
;

Manifest

# Description fields are for documentation purposes
- name: custom_authentication_extensions
props:
  - name: id
    value: "{{ id }}"
    description: |
      The unique identifier for an entity. Read-only.
  - name: authenticationConfiguration
    value: "{{ authenticationConfiguration }}"
    description: |
      Configuration for securing the API call to the logic app. For example, using OAuth client credentials flow.
  - name: clientConfiguration
    value: "{{ clientConfiguration }}"
    description: |
      HTTP connection settings that define how long Microsoft Entra ID can wait for a connection to a logic app, how many times you can retry a timed-out connection and the exception scenarios when retries are allowed.
  - name: description
    value: "{{ description }}"
    description: |
      Description for the customCalloutExtension object.
  - name: displayName
    value: "{{ displayName }}"
    description: |
      Display name for the customCalloutExtension object.
  - name: endpointConfiguration
    value: "{{ endpointConfiguration }}"
    description: |
      The type and details for configuring the endpoint to call the logic app's workflow.
  - name: behaviorOnError
    value: "{{ behaviorOnError }}"
    description: |
      The behaviour on error for the custom authentication extension.

UPDATE examples

update

Update the properties of a customAuthenticationExtension object. The following derived types are currently supported.

UPDATE entra_id.identity.custom_authentication_extensions
SET 
id = '{{ id }}',
authenticationConfiguration = '{{ authenticationConfiguration }}',
clientConfiguration = '{{ clientConfiguration }}',
description = '{{ description }}',
displayName = '{{ displayName }}',
endpointConfiguration = '{{ endpointConfiguration }}',
behaviorOnError = '{{ behaviorOnError }}'
WHERE 
custom_authentication_extension_id = '{{ custom_authentication_extension_id }}' --required
RETURNING
id,
authenticationConfiguration,
behaviorOnError,
clientConfiguration,
description,
displayName,
endpointConfiguration;

DELETE examples

delete

Delete a customAuthenticationExtension object. The following derived types are currently supported.

DELETE FROM entra_id.identity.custom_authentication_extensions
WHERE custom_authentication_extension_id = '{{ custom_authentication_extension_id }}' --required
AND If-Match = '{{ If-Match }}'
;

Lifecycle Methods

validate_authentication_configuration

Success

EXEC entra_id.identity.custom_authentication_extensions.validate_authentication_configuration 
@@json=
'{
"endpointConfiguration": "{{ endpointConfiguration }}", 
"authenticationConfiguration": "{{ authenticationConfiguration }}"
}'
;

validate_authentication_configuration_2

An API to check validity of the endpoint and and authentication configuration for a customAuthenticationExtension object, which can represent one of the following derived types:

EXEC entra_id.identity.custom_authentication_extensions.validate_authentication_configuration_2 
@custom_authentication_extension_id='{{ custom_authentication_extension_id }}' --required
;