conditional_access_authentication_context_class_references

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

Overview

Name	conditional_access_authentication_context_class_references
Type	Resource
Id	entra_id.identity.conditional_access_authentication_context_class_references

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.
description	string	A short explanation of the policies that are enforced by authenticationContextClassReference. This value should be used to provide secondary text to describe the authentication context class reference when building user-facing admin experiences. For example, a selection UX.
displayName	string	The display name is the friendly name of the authenticationContextClassReference object. This value should be used to identify the authentication context class reference when building user-facing admin experiences. For example, a selection UX.
isAvailable	boolean	Indicates whether the authenticationContextClassReference has been published by the security admin and is ready for use by apps. When it's set to false, it shouldn't be shown in authentication context selection UX, or used to protect app resources. It's shown and available for Conditional Access policy authoring. The default value is false. Supports $filter (eq).

list

Retrieved collection

Name	Datatype	Description
id	string	The unique identifier for an entity. Read-only.
description	string	A short explanation of the policies that are enforced by authenticationContextClassReference. This value should be used to provide secondary text to describe the authentication context class reference when building user-facing admin experiences. For example, a selection UX.
displayName	string	The display name is the friendly name of the authenticationContextClassReference object. This value should be used to identify the authentication context class reference when building user-facing admin experiences. For example, a selection UX.
isAvailable	boolean	Indicates whether the authenticationContextClassReference has been published by the security admin and is ready for use by apps. When it's set to false, it shouldn't be shown in authentication context selection UX, or used to protect app resources. It's shown and available for Conditional Access policy authoring. The default value is false. Supports $filter (eq).

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	authentication_context_class_reference_id		Retrieve the properties and relationships of a authenticationContextClassReference object.
list	select			Retrieve a list of authenticationContextClassReference objects.
insert	insert
update	update	authentication_context_class_reference_id		Create an authenticationContextClassReference object, if the ID has not been used. If ID has been used, this call updates the authenticationContextClassReference object.
delete	delete	authentication_context_class_reference_id	If-Match	Delete an authenticationContextClassReference object that's not published or used by a conditional access policy.

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

SELECT examples

get

Retrieve the properties and relationships of a authenticationContextClassReference object.

SELECT
id,
description,
displayName,
isAvailable
FROM entra_id.identity.conditional_access_authentication_context_class_references
WHERE authentication_context_class_reference_id = '{{ authentication_context_class_reference_id }}' -- required
;

list

Retrieve a list of authenticationContextClassReference objects.

SELECT
id,
description,
displayName,
isAvailable
FROM entra_id.identity.conditional_access_authentication_context_class_references
;

INSERT examples

insert

No description available.

INSERT INTO entra_id.identity.conditional_access_authentication_context_class_references (
id,
description,
displayName,
isAvailable
)
SELECT 
'{{ id }}',
'{{ description }}',
'{{ displayName }}',
{{ isAvailable }}
RETURNING
id,
description,
displayName,
isAvailable
;

Manifest

# Description fields are for documentation purposes
- name: conditional_access_authentication_context_class_references
props:
  - name: id
    value: "{{ id }}"
    description: |
      The unique identifier for an entity. Read-only.
  - name: description
    value: "{{ description }}"
    description: |
      A short explanation of the policies that are enforced by authenticationContextClassReference. This value should be used to provide secondary text to describe the authentication context class reference when building user-facing admin experiences. For example, a selection UX.
  - name: displayName
    value: "{{ displayName }}"
    description: |
      The display name is the friendly name of the authenticationContextClassReference object. This value should be used to identify the authentication context class reference when building user-facing admin experiences. For example, a selection UX.
  - name: isAvailable
    value: {{ isAvailable }}
    description: |
      Indicates whether the authenticationContextClassReference has been published by the security admin and is ready for use by apps. When it's set to false, it shouldn't be shown in authentication context selection UX, or used to protect app resources. It's shown and available for Conditional Access policy authoring. The default value is false.  Supports $filter (eq).

UPDATE examples

update

Create an authenticationContextClassReference object, if the ID has not been used. If ID has been used, this call updates the authenticationContextClassReference object.

UPDATE entra_id.identity.conditional_access_authentication_context_class_references
SET 
id = '{{ id }}',
description = '{{ description }}',
displayName = '{{ displayName }}',
isAvailable = {{ isAvailable }}
WHERE 
authentication_context_class_reference_id = '{{ authentication_context_class_reference_id }}' --required
RETURNING
id,
description,
displayName,
isAvailable;

DELETE examples

delete

Delete an authenticationContextClassReference object that's not published or used by a conditional access policy.

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