Create profileCardProperty

Namespace: microsoft.graph

Important

APIs under the /beta version in Microsoft Graph are subject to change. Use of these APIs in production applications is not supported. To determine whether an API is available in v1.0, use the Version selector.

Create a new profileCardProperty for an organization. The new property is identified by its directoryPropertyName property.

For more information about how to add properties to the profile card for an organization, see Add or remove custom attributes on a profile card using the profile card API.

Note

Profile card properties correspond to attributes in Microsoft Entra ID. Adding an attribute as a profileCardProperty to the profileCardProperties collection for an organization configures profile cards to display the attribute value. Deleting the profileCardProperty from the collection doesn’t delete the attribute from Microsoft Entra ID; it deletes the configuration so that profile cards no longer display the attribute value.

This API is available in the following national cloud deployments.

Global service US Government L4 US Government L5 (DOD) China operated by 21Vianet

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.

Permission type Least privileged permissions Higher privileged permissions
Delegated (work or school account) PeopleSettings.ReadWrite.All Not available.
Delegated (personal Microsoft account) Not supported. Not supported.
Application Not supported. Not supported.

Note: Using delegated permissions for this operation requires the signed-in user to have a Tenant Administrator role.

HTTP request

POST /admin/people/profileCardProperties

Note: The /organization/{organizationId}/settings path is deprecated. Going forward, use the /admin/people path.

Request headers

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

Note: To avoid encoding issues that malform the payload, use Content-Type: application/json; charset=utf-8.

Request body

In the request body, supply a JSON representation of a profileCardProperty object.

You can specify the following properties when you create a profileCardProperty for an organization.

Property Type Description
annotations profileCardAnnotation collection Any alternative or localized labels that an administrator chose to specify.
directoryPropertyName String The name of the directory property that is intended to surface on the profile card.

Response

If successful, this method returns a 201 Created response code and a new profileCardProperty object in the response body.

Examples

Request

The following example shows a request.

POST https://graph.microsoft.com/beta/admin/people/profileCardProperties
Content-type: application/json; charset=utf-8

{
  "directoryPropertyName": "CustomAttribute1",
  "annotations": [
    {
      "displayName": "Cost Center",
      "localizations": [
        {
          "languageTag": "ru",
          "displayName": "центр затрат"
        }
      ]
    }
  ]
}

Response

The following example shows the response.

Note: The response object shown here might be shortened for readability.

HTTP/1.1 201 Created
Content-type: application/json; charset=utf-8

{
  "directoryPropertyName": "CustomAttribute1",
  "annotations": [
    {
      "displayName": "Cost Center",
      "localizations": [
        {
          "languageTag": "ru",
          "displayName": "центр затрат"
        }
      ]
    }
  ]
}