使用者設定檔屬性

適用於： 員工租用戶 外部租用戶 (深入了解)

您在註冊期間收集的使用者屬性會與目錄中的使用者設定檔一起儲存。 您可以選擇內建的使用者屬性，或建立自訂使用者屬性。

• 內建使用者屬性，例如城市、國家/地區、電子郵件地址等，可在 Microsoft Entra External ID 中使用。 您可以選擇註冊期間要向使用者收集的使用者屬性。

• 如需您想要收集任何其他資訊，您可以建立自訂使用者屬性。 您可以將數個自訂輸入控制項新增至註冊頁面，以收集屬性，包括文字輸入框、單選按鈕和複選框。 下列範例會示範如何使用自訂輸入控制項來收集忠誠號碼的屬性、使用規定同意的使用規定，以及隱私權原則同意。

  

内建使用者屬性

Microsoft Entra 外部 ID 具有您可以在註冊期間收集的內建使用者屬性。 當您 在 Microsoft Entra 系統管理中心中建立使用者流程時，您可以設定這些屬性。

下表摘要說明您可以在註冊流程期間收集的內建使用者屬性：

• Microsoft Entra 系統管理中心中的標籤是出現在 Microsoft Entra 系統管理中心的使用者屬性的名稱。
• 可程式化名稱是 Microsoft Graph API 使用者資源中使用的使用者屬性名稱。 您會在想以程式設計方式使用此使用者屬性時使用這個名稱，例如在原生驗證中。
• 資料類型是使用者屬性的資料類型。

Microsoft Entra 系統管理中心中的標籤	可程式化名稱	資料類型	備註
縣/市	市/鎮	String	長度上限是 128 個字元。
國家/地區	國家/地區	String	長度上限是 128 個字元。
顯示名稱	displayName	String	長度上限是 256 個字元。
電子郵件地址	mail	String	此屬性不能包含醒目字元。 在原生驗證 API 中，這個屬性會參考為 username。
名字	givenName	String	長度上限是 64 個字元。
職稱	jobTitle	String	長度上限是 128 個字元。
郵遞區號	郵遞區號	String	長度上限是 40 個字元。
縣/市	state	String	長度上限是 128 個字元。
街道地址	streetAddress	String	長度上限是 1024 個字元。
Surname	surname	String	長度上限是 64 個字元。

自訂使用者屬性

如果您的應用程式需要的資訊多於內建使用者屬性提供的資訊，您可以新增自己的屬性。 我們將這些屬性稱為 自訂使用者屬性。

若要定義自訂使用者屬性，您會先在租用戶層級建立屬性，以便在租用戶中的任何使用者流程中使用。 然後將屬性指派給註冊使用者流程，並設定您希望它出現在註冊頁面上的方式。

了解如何建立自訂使用者屬性 建立自訂使用者屬性 一文。

自訂使用者屬性輸入類型

使用自訂使用者屬性之前，請先決定收集每個您想要收集之自訂屬性的使用者輸入的最佳方式。 您可以使用下列輸入類型控制項，在註冊期間從使用者收集資訊：

• 字串文字輸入框
• 選項按鈕
• 多重選取複選框
• 數字文字輸入框
• 單選複選框

請參閱下表，以尋找適當的資料類型和使用者輸入類型：

資料類型	使用者輸入類型	描述
String	TextBox	自由格式文字輸入欄位。
String	RadioSingleSelect	只允許一個選取項目的單選按鈕系列。 個別單選按鈕的文字可以包含以 Markdown 語言格式化的超連結。
String	CheckboxMultiSelect	允許多個選取項目的一或多個複選框系列。 個別複選框的文字可以包含以 Markdown 語言格式化的超連結。
布林值	CheckboxSingleSelect	具有標籤的單一布林值複選框。 複選框的標籤可以包含以 Markdown 語言格式化的超連結。
int	NumericTextBox	自由格式整數輸入。

複選框和單選按鈕可以包含其他內容的超連結，例如使用規定和隱私權原則。 本文開頭的範例會顯示合併內建屬性和自訂屬性的註冊頁面。 在下列範例中：

• 顯示名稱欄位是個內建屬性。
• 忠誠號碼是一個自訂屬性，其中包含接受數值整數的自由格式輸入欄位。 您可以使用 Int 資料類型和 NumericTextBox 使用者輸入類型來設定此格式。
• 使用規定和隱私權原則自訂屬性是個別的單選複選框，帶有包含超連結的標籤。 您可以使用布林值資料類型來設定單選複選框，預設為 CheckboxSingleSelect 使用者輸入類型。 使用 Markdown 語言將超連結新增至複選框標籤。

在設定使用者輸入類型一文中了解如何設定其使用者屬性輸入類型。

儲存自訂使用者屬性的位置

自訂使用者屬性也稱為目錄擴充屬性，因為它們會擴充儲存在您目錄中的使用者設定檔資訊。 外部租用戶的所有擴充屬性都會儲存在名為 b2c-extensions-app 的應用程式中。 當使用者在註冊期間輸入自訂屬性的值之後，該值會新增至使用者物件，而且可以使用命名慣例 extension_{appId-without-hyphens}_{custom-attribute-name} ，透過 Microsoft Graph API 呼叫：

• {appId-without-hyphens}是 b2c-extensions-app 的用戶端識別碼的移除版本。
• {custom-attribute-name}是您指派給自訂屬性的名稱。

例如，如果 b2c-extensions-app 的用戶端識別碼是 2588a-bcdwh-tfeehj-jeeqw-ertc 且屬性名稱為：

• loyaltyNumber，則自訂屬性會命名為extension_2588abcdwhtfeehjjeeqwertc_loyaltyNumber。
• Loyalty Number，則自訂屬性會命名為extension_2588abcdwhtfeehjjeeqwertc_loyaltyNumber。 您可以移除空格，並使用駝峰式大小寫來分隔字組。

使用尋找擴充應用程式的應用程式標識碼 文章，以了解如何尋找在您外部租用戶中註冊的 b2c-extensions-app 的應用程式識別碼。

Microsoft Graph API

使用者屬性在 Microsoft Graph 中稱為使用者流程屬性。 請使用 identityUserFlowAttribute 資源類型及其相關聯的方法來同時管理内建和自訂使用者流程屬性。

相關內容

• 將屬性新增至傳回到應用程式的識別碼權杖中

• 深入了解如何為客戶建立註冊和登入使用者流程

• 原生驗證 MSAL Android SDK 屬性產生器。