custom_security_attribute_definitions

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

Overview

Name	custom_security_attribute_definitions
Type	Resource
Id	entra_id.directory.custom_security_attribute_definitions

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.
name	string	Name of the custom security attribute. Must be unique within an attribute set. Can be up to 32 characters long and include Unicode characters. Cannot contain spaces or special characters. Cannot be changed later. Case insensitive.
allowedValues	array	Values that are predefined for this custom security attribute. This navigation property is not returned by default and must be specified in an $expand query. For example, /directory/customSecurityAttributeDefinitions?$expand=allowedValues.
attributeSet	string	Name of the attribute set. Case insensitive.
description	string	Description of the custom security attribute. Can be up to 128 characters long and include Unicode characters. Can be changed later.
isCollection	boolean	Indicates whether multiple values can be assigned to the custom security attribute. Cannot be changed later. If type is set to Boolean, isCollection cannot be set to true.
isSearchable	boolean	Indicates whether custom security attribute values are indexed for searching on objects that are assigned attribute values. Cannot be changed later.
status	string	Specifies whether the custom security attribute is active or deactivated. Acceptable values are: Available and Deprecated. Can be changed later.
type	string	Data type for the custom security attribute values. Supported types are: Boolean, Integer, and String. Cannot be changed later.
usePreDefinedValuesOnly	boolean	Indicates whether only predefined values can be assigned to the custom security attribute. If set to false, free-form values are allowed. Can later be changed from true to false, but cannot be changed from false to true. If type is set to Boolean, usePreDefinedValuesOnly cannot be set to true.

list

Retrieved collection

Name	Datatype	Description
id	string	The unique identifier for an entity. Read-only.
name	string	Name of the custom security attribute. Must be unique within an attribute set. Can be up to 32 characters long and include Unicode characters. Cannot contain spaces or special characters. Cannot be changed later. Case insensitive.
allowedValues	array	Values that are predefined for this custom security attribute. This navigation property is not returned by default and must be specified in an $expand query. For example, /directory/customSecurityAttributeDefinitions?$expand=allowedValues.
attributeSet	string	Name of the attribute set. Case insensitive.
description	string	Description of the custom security attribute. Can be up to 128 characters long and include Unicode characters. Can be changed later.
isCollection	boolean	Indicates whether multiple values can be assigned to the custom security attribute. Cannot be changed later. If type is set to Boolean, isCollection cannot be set to true.
isSearchable	boolean	Indicates whether custom security attribute values are indexed for searching on objects that are assigned attribute values. Cannot be changed later.
status	string	Specifies whether the custom security attribute is active or deactivated. Acceptable values are: Available and Deprecated. Can be changed later.
type	string	Data type for the custom security attribute values. Supported types are: Boolean, Integer, and String. Cannot be changed later.
usePreDefinedValuesOnly	boolean	Indicates whether only predefined values can be assigned to the custom security attribute. If set to false, free-form values are allowed. Can later be changed from true to false, but cannot be changed from false to true. If type is set to Boolean, usePreDefinedValuesOnly cannot be set to true.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	custom_security_attribute_definition_id		Read the properties and relationships of a customSecurityAttributeDefinition object.
list	select			Get a list of the customSecurityAttributeDefinition objects and their properties.
insert	insert			Create a new customSecurityAttributeDefinition object.
update	update	custom_security_attribute_definition_id		Update the properties of a customSecurityAttributeDefinition object.
delete	delete	custom_security_attribute_definition_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
custom_security_attribute_definition_id	string	The unique identifier of customSecurityAttributeDefinition
If-Match	string	ETag

SELECT examples

get

Read the properties and relationships of a customSecurityAttributeDefinition object.

SELECT
id,
name,
allowedValues,
attributeSet,
description,
isCollection,
isSearchable,
status,
type,
usePreDefinedValuesOnly
FROM entra_id.directory.custom_security_attribute_definitions
WHERE custom_security_attribute_definition_id = '{{ custom_security_attribute_definition_id }}' -- required
;

list

Get a list of the customSecurityAttributeDefinition objects and their properties.

SELECT
id,
name,
allowedValues,
attributeSet,
description,
isCollection,
isSearchable,
status,
type,
usePreDefinedValuesOnly
FROM entra_id.directory.custom_security_attribute_definitions
;

INSERT examples

insert

Create a new customSecurityAttributeDefinition object.

INSERT INTO entra_id.directory.custom_security_attribute_definitions (
id,
attributeSet,
description,
isCollection,
isSearchable,
name,
status,
type,
usePreDefinedValuesOnly,
allowedValues
)
SELECT 
'{{ id }}',
'{{ attributeSet }}',
'{{ description }}',
{{ isCollection }},
{{ isSearchable }},
'{{ name }}',
'{{ status }}',
'{{ type }}',
{{ usePreDefinedValuesOnly }},
'{{ allowedValues }}'
RETURNING
id,
name,
allowedValues,
attributeSet,
description,
isCollection,
isSearchable,
status,
type,
usePreDefinedValuesOnly
;

Manifest

# Description fields are for documentation purposes
- name: custom_security_attribute_definitions
props:
  - name: id
    value: "{{ id }}"
    description: |
      The unique identifier for an entity. Read-only.
  - name: attributeSet
    value: "{{ attributeSet }}"
    description: |
      Name of the attribute set. Case insensitive.
  - name: description
    value: "{{ description }}"
    description: |
      Description of the custom security attribute. Can be up to 128 characters long and include Unicode characters. Can be changed later.
  - name: isCollection
    value: {{ isCollection }}
    description: |
      Indicates whether multiple values can be assigned to the custom security attribute. Cannot be changed later. If type is set to Boolean, isCollection cannot be set to true.
  - name: isSearchable
    value: {{ isSearchable }}
    description: |
      Indicates whether custom security attribute values are indexed for searching on objects that are assigned attribute values. Cannot be changed later.
  - name: name
    value: "{{ name }}"
    description: |
      Name of the custom security attribute. Must be unique within an attribute set. Can be up to 32 characters long and include Unicode characters. Cannot contain spaces or special characters. Cannot be changed later. Case insensitive.
  - name: status
    value: "{{ status }}"
    description: |
      Specifies whether the custom security attribute is active or deactivated. Acceptable values are: Available and Deprecated. Can be changed later.
  - name: type
    value: "{{ type }}"
    description: |
      Data type for the custom security attribute values. Supported types are: Boolean, Integer, and String. Cannot be changed later.
  - name: usePreDefinedValuesOnly
    value: {{ usePreDefinedValuesOnly }}
    description: |
      Indicates whether only predefined values can be assigned to the custom security attribute. If set to false, free-form values are allowed. Can later be changed from true to false, but cannot be changed from false to true. If type is set to Boolean, usePreDefinedValuesOnly cannot be set to true.
  - name: allowedValues
    description: |
      Values that are predefined for this custom security attribute. This navigation property is not returned by default and must be specified in an $expand query. For example, /directory/customSecurityAttributeDefinitions?$expand=allowedValues.
    value:
      - id: "{{ id }}"
        isActive: {{ isActive }}

UPDATE examples

update

Update the properties of a customSecurityAttributeDefinition object.

UPDATE entra_id.directory.custom_security_attribute_definitions
SET 
id = '{{ id }}',
attributeSet = '{{ attributeSet }}',
description = '{{ description }}',
isCollection = {{ isCollection }},
isSearchable = {{ isSearchable }},
name = '{{ name }}',
status = '{{ status }}',
type = '{{ type }}',
usePreDefinedValuesOnly = {{ usePreDefinedValuesOnly }},
allowedValues = '{{ allowedValues }}'
WHERE 
custom_security_attribute_definition_id = '{{ custom_security_attribute_definition_id }}' --required
RETURNING
id,
name,
allowedValues,
attributeSet,
description,
isCollection,
isSearchable,
status,
type,
usePreDefinedValuesOnly;

DELETE examples

delete

No description available.

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