トヨクモ 安否確認サービス2
トヨクモ 安否確認サービス2を業務アセットとして接続すると、トヨクモ 安否確認サービス2のユーザーと「役割」をYESODから管理できます。接続に必要な準備と、管理できる範囲を説明します。
概要
トヨクモ株式会社は、日本のSaaS企業です。業務効率化とクラウド連携を目的としたクラウドサービスを開発・提供しています。YESODの業務アセットが接続するのは、そのうちの安否確認サービス2です。
管理できること
| 管理対象 | 内容 |
|---|---|
| アカウント | トヨクモ 安否確認サービス2の「ユーザー」をアカウントとして管理します |
| 割当 | 「管理者権限」と「部署」を割当として管理します |
権限には、管理者権限と部門ごとの権限の2つがあります。管理者権限は割当で指定し、部門ごとの権限は同期する項目で指定します。部門ごとの権限は、「役割」と「部署」をセットで登録する必要があるためです。詳しくは権限の種類を参照してください。
事前に必要なもの
- トヨクモ 安否確認サービス2のエンタープライズプランの契約
- トヨクモ 安否確認サービス2の管理画面で発行したAPIトークン
APIの利用に必要なトークンを発行できるのは、エンタープライズプランだけです。プランの内容は料金プランを参照してください。
接続に使う情報
接続には、トヨクモ 安否確認サービス2の管理画面から発行したトークンを使います。
| 入力項目 | 必須 | 入力する内容 |
|---|---|---|
| 「APIトークン」 | 必須 | 管理画面で発行したAPIトークン。発行手順はAPI認証トークンの発行についてを参照してください |
APIトークンは第三者へ共有せず、安全な場所で管理してください。
APIトークンでアクセスできる範囲
トヨクモ 安否確認サービス2のAPIトークンには、権限やスコープの概念がありません。1つのトークンで、すべてのデータにアクセスできます。
APIトークンは、トヨクモ 安否確認サービス2のテナントで1つだけ発行できます。
接続する
「業務アセット」画面から「SaaS接続」画面を開くまでの手順は、業務アセットを追加するを参照してください。
-
「SaaS接続」画面で「トヨクモ 安否確認サービス2」を選択します。 「トヨクモ 安否確認サービス2 接続」画面が表示されます。
-
「APIトークン」を入力します。
-
「接続」ボタンをクリックします。 同期が完了すると、業務アセットが作成されます。
アカウントの作成
YESODで「アカウント作成」タスクを実行すると、同じユーザー名のアカウントがトヨクモ 安否確認サービス2にあるかどうかで動作が変わります。ユーザー名は「同期する項目」のuser.usernameで決まり、既定値はuser.emailです。
| トヨクモ 安否確認サービス2の状態 | 動作 |
|---|---|
| 同じユーザー名のアカウントが存在しない | アカウントを新規作成します |
| 同じユーザー名の有効なアカウントが存在する | そのアカウントの情報を更新します |
| 同じユーザー名の無効（停止）なアカウントが存在する | そのアカウントを有効にして情報を更新します |
パスワードの設定
アカウント作成時のパスワードの設定に対応しています。パスワードの再設定は、APIの仕様上対応していません。
トヨクモ 安否確認サービス2は、アカウントの作成時にパスワードが必須です。「アカウント設定」の「初期パスワード」で「パスワードを設定しない」を選んでいると、アカウント作成タスクが失敗します。「ランダムなパスワード」または「属性式で入力」を選んでください。
アカウント作成時のメール送信
アカウントを作成すると、招待メールが送信されます。メールを送信するかどうかは制御できません。
アカウントの削除
トヨクモ 安否確認サービス2には、アカウントの「削除」と「停止」があります。業務アセット経由のアカウント削除では、停止が使われます。
割当種別
| 割当種別名 | タイプ | 割当項目の例 | 備考 |
|---|---|---|---|
| 管理者権限 | 複数のグループに所属させる | システム管理者、危機管理責任者、マネージャー | 「システム設定」メニューから確認できます。サービスの固定の値なので、項目は追加できません |
| 「部署」 | 複数のグループに所属させる | 営業部、開発部… | 「システム管理」＞「部署/地域/ユーザーの設定」メニューから確認できます。ユーザーが登録して利用する値なので、環境によって項目は異なります |
権限の種類
「役割」には、管理者権限と部門ごとの権限の2つがあります。部門ごとの権限は、対象の「部門」と「役割」をセットで設定する必要があるため、同期する項目で設定します。
| 名称 | roleId | 管理場所 |
|---|---|---|
| システム管理者 | 0 | 割当種別の「管理者権限」 |
| 危機管理責任者 | 1 | 割当種別の「管理者権限」 |
| マネージャー | 2 | 割当種別の「管理者権限」 |
| 部門システム管理者 | 5 | 同期する項目のuser.departmentRoles |
| 部門危機管理責任者 | 4 | 同期する項目のuser.departmentRoles |
| 部門マネージャー | 3 | 同期する項目のuser.departmentRoles |
部門レベル役割（部門システム管理者・部門危機管理責任者・部門マネージャー）は、割当ではなく部門レベル役割の設定で管理します。
兼務できない組み合わせ
同時に持てない「役割」の組み合わせがあります（参考：兼任できない役割）。この組み合わせを付与しようとすると、タスクはエラーになります。
| 行＼列 | roleId=0 | roleId=1 | roleId=2 | roleId=5 | roleId=4 | roleId=3 |
|---|---|---|---|---|---|---|
| システム管理者(roleId=0) | - | ✅ | ✅ | ❌ | ✅ | ✅ |
| 危機管理責任者(roleId=1) | ✅ | - | ❌ | ✅ | ❌ | ❌ |
| マネージャー(roleId=2) | ✅ | ❌ | - | ✅ | ✅ | ❌ |
| 部門システム管理者(roleId=5) | ❌ | ✅ | ✅ | - | ✅ | ✅ |
| 部門危機管理責任者(roleId=4) | ✅ | ❌ | ✅ | ✅ | - | ⚠️ |
| 部門マネージャー(roleId=3) | ✅ | ❌ | ❌ | ✅ | ⚠️ | - |
凡例: ✅ 両立可 ／ ❌ 兼務不可 ／ ⚠️ 同じ「部署」の場合のみ兼務不可（別の「部署」であれば両立可）
同期する項目
業務アセットの「アカウント設定」にある「同期する項目」で、YESODの項目をトヨクモ 安否確認サービス2の項目へ対応づけます。
| 項目名 | キー | 型 | 必須 | デフォルト値 | 備考 |
|---|---|---|---|---|---|
| ユーザー名 | user.username | 文字列 | ✅ | user.email | トヨクモ 安否確認サービス2の「ログインID」として使用されます |
| メールアドレス | user.email | 文字列 | ✅ | user.email | - |
| 氏名 | user.fullname | 文字列 | ✅ | user.familyNameLocalPreferred + " " + user.givenNameLocalPreferred | - |
| 氏名（フリガナ） | user.fullnameRuby | 文字列 | - | - | - |
| 電話番号 | user.tel | 文字列 | - | - | - |
| 優先度 | user.priority | 数値 | - | - | - |
| メモ | user.memo | 文字列 | - | - | - |
| 地域コード | user.areaCodes | 文字列リスト | - | - | 単一の文字列も設定できます（自動的に1要素のリストに変換されます）。値は地域コード表を参照してください |
| 部門レベル役割 | user.departmentRoles[N].roleId ／ user.departmentRoles[N].departmentCode | 数値 ／ 文字列 | - | - | 部門レベル役割を部署コードとセットで複数設定できます。詳しくは部門レベル役割の設定を参照してください |
部門レベル役割の設定
部門レベル役割（部門マネージャー・部門危機管理責任者・部門システム管理者）は、「役割」と対象の部署コードのセットで割り当てます。そのため、インデックス付きのキーで属性マッピングを設定します。
roleIdとdepartmentCodeのペアを、[0]、[1]、[2]のようにインデックスを増やしながら設定してください。同じ「役割」を複数の「部署」へ割り当てる場合も、異なるインデックスにそれぞれ設定します。
設定例は次のとおりです。
| 属性キー | 設定値の例 | 説明 |
|---|---|---|
user.departmentRoles[0].roleId | 3 | 部門マネージャー |
user.departmentRoles[0].departmentCode | "sales" | 対象部署コード |
user.departmentRoles[1].roleId | 3 | 部門マネージャー |
user.departmentRoles[1].departmentCode | "develop" | 対象部署コード |
組織レベルの「役割」（システム管理者・危機管理責任者・マネージャー）は、属性同期ではなく割当種別の「管理者権限」で管理します。
設定するときは、次の点に注意してください。
- サービスの仕様上、同時に設定できない「役割」があります。兼務できない組み合わせを確認してください
- 各インデックスは独立に評価されます。
roleIdとdepartmentCodeの両方に有効な値があるインデックスだけが同期の対象です - 値が両方とも空（
nullまたは空文字）のインデックスは除外されます。インデックスを飛ばしても、途中のインデックスの値を両方とも空にしても、残りの有効なペアで同期されます - 同じインデックスの
roleIdとdepartmentCodeのうち片方だけに値があると、設定ミスとしてタスクが失敗します user.departmentRolesを1つもマッピングしていない場合、部門レベル役割は同期しません。既存の部門レベル役割はそのまま残ります- 部門レベル役割をすべて削除する場合は、マッピングしたすべてのインデックスで
roleIdとdepartmentCodeの両方を空にしてください。空とはnullまたは空文字です。[0]だけを空にするのが最も簡潔です
グループプッシュ
グループプッシュには対応していません。
制限事項
ユーザー名に/を含むアカウント
トヨクモ 安否確認サービス2ではユーザー名に/を含むアカウントを登録できます。ただし、APIの仕様上v1/member/{username}のパスパラメーターとして解釈されるため、アカウントの個別の取得・更新・削除が正常に動作しません。ユーザー名に/を含むアカウントが1人でもいる場合、この接続先サービスは利用できません。
レートリミット
APIの使用回数の上限は、契約ユーザー数の10倍／日です。100人の環境であれば、1日あたり最大1,000回まで呼び出せます。
上限に達すると429 Too Many Requestsが返り、エラーになります。制限は毎日0時にリセットされるため、リセットまで最大24時間かかります。再試行しても成功する見込みが低いことから、YESODは自動で再試行しません。
一括実行
一括実行には対応していません。