Edit

Share via

Set-EntraCustomSecurityAttributeDefinition

  • Reference
Module:
Microsoft.Graph.Entra

Update the properties of a customSecurityAttributeDefinition object.

Syntax

Set-EntraCustomSecurityAttributeDefinition
   -Id <String>
   [-Description <String>]
   [-Status <String>]
   [-UsePreDefinedValuesOnly <Boolean>]
   [<CommonParameters>]

Description

Update the properties of a customSecurityAttributeDefinition object. Specify Id parameter to update a 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: Update a custom security attribute

Connect-Entra -Scopes 'CustomSecAttributeDefinition.Read.All', 'CustomSecAttributeDefinition.ReadWrite.All'
$params = @{
    Id = 'Engineering_ProjectDate'
    Description = 'Add-description'
    Status = 'Available' 
    UsePreDefinedValuesOnly = $False
}
Set-EntraCustomSecurityAttributeDefinition @params

This example update a custom security attribute.

  • -Id parameter specifies the custom security attribute definition object ID.
  • -Description parameter specifies the description of the custom security attribute.
  • -Status parameter specifies the custom security attribute is active or deactivated.
  • -UsePreDefinedValuesOnly parameter specifies the only predefined values can be assigned to the custom security attribute.

Parameters

-Description

Description of the custom security attribute, up to 128 characters long and including Unicode characters. This description can be changed later.

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

-Id

The unique identifier of a Microsoft Entra ID custom security attribute definition object.

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

-Status

Specifies whether the custom security attribute is active or deactivated. Acceptable values are: Available and Deprecated. Can be changed later.

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

-UsePreDefinedValuesOnly

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 can't be changed from false to true. If type is set to Boolean, usePreDefinedValuesOnly can't be set to true.

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

Inputs

System.String

Outputs

System.Object