profileCardProperty resource type

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.

Represents an attribute of a user on the Microsoft 365 profile card for an organization to surface in a shared, people experience.

The attribute can be an Azure Active Directory (Azure AD) built-in attribute, such as Alias or UserPrincipalName, or it can be a custom attribute. For a custom attribute, an administrator can define an en-us default display name string and a set of alternative translations for the languages that they support in their organization.

For more information on adding properties to the profile card for an organization, see customize the profile card.

Methods

Method Return Type Description
List profileCardProperty Get a collection of profileCardProperty resources of an organization.
Create profileCardProperty Create a new profileCardProperty resource for an organization.
Get profileCardProperty Read the properties and relationships of a profileCardProperty resource, which contains the profile card customizations that exist in a Microsoft 365 organization for a given field.
Update profileCardProperty Update a profileCardProperty object.
Delete None Delete a profileCardProperty object.

Properties

Property Type Description
annotations profileCardAnnotation collection Allows an administrator to set a custom display label for the directory property and localize it for the users in their tenant.
directoryPropertyName String Identifies a profileCardProperty resource in Get, Update, or Delete operations. Allows an administrator to surface hidden Azure Active Directory (Azure AD) properties on the Microsoft 365 profile card within their tenant. When present, the Azure AD field referenced in this field will be visible to all users in your tenant on the contact pane of the profile card. Allowed values for this field are: UserPrincipalName, Fax, StreetAddress, PostalCode, StateOrProvince, Alias, CustomAttribute1, CustomAttribute2, CustomAttribute3, CustomAttribute4, CustomAttribute5, CustomAttribute6, CustomAttribute7, CustomAttribute8, CustomAttribute9, CustomAttribute10, CustomAttribute11, CustomAttribute12, CustomAttribute13, CustomAttribute14, CustomAttribute15.

Relationships

None.

JSON representation

The following is a JSON representation of the resource.

{
  "annotations": [
    {
      "displayName": "String",
      "localizations": [
        {
          "languageTag": "String",
          "displayName": "String"
        }
      ]
    }
  ],
  "directoryPropertyName": "String"
}