CreateCustomField - 建立擴充欄位 - Identity as a Service

建立擴充欄位

調試

您可以在OpenAPI Explorer中直接運行該介面，免去您計算簽名的困擾。運行成功後，OpenAPI Explorer可以自動產生SDK程式碼範例。

授權資訊

當前API暫無授權資訊透出。

請求參數

名稱	類型	必填	描述	樣本值
InstanceId	string	是	執行個體 ID。	idaas_ue2jvisn35ea5lmthk267xxxxx
EntityType	string	是	欄位歸屬實體，取值可選範圍： user：賬戶。	user
FieldName	string	是	欄位標識名。最大長度限制為 40，內容格式可包含英文小寫字母和底線，不能以底線開頭。	field_001
FieldDisplayName	string	是	欄位展示名。最大長度限制為 64。	name_001
FieldDisplayType	string	是	欄位展示類型，取值可選範圍： input：文本輸入框。對應可選資料類型：string、number select：下拉框。對應可選資料類型：string、boolean checkbox：多選框。對應可選資料類型：string	input
FieldDataType	string	是	欄位資料類型，取值可選範圍： string：字串。 number：數字，最大長度限制 32，支援正整數和小數。 boolean：布爾。	string
DefaultValue	string	否	欄位預設值。若類型存在配置項，則預設值必須在配置項中且處於啟用狀態，最大長度限制為 1024。	string
FieldDataConfig	object	否	欄位值配置項。
Items	array<object>	否	欄位配置項列表。清單項目最大限制數 100。	string
	object	否	欄位配置項資料對象。
DisplayName	string	否	配置項展示名。最大長度限制為 128。	string
Value	string	否	配置項展示值。最大長度限制為 64。	string
Status	string	否	配置項狀態，取值可選範圍： enabled：啟用。 disabled：禁用。配置項禁用，在建立和更新實體欄位值時，該配置項不可用。	string
Unique	boolean	否	欄位值是否唯一。設定為 true，則該欄位的值在對應實體類型中唯一存在，不可重複。	false
Encrypted	boolean	否	是否加密。設定為 true，則底層會對資料值進行加密儲存。	false
Required	boolean	否	是否必填。	false
UserPermission	string	否	portal 側欄位許可權，取值可選範圍： hide：portal 側不可見。 read_only：portal 側可見，不能編輯更新。 read_write：portal 側可見且可編輯更新。	false
Description	string	否	欄位描述。長度限制 512。	欄位測試

返回參數

名稱	類型	描述	樣本值
	object
RequestId	string	請求 ID。	0441BD79-92F3-53AA-8657-F8CE4A2B912A
FieldId	string	欄位 ID。	ufd_001

樣本

正常返回樣本

JSON格式

{
  "RequestId": "0441BD79-92F3-53AA-8657-F8CE4A2B912A",
  "FieldId": "ufd_001"
}

錯誤碼

訪問錯誤中心查看更多錯誤碼。

變更歷史

更多資訊，參考變更詳情。