トヨクモ 安否確認サービス2 - 同期属性一覧

key(本サービス設定値) 説明 必須 データ型 備考
user.username ユーザー名 〇 string

トヨクモのログインID(ログイン名)として利用

アカウント作成時のみ設定し、作成後に値を変更しても属性同期ではログイン名は更新不可

詳細は「ユーザー名の変更について」をご確認ください

user.email メールアドレス 〇 string
user.fullname 氏名 〇 string
user.fullnameRuby 氏名(フリガナ) - string

user.tel

電話番号 -

string


user.priority 優先度 - integer
user.memo メモ - string
user.areaCodes 地域コード - array(string) 単一の文字列も設定可能。詳しくは、「地域コード」をご覧ください
user.departmentRoles[N].roleId 部門レベル役割 - string

部門レベルの役割を部署コードとセットで複数設定可能

  • 設定できる役割は以下のとおり
    • 部門マネージャー(roleId=3)
    • 部門危機管理責任者(roleId=4)
    • 部門システム管理者(roleId=5)
user.departmentRoles[N].departmentCode 部署コード - integer

部門レベルの役割を部署コードとセットで複数設定可能


部門レベル役割の設定

部門レベルの役割(部門マネージャー・部門危機管理責任者・部門システム管理者)は、役割と対象部署コードのセットで割り当てる必要があるためインデックス付きのキーで属性マッピングを設定します。

roleIdとdepartmentCodeのペアを[0],[1],[2],...のようにインデックスを増やしながら設定してください。同じ役割を複数の部署に割り当てる場合も異なるインデックスにそれぞれ設定します。


属性マッピングの例

属性キー 設定値の例 説明
user.departmentRoles[0].roleId 3 部門マネージャー

user.departmentRoles[0].departmentCode

"sales" 対象部署コード
user.departmentRoles[1].roleId 3

部門マネージャー

user.deoartmentRoles[1].deoartmentCode "develop" 対象部署コード



ユーザー名の変更について

ユーザー名(トヨクモにおけるログイン名)はアカウント作成後に属性同期を実行しても、変更することはできません。トヨクモAPIでは、ユーザー名はアカウントを特定する識別キーとして使用します。

そのため、ログイン名の変更はトヨクモの管理画面で行ってください。

マッピングしている属性をそのまま利用した上でユーザー名を変更したい場合は、以下の手順で業務アセットのアカウントとメンバーの紐付けを移してください。

  1. 対象メンバーに未実行のアカウント作成・削除タスクが無いことを確認する
  2. トヨクモの管理画面でログイン名を変更する※メールアドレスは対象メンバーのメールアドレスと一致させたままにする
  3. IGAで「user.username」にマッピングしている属性を変更後のログイン名と同じ値にする
  4. トヨクモの業務アセットの同期を実行する
  5. 旧ログイン名のアカウントが一覧から削除され、新ログイン名のアカウントが未紐付けで表示されることを確認する
  6. 再度トヨクモの業務アセットの同期を実行し、新ログイン名のアカウントが対象メンバーに紐付いたことを確認する
  7. トヨクモに同じ新ログイン名のユーザーが重複して存在していないことを確認する
【注意】

  • 手順2,3の間は空けずに実施してください。間にアカウント作成タスクを実行すると、変更前の値でトヨクモを検索し、見つからないために同じユーザーを重複して作成します
  • 2回目の紐付けで紐づかない場合は、業務アセットの名寄せ設定とトヨクモのメールアドレスが対象メンバーのメールアドレスと一致しているかをご確認ください

【注意】ユーザー名の制限事項について

トヨクモではユーザー名に「/」を含むアカウントの登録が可能ですが、トヨクモAPIの仕様上「v1/member/{username}」のパスパラメータとして解釈されるため、個別のアカウント取得・更新・削除が正常に動作しません。

ユーザー名の「/」を含むアカウントが一人でも存在する場合はトヨクモを利用することはできないため、「/」を使用しないようご注意ください。