custom_security_attribute_definitions_allowed_values

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

Overview

Name	custom_security_attribute_definitions_allowed_values
Type	Resource
Id	entra_id.directory.custom_security_attribute_definitions_allowed_values

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.
isActive	boolean	Indicates whether the predefined value is active or deactivated. If set to false, this predefined value can't be assigned to any other supported directory objects.

list

Retrieved collection

Name	Datatype	Description
id	string	The unique identifier for an entity. Read-only.
isActive	boolean	Indicates whether the predefined value is active or deactivated. If set to false, this predefined value can't be assigned to any other supported directory objects.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	custom_security_attribute_definition_id, allowed_value_id		Read the properties and relationships of an allowedValue object.
list	select	custom_security_attribute_definition_id		Get a list of the allowedValue objects and their properties.
insert	insert	custom_security_attribute_definition_id		Create a new allowedValue object.
update	update	custom_security_attribute_definition_id, allowed_value_id		Update the properties of an allowedValue object.
delete	delete	custom_security_attribute_definition_id, allowed_value_id	If-Match

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
allowed_value_id	string	The unique identifier of allowedValue
custom_security_attribute_definition_id	string	The unique identifier of customSecurityAttributeDefinition
If-Match	string	ETag

SELECT examples

get

Read the properties and relationships of an allowedValue object.

SELECT
id,
isActive
FROM entra_id.directory.custom_security_attribute_definitions_allowed_values
WHERE custom_security_attribute_definition_id = '{{ custom_security_attribute_definition_id }}' -- required
AND allowed_value_id = '{{ allowed_value_id }}' -- required
;

list

Get a list of the allowedValue objects and their properties.

SELECT
id,
isActive
FROM entra_id.directory.custom_security_attribute_definitions_allowed_values
WHERE custom_security_attribute_definition_id = '{{ custom_security_attribute_definition_id }}' -- required
;

INSERT examples

insert

Create a new allowedValue object.

INSERT INTO entra_id.directory.custom_security_attribute_definitions_allowed_values (
id,
isActive,
custom_security_attribute_definition_id
)
SELECT 
'{{ id }}',
{{ isActive }},
'{{ custom_security_attribute_definition_id }}'
RETURNING
id,
isActive
;

Manifest

# Description fields are for documentation purposes
- name: custom_security_attribute_definitions_allowed_values
props:
  - name: custom_security_attribute_definition_id
    value: "{{ custom_security_attribute_definition_id }}"
    description: Required parameter for the custom_security_attribute_definitions_allowed_values resource.
  - name: id
    value: "{{ id }}"
    description: |
      The unique identifier for an entity. Read-only.
  - name: isActive
    value: {{ isActive }}
    description: |
      Indicates whether the predefined value is active or deactivated. If set to false, this predefined value can't be assigned to any other supported directory objects.

UPDATE examples

update

Update the properties of an allowedValue object.

UPDATE entra_id.directory.custom_security_attribute_definitions_allowed_values
SET 
id = '{{ id }}',
isActive = {{ isActive }}
WHERE 
custom_security_attribute_definition_id = '{{ custom_security_attribute_definition_id }}' --required
AND allowed_value_id = '{{ allowed_value_id }}' --required
RETURNING
id,
isActive;

DELETE examples

delete

No description available.

DELETE FROM entra_id.directory.custom_security_attribute_definitions_allowed_values
WHERE custom_security_attribute_definition_id = '{{ custom_security_attribute_definition_id }}' --required
AND allowed_value_id = '{{ allowed_value_id }}' --required
AND If-Match = '{{ If-Match }}'
;