業務アセットで同期される従業員の属性および割当情報の取得
リクエスト
エンドポイント
実行先のURLについて詳しくは、「APIエンドポイント」をご覧ください。
HTTPメソッド | APIパス | 用途 | マスタ管理プラスオプション必須 |
---|---|---|---|
GET | /api/v24.10/memberAssets | 業務アセットで同期される従業員の属性および割当情報の取得 | ー |
クエリパラメータ
項目名 | 必須 | データ形式 | デフォルト値 | 説明 |
---|---|---|---|---|
assetId | ー | 文字列(業務アセットのID) |
ー | 情報を取得する業務アセットのIDを指定。未設定の場合、全ての業務アセットに関する情報が出力される |
リクエストヘッダ
「APIリクエストヘッダ」をご覧ください。
リクエストボディ
不要
レスポンス
レスポンスボディ
項目名 | データ形式 | 説明 |
---|---|---|
members | membersオブジェクトの配列。各要素の属性は、「membersオブジェクト」をご覧ください | 検索結果 |
membersオブジェクト
項目名 | データ形式 | 説明 |
---|---|---|
date | 文字列(YYYY-MM-DD形式) | 従業員情報の情報取得日 |
id | 文字列 | 従業員のID |
type | 文字列 | 従業員であることを示す値「member」が設定 |
name | 文字列 | 従業員の名前 |
文字列 | 従業員のメールアドレス | |
identificationNumber | 文字列 | 従業員の個人ID (顧客が設定可能) |
companies | groupオブジェクトの配列。各要素の属性は、「groupオブジェクト」をご覧ください | 従業員が所属している会社の情報 |
organizations | groupオブジェクトの配列。各要素の属性は、「groupオブジェクト」をご覧ください | 従業員が所属している組織の情報 |
offices | groupオブジェクトの配列。各要素の属性は、「groupオブジェクト」をご覧ください | 従業員が所属している事務所の情報 |
projects | groupオブジェクトの配列。各要素の属性は、「groupオブジェクト」をご覧ください | 従業員が所属しているプロジェクトの情報 |
assets | assetsオブジェクトの配列。各要素の属性は「assetsオブジェクト」をご連絡ください | 従業員が対象となっている業務アセットの情報 |
assetsオブジェクト
項目名 | データ形式 | 説明 |
---|---|---|
id | 文字列 | 業務アセットのID |
type | 文字列 | 業務アセットであることを示す値「asset」が設定 |
name | 文字列 | 業務アセットの名前 |
attributes | attributesオブジェクト。項目は、「attributesオブジェクト」をご覧ください | 所属会社が作成されている深さ |
allocations | allocationsオブジェクトの配列。各要素の項目は、「allocationsオブジェクト」をご覧ください | 業務アセットの割当の情報 |
attributesオブジェクト
項目名 | データ形式 | 説明 |
---|---|---|
<業務アセットの同期属性名> | 属性によって変化 | 業務アセットの設定に基づいて規定されている同期属性の内容。業務アセットの設定画面までの手順については、『IIJ IDガバナンス管理サービス マニュアル』をご覧ください。また、外部サービスに同期できる属性については、『IIJ IDガバナンス管理サービス 契約SaaS連携設定例マニュアル』をご覧ください |
allocationsオブジェクト
項目名 | データ形式 | 説明 |
---|---|---|
id | 文字列 | 割当のID |
name | 文字列 | 割当の名前 |
items | itemsオブジェクトの配列。各要素の項目は、「itemsオブジェクト」をご覧ください | 従業員に設定されている割当設定 |
itemsオブジェクト
項目名 | データ形式 | 説明 |
---|---|---|
id | 文字列 | 設定されている割当の内部ID |
name | 文字列 | 設定されている割当の名前 |
code | 文字列 | 設定されている割当のコード |
共通オブジェクト
groupオブジェクト
項目名 | データ形式 | 説明 |
---|---|---|
id | 文字列 | 所属グループのID |
type | 文字列 | グループの種別
|
name | 文字列 | 所属グループの名前 |
code | 文字列 | 所属グループコード (顧客が設定可能) |
depth | 整数値 | 所属グループが作成されている深さ |