GetCustomField - Identity as a Service - Alibaba Cloud ドキュメントセンター

拡張フィールドの情報を取得します。

今すぐお試しください

この 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:GetCustomField

get

*CustomField

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

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
InstanceId	string	必須	インスタンスID。	idaas_ue2jvisn35ea5lmthk267xxxxx
FieldId	string	必須	フィールドID。	ufd_001

レスポンスフィールド

フィールド	型	説明	例
	object
RequestId	string	リクエストID。	0441BD79-92F3-53AA-8657-F8CE4A2B912A
CustomField	object	カスタムフィールド情報。
InstanceId	string	インスタンスID。	idaas_z4pwq7v5ankdimdelzo2zbmzo4
FieldId	string	フィールドID。	ufd_ncvy5trszg3zajaal5iofauy2q
EntityType	string	フィールドが属するエンティティタイプ。	user
FieldName	string	フィールド識別子。	userId
FieldDisplayName	string	フィールドの表示名。	userId
FieldDisplayType	string	フィールドの表示タイプ。列挙値: input : input number : number select : select checkbox : checkbox	input
FieldDataType	string	データ型。列挙値: number : number boolean : boolean string : string	string
DefaultValue	string	フィールドのデフォルト値。	test
FieldDataConfig	object	フィールド値の設定項目。
Items	array<object>	フィールド設定項目の一覧。
	object	カスタムフィールドの設定。
DisplayName	string	設定項目の表示名。	hobby
Value	string	設定項目の値。	game
Status	string	設定項目のステータス。列挙値: disabled : 無効 enabled : 有効	enabled
Unique	boolean	フィールドが一意かどうかを示します。	false
Encrypted	boolean	フィールドが暗号化されているかどうかを示します。	false
Required	boolean	フィールドが必須かどうかを示します。	false
UserPermission	string	ユーザー側（ポータル側）の権限。列挙値: read_write : 編集可能。 hide : 非表示。 read_only : 表示のみ。	read_only
CreateTime	integer	拡張フィールドが作成された時刻。UNIXタイムスタンプ形式。単位: ミリ秒。	17642960730
UpdateTime	integer	拡張フィールドが最後に更新された時刻。UNIXタイムスタンプ形式。単位: ミリ秒。	17642960730
Status	string	拡張フィールドのステータス。列挙値: disabled : 無効。 enabled : 有効。	enabled
Description	string	拡張フィールドの説明。	test

例

成功レスポンス

JSONJSON

{
  "RequestId": "0441BD79-92F3-53AA-8657-F8CE4A2B912A",
  "CustomField": {
    "InstanceId": "idaas_z4pwq7v5ankdimdelzo2zbmzo4",
    "FieldId": "ufd_ncvy5trszg3zajaal5iofauy2q",
    "EntityType": "user",
    "FieldName": "userId",
    "FieldDisplayName": "userId",
    "FieldDisplayType": "input",
    "FieldDataType": "string",
    "DefaultValue": "test",
    "FieldDataConfig": {
      "Items": [
        {
          "DisplayName": "hobby",
          "Value": "game",
          "Status": "enabled"
        }
      ]
    },
    "Unique": false,
    "Encrypted": false,
    "Required": false,
    "UserPermission": "read_only",
    "CreateTime": 17642960730,
    "UpdateTime": 17642960730,
    "Status": "enabled",
    "Description": "test"
  }
}

エラーコード

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

変更履歴

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