profileCardProperty を作成する

名前空間: microsoft.graph

organizationの新しい profileCardProperty を作成します。 新しいプロパティは、 directoryPropertyName プロパティによって識別されます。

organizationのプロファイル カードにプロパティを追加する方法の詳細については、「プロファイル カード API を使用してプロファイル カードにカスタム属性を追加または削除する」を参照してください。

注:

プロファイル カード プロパティは、Microsoft Entra IDの属性に対応します。 organizationの profileCardProperties コレクションに profileCardProperty として属性を追加すると、属性値を表示するようにプロファイル カードが構成されます。 コレクションから profileCardProperty を削除しても、Microsoft Entra IDから属性は削除されません。プロファイル カードが属性値を表示しなくなったように構成を削除します。

この API は、次の国内クラウド展開で使用できます。

グローバル サービス 米国政府機関 L4 米国政府機関 L5 (DOD) 21Vianet が運営する中国
✅ ✅ ✅ ✅

アクセス許可

この API の最小特権としてマークされているアクセス許可またはアクセス許可を選択します。 アプリで必要な場合にのみ、より高い特権のアクセス許可またはアクセス許可を使用します。 委任されたアクセス許可とアプリケーションのアクセス許可の詳細については、「アクセス許可の種類」を参照してください。 これらのアクセス許可の詳細については、「アクセス許可のリファレンス」を参照してください。

アクセス許可の種類 最小特権アクセス許可 より高い特権のアクセス許可
委任 (職場または学校のアカウント) PeopleSettings.ReadWrite.All 注意事項なし。
委任 (個人用 Microsoft アカウント) サポートされていません。 サポートされていません。
アプリケーション サポートされていません。 サポートされていません。

重要

職場または学校アカウントを使用して委任されたアクセスを行うには、管理者にサポートされているMicrosoft Entraロールを割り当てる必要があります。 People管理者は、この操作でサポートされる最小限の特権ロールです。

HTTP 要求

POST /admin/people/profileCardProperties

要求ヘッダー

名前 説明
Authorization ベアラー {token}。 必須です。 認証と認可についての詳細をご覧ください。
Content-Type application/json. Required.

メモ: ペイロードの形式が正しくないエンコードの問題を回避するには、 Content-Type: application/json; charset=utf-8を使用します。

要求本文

要求本文で、 profileCardProperty オブジェクトの JSON 表現を指定します。

organizationの profileCardProperty を作成するときに、次のプロパティを指定できます。

プロパティ 型 説明
注釈 profileCardAnnotation コレクション 管理者が指定することを選択した代替ラベルまたはローカライズされたラベル。 省略可能。
directoryPropertyName 文字列 プロファイル カードに表示するディレクトリ プロパティの名前。 必須です。
Isvisible ブール型 指定されたディレクトリ プロパティをユーザーのプロファイル カードに表示するかどうかを示します。 省略可能。

応答

成功した場合、このメソッドは 201 Created 応答コードと、応答本文に新しい profileCardProperty オブジェクトを返します。

例

要求

次の例は要求を示しています。

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

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

応答

次の例は応答を示しています。

注: ここに示す応答オブジェクトは、読みやすさのために短縮されている場合があります。

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

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