title	Update customSecurityAttributeDefinition
description	Update the properties of a customSecurityAttributeDefinition object.
author	rolyon
ms.localizationpriority	medium
ms.subservice	entra-directory-management
doc_type	apiPageType
ms.date	04/05/2024

Update customSecurityAttributeDefinition

Namespace: microsoft.graph

[!INCLUDE beta-disclaimer]

Update the properties of a customSecurityAttributeDefinition object.

[!INCLUDE national-cloud-support]

Permissions

Choose the permission or permissions marked as least privileged for this API. Use a higher privileged permission or permissions only if your app requires it. For details about delegated and application permissions, see Permission types. To learn more about these permissions, see the permissions reference.

[!INCLUDE permissions-table]

[!INCLUDE rbac-customsecurityattibutes-apis-write]

HTTP request

PATCH /directory/customSecurityAttributeDefinitions/{customSecurityAttributeDefinitionId}

Request headers

Name	Description
Authorization	Bearer {token}. Required. Learn more about authentication and authorization.
Content-Type	application/json. Required.
OData-Version	4.01. Optional.

Note

To update the predefined values for a custom security attribute, you must add the OData-Version header and assign it the value 4.01.

Request body

[!INCLUDE table-intro]

Property	Type	Description
description	String	Description of the custom security attribute. Can be up to 128 characters long and include Unicode characters. Optional.
status	String	Specifies whether the custom security attribute is active or deactivated. Acceptable values are `Available` and `Deprecated`. Optional.
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 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`. Optional.

Response

If successful, this method returns a 204 No Content response code.

Examples

Example 1: Update a custom security attribute

The following example updates the description for a custom security attribute definition.

Attribute set: Engineering
Attribute: ProjectDate

Request

The following example shows a request.

HTTP

PATCH https://graph.microsoft.com/beta/directory/customSecurityAttributeDefinitions/Engineering_ProjectDate
Content-Type: application/json

{
  "description": "Target completion date (YYYY/MM/DD)",
}

C#

[!INCLUDE sample-code] [!INCLUDE sdk-documentation]

Go

[!INCLUDE sample-code] [!INCLUDE sdk-documentation]

Java

[!INCLUDE sample-code] [!INCLUDE sdk-documentation]

JavaScript

[!INCLUDE sample-code] [!INCLUDE sdk-documentation]

PHP

[!INCLUDE sample-code] [!INCLUDE sdk-documentation]

PowerShell

[!INCLUDE sample-code] [!INCLUDE sdk-documentation]

Python

[!INCLUDE sample-code] [!INCLUDE sdk-documentation]

Response

The following example shows the response.

HTTP/1.1 204 No Content

Example 2: Update the predefined values for a custom security attribute

The following example updates the status of an existing predefined value and adds a new predefined value for a custom security attribute definition.

Attribute set: Engineering
Attribute: Project
Attribute data type: Collection of Strings
Update predefined value: Baker
New predefined value: Skagit

Note

For this request, you must add the OData-Version header and assign it the value 4.01.

Request

The following example shows a request.

HTTP

PATCH https://graph.microsoft.com/beta/directory/customSecurityAttributeDefinitions/Engineering_Project
Content-Type: application/json
OData-Version: 4.01

{
    "allowedValues@delta": [
        {
            "id": "Baker",
            "isActive": false
        },
        {
            "id": "Skagit",
            "isActive": true
        }
    ]
}

C#

[!INCLUDE sample-code] [!INCLUDE sdk-documentation]

Go

[!INCLUDE snippet-not-available] [!INCLUDE sdk-documentation]

Java

[!INCLUDE sample-code] [!INCLUDE sdk-documentation]

JavaScript

[!INCLUDE sample-code] [!INCLUDE sdk-documentation]

PHP

[!INCLUDE sample-code] [!INCLUDE sdk-documentation]

PowerShell

[!INCLUDE sample-code] [!INCLUDE sdk-documentation]

Python

[!INCLUDE sample-code] [!INCLUDE sdk-documentation]

Response

The following example shows the response.

HTTP/1.1 204 No Content

Example 3: Deactivate a custom security attribute

The following example deactivates a custom security attribute definition.

Attribute set: Engineering
Attribute: Project

Request

The following example shows a request.

HTTP

PATCH https://graph.microsoft.com/beta/directory/customSecurityAttributeDefinitions/Engineering_Project
Content-Type: application/json

{
  "status": "Deprecated"
}