Edit

Share via

Add-EntraCustomSecurityAttributeDefinitionAllowedValue

  • Reference
Module:
Microsoft.Graph.Entra

Adds a predefined value for a custom security attribute definition.

Syntax

Add-EntraCustomSecurityAttributeDefinitionAllowedValue
   -CustomSecurityAttributeDefinitionId <String>
   -Id <String>
   -IsActive <Boolean>
   [<CommonParameters>]

Description

The Add-EntraCustomSecurityAttributeDefinitionAllowedValue adds a predefined value for a Microsoft Entra ID custom security attribute definition.

In delegated scenarios with work or school accounts, the signed-in user must be assigned a supported Microsoft Entra role or a custom role with the necessary permissions. The Attribute Definition Administrator is the only privileged role supported for this operation.

Examples

Example 1: Add a predefined value for a Microsoft Entra ID custom security attribute definition

Connect-Entra -Scopes 'CustomSecAttributeDefinition.ReadWrite.All'
$CustomSecurityAttributeDefinitionId = (Get-EntraCustomSecurityAttributeDefinition -Id '<attributename_attributedefinition>').Id
$params = @{
    CustomSecurityAttributeDefinitionId = $CustomSecurityAttributeDefinitionId
    Id = 'Alpine'
    IsActive = $true
}
Add-EntraCustomSecurityAttributeDefinitionAllowedValue @params

Id   IsActive
--   --------
Alpine True

This example adds a predefined value to a custom security attribute definition.

  • -CustomSecurityAttributeDefinitionId parameter specifies the custom security attribute definition ID. You can use the command Get-EntraCustomSecurityAttributeDefinition to get the ID.
  • -Id parameter specifies the identifier for the predefined value.
  • -IsActive parameter specifies the predefined value is active or deactivated.

Parameters

-CustomSecurityAttributeDefinitionId

The unique identifier for a custom security attribute definition in Microsoft Entra ID.

Type:System.String
Position:Named
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-Id

The unique identifier for the predefined value, which can be up to 64 characters long and include Unicode characters. Spaces are allowed, but some special characters aren't. This identifier is case sensitive, can't be changed later, and is required.

Type:System.String
Position:Named
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

-IsActive

Indicates whether the predefined value is active or deactivated. If set to false, this predefined value can't be assigned to any another supported directory objects.

Type:System.Boolean
Position:Named
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

Inputs

System.String

Outputs

System.Object

Notes

Add-EntraCustomSecurityAttributeDefinitionAllowedValues is an alias for Add-EntraCustomSecurityAttributeDefinitionAllowedValue.