GET/directory/users/custom-properties

ユーザーカスタムプロパティリストを取得する。

Authorization

oauth2

Access Token を指定します。
指定の方法や Access Token の取得方法は 共通仕様 を参照してください。

Scope

directory
directory.read

HTTP Request

GEThttps://www.worksapis.com/v1.0/directory/users/custom-properties

Query Parameters

ParameterTypeDescription
domainId integer 

ドメイン ID


example : 10000001 

Header Parameters

HeadertypeDescription
Authorization string 

Bearer {token}


required 

Response

HTTP 200

OK

PropertyTypeDescription
customAttributes array (UserCustomProperty) 

ユーザーカスタムプロパティ情報

 

UserCustomProperty

PropertyTypeDescription
domainId integer 

ドメイン ID


required
format : int32 
customPropertyId string 

ユーザーカスタムプロパティ ID

  • ユーザーカスタムプロパティのリソース ID
  • 登録時に自動発行されるユニーク ID

readOnly : true 
propertyName string 

ユーザーカスタムプロパティ名
ドメイン内で一意
英数字とアンダーバー (_) のみ使用可能
英字またはアンダーバー (_) で始める


required
maxLength : 120 
displayName string 

ユーザーカスタムプロパティの表示名
ドメイン内で一意


required
maxLength : 20 
i18nDisplayNames array (I18nDisplayName) 

ユーザーカスタムプロパティの表示名の多言語リスト


minItems : 0 
propertyType string 

ユーザーカスタムプロパティタイプ

  • STRING: テキスト
  • LINK: リンク
  • INTEGER: 数値
  • DATE: 日付

required
Allowed values : STRING, LINK, INTEGER, DATE 
displayOrder integer 

表示順位 (重複許可)
値を指定しない (NULL) 場合、最後尾に指定される


required
minimum : 1
format : int32
nullable : true 
multiValued boolean 

複数値の許可
同一のユーザーカスタムプロパティに複数の値を登録できる


required
default : false 
options array (UserCustomPropertyOption) 

選択肢リスト
propertyType が STRING の場合に指定できる


minItems : 2 
mandatory boolean 

必須項目


required
default : false 
readAccessType string 

読み取り権限


required
default : ALL
Allowed values : ADMIN_AND_SELF, ALL 
writeAccessType string 

書き込み権限


required
default : ADMIN
Allowed values : ADMIN, ADMIN_AND_SELF 

I18nDisplayName

PropertyTypeDescription
language string 

多言語コード


Allowed values : ja_JP, ko_KR, zh_CN, zh_TW, en_US 
name string 

表示名


maxLength : 20 

UserCustomPropertyOption

PropertyTypeDescription
optionName string 

選択肢名
英数字とアンダーバー (_) のみ使用可能


maxLength : 100 
displayName string 

選択肢表示名


maxLength : 20 
i18nDisplayNames array (I18nDisplayName) 

選択肢表示名の多言語リスト


minItems : 0 

Response Example

example

1{2  "customAttributes": [3    {4      "domainId": 10000001,5      "customPropertyId": "customfd-fc09-4a57-ab38-03dc6c425e01",6      "propertyName": "string_single_option",7      "displayName": "趣味",8      "i18nDisplayNames": [9        {10          "language": "ja_JP",11          "name": "趣味"12        },13        {14          "language": "en_US",15          "name": "hobby"16        }17      ],18      "propertyType": "STRING",19      "displayOrder": 1,20      "multiValued": false,21      "options": [22        {23          "optionName": "option_piano",24          "displayName": "ピアノ"25        },26        {27          "optionName": "option_cooking",28          "displayName": "料理"29        }30      ],31      "mandatory": false,32      "readAccessType": "ALL",33      "writeAccessType": "ADMIN_AND_SELF"34    },35    {36      "domainId": 10000001,37      "customPropertyId": "customfd-fc09-4a57-ab38-03dc6c425e02",38      "propertyName": "date_multi",39      "displayName": "休日",40      "propertyType": "DATE",41      "displayOrder": 2,42      "multiValued": true,43      "mandatory": false,44      "readAccessType": "ALL",45      "writeAccessType": "ADMIN_AND_SELF"46    }47  ]48}

HTTP 404

Not Found