すべてのプロダクト
Search

このプロダクト

    Identity as a Service:CreateCustomField

    ドキュメントセンター

    Identity as a Service:CreateCustomField

    最終更新日:Jun 17, 2026

    拡張フィールドを作成します。

    今すぐお試しください

    この API を OpenAPI Explorer でお試しください。手作業による署名は必要ありません。呼び出しに成功すると、入力したパラメーターに基づき、資格情報が組み込まれた SDK コードが自動的に生成されます。このコードをダウンロードしてローカルで使用できます。

    テスト

    RAM 認証

    下表に、この API を呼び出すために必要な認証情報を示します。認証情報は、RAM (Resource Access Management) ポリシーを使用して定義できます。以下で各列名について説明します。

    • アクション：特定のリソースに対して実行可能な操作。ポリシー構文ではAction要素として指定します。

    • API：アクションを具体的に実行するための API。

    • アクセスレベル：各 API に対して事前定義されているアクセスの種類。有効な値：create、list、get、update、delete。

    • リソースタイプ：アクションが作用するリソースの種類。リソースレベルでの権限をサポートするかどうかを示すことができます。ポリシーの有効性を確保するため、アクションの対象として適切なリソースを指定してください。

      • リソースレベルの権限を持つ API の場合、必要なリソースタイプはアスタリスク (*) でマークされます。ポリシーのResource要素で対応する ARN を指定してください。

      • リソースレベルの権限を持たない API の場合、「すべてのリソース」と表示され、ポリシーのResource要素でアスタリスク (*) でマークされます。

    • 条件キー：サービスによって定義された条件のキー。このキーにより、きめ細やかなアクセス制御が可能になります。この制御は、アクション単体に適用することも、特定のリソースに対するアクションに適用することもできます。Alibaba Cloud は、サービス固有の条件キーに加えて、すべての RAM 統合サービスに適用可能な一連の共通条件キーを提供しています。

    • 依存アクション：ある特定のアクションを実行するために、前提として実行が必要となる他のアクション。依存アクションの権限も RAM ユーザーまたは RAM ロールに付与する必要があります。

    アクション

    アクセスレベル

    リソースタイプ

    条件キー

    依存アクション

    eiam:CreateCustomField

    create

    *CustomField

    acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/customfield/*

    		 なし なし

    リクエストパラメーター

    パラメーター

    型

    必須 / 任意

    説明

    例
    InstanceId

    string

    必須

    インスタンス ID。

    idaas_ue2jvisn35ea5lmthk267xxxxx
    EntityType

    string

    必須

    フィールドが属するエンティティ。有効な値:

    • user: アカウント。

    user
    FieldName

    string

    必須

    フィールド識別子。 最大長: 40 文字。値には小文字とアンダースコアを含めることができ、アンダースコアで始めることはできません。

    field_001
    FieldDisplayName

    string

    必須

    フィールドの表示名。 最大長: 64 文字。

    name_001
    FieldDisplayType

    string

    必須

    フィールドの表示タイプ。有効な値:

    • input: テキスト入力ボックス。サポートされるデータの型: 文字列および number。

    • select: ドロップダウンリスト。サポートされるデータの型: 文字列およびブール値。

    • checkbox: 複数選択ボックス。サポートされるデータの型: 文字列。

    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

    任意

    ポータル側のフィールド権限。有効な値:

    • hide: ポータル側で表示されません。

    • read_only: ポータル側で表示されますが、編集または更新できません。

    • read_write: ポータル側で表示および編集できます。

    false
    Description

    string

    任意

    フィールドの説明。 最大長: 512 文字。

    字段测试

    レスポンスフィールド

    フィールド

    型

    説明

    例

    object

    RequestId

    string

    リクエスト ID。

    0441BD79-92F3-53AA-8657-F8CE4A2B912A
    FieldId

    string

    フィールド ID。

    ufd_001

    例

    成功レスポンス

    JSONJSON

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

    エラーコード

    完全なリストについては、「エラーコード」をご参照ください。

    変更履歴

    完全なリストについては、「変更履歴」をご参照ください。