トヨクモ（※リリース予定）
業務アセットの接続
接続に必要な情報
接続は管理画面から発行したトークンを利用します。
| フィールド名 | 必須 | 説明 |
|---|---|---|
| APIトークン | ✅ | 管理画面から発行できるAPIトークンを入力してください。 発行手順については該当サービスのドキュメントを参照してください。 |
アクセストークンの権限
権限やスコープといった概念は存在しないため、全てのデータにアクセスできます。
トークンはテナントで1つだけ発行できます。
アカウント管理
アカウントの作成
YESOD で「アカウント作成」タスクを実行すると、トヨクモ側に既に同じメールアドレスが存在するかどうかで、作成／更新／再有効化の挙動が変わります。
| 条件 | 挙動 |
|---|---|
| 同一メールアドレスのアカウントがトヨクモに存在しない | アカウントを新規作成する |
| 同一メールアドレスの有効なアカウントがトヨクモに存在する | そのアカウントの情報を更新する |
| 同一メールアドレスの無効（停止）なアカウントがトヨクモに存在する | そのアカウントを有効にして情報を更新する |
パスワード管理
アカウント作成時のパスワードの設定に対応しています。
パスワードの再設定はAPIの仕様上、対応していません。
アカウント作成時のメール送信
アカウント作成時に招待メールが送られます。
メールを送信するかどうかの制御はできません。
アカウントの削除
トヨクモではアカウントの「削除」と「停止」がありますが、コネクタ経由でのアカウント削除はサービス上での停止が利用されます。
割当種別
| 割当種別名 | タイプ | 割当項目の例 | 備考 |
|---|---|---|---|
| 管理者権限 | • システム管理者 • 危機管理責任者 • マネージャー | 「システム設定」メニューから確認できます。 サービスの固定の値なので項目は追加できません。 | |
| 部署 | • 営業部 • 開発部 • … | 「システム管理」 > 「部署/地域/ユーザーの設定」メニューから確認できます。ユーザーが登録して利用する値なので環境によって項目は異なります。 |
役割について
管理者権限と部門ごとの権限の２つの役割が存在します。部門ごとの権限は「どの部門か」と「どの役割か」をセットで設定する必要があるため、同期する項目で設定する仕様になっています。
| 名称 | roleId | 管理場所 |
|---|---|---|
| システム管理者 | 0 | 割当種別の「管理者権限」 |
| 危機管理責任者 | 1 | 割当種別の「管理者権限」 |
| マネージャー | 2 | 割当種別の「管理者権限」 |
| 部門システム管理者 | 5 | 同期する項目の |
| 部門危機管理責任者 | 4 | 同期する項目の |
| 部門マネージャー | 3 | 同期する項目の |
役割の排他関係
この組み合わせを付与しようとした場合、タスクはエラーとなります。
| 行 \ 列 | roleId=0 | roleId=1 | roleId=2 | roleId=5 | roleId=4 | roleId=3 |
|---|---|---|---|---|---|---|
| システム管理者(roleId=0) | - | ✅ | ✅ | ❌ | ✅ | ✅ |
| 危機管理責任者(roleId=1) | ✅ | - | ❌ | ✅ | ❌ | ❌ |
| マネージャー(roleId=2) | ✅ | ❌ | - | ✅ | ✅ | ❌ |
| 部門システム管理者(roleId=5) | ❌ | ✅ | ✅ | - | ✅ | ✅ |
| 部門危機管理責任者(roleId=4) | ✅ | ❌ | ✅ | ✅ | - | ⚠️ |
| 部門マネージャー(roleId=3) | ✅ | ❌ | ❌ | ✅ | ⚠️ | - |
凡例: ✅ 両立可 / ❌ 兼務不可 / ⚠️ 同じ部署の場合のみ兼務不可（別部署であれば両立可）
部門レベル役割は同期する項目で管理します
同期する項目
| 項目名 | キー | 型 | 必須 | デフォルト値 | 備考 |
|---|---|---|---|---|---|
| ユーザー名 | 文字列 | ✅ | トヨクモのログインIDとして使用されます。 | ||
| メールアドレス | 文字列 | ✅ | |||
| 氏名 | 文字列 | ✅ | |||
| 氏名（フリガナ） | 文字列 | - | - | ||
| 電話番号 | 文字列 | - | - | ||
| 優先度 | 数値 | - | - | ||
| メモ | 文字列 | - | - | ||
| 地域コード | 文字列リスト | - | - | 単一の文字列も設定可能（自動的に1要素のリストに変換される）。地域コード表を参照 | |
| 部門レベル役割 | / | 数値 / 文字列 | - | - | 部門レベルの役割を部署コードとセットで複数設定できます。詳細は部門レベル役割の設定を参照 |
部門レベル役割の設定
部門レベルの役割（部門マネージャー・部門危機管理責任者・部門システム管理者）は、役割と対象部署コードのセットで割り当てる必要があるため、インデックス付きのキーで属性マッピングを設定します。
と のペアを , , ... のようにインデックスを増やしながら設定してください。同じ役割を複数の部署に割り当てる場合も異なるインデックスにそれぞれ設定します。
属性マッピングの設定例
| 属性キー | 設定値の例 | 説明 |
|---|---|---|
| 部門マネージャー | ||
| 対象部署コード | ||
| 部門マネージャー | ||
| 対象部署コード |
組織レベル役割は割当で管理します
設定時の注意事項
- サービスの仕様上、特定の役割は同時に設定できません。役割の排他関係をご確認ください。
- 各インデックスは独立に評価されます。 と の両方に有効な値があるインデックスのみが同期対象となります
- 値が両方空（ または空文字）のインデックスは除外されます。インデックスを飛ばしたり、途中のインデックスの値を両方空にしても、残りの有効なペアで同期されます
- 同じインデックスの と のうち片方だけ値があり、もう片方が空の場合は設定ミスとしてタスクが失敗します
- を1つもマッピングしていない場合は、部門レベル役割の同期は行いません（既存の部門レベル役割はそのまま保持されます）
- 部門レベル役割を全て削除したい場合は、マッピングしたすべてのインデックスで と の両方を空（ または空文字）に設定してください（ のみを空にするのが最も簡潔です）
制限事項
ユーザー名に を含むアカウントが存在すると正しく動作しません
トヨクモ側ではユーザー名（username）に を含むアカウントの登録が可能ですが、トヨクモAPIの仕様上 のパスパラメータとして解釈されるため、個別のアカウント取得・更新・削除が正常に動作しません。
ユーザー名に を含むアカウントが一人でも存在する場合はトヨクモコネクタをご利用いただけませんのでご注意ください。
レートリミット
上限は「契約ユーザー数の10倍のリクエスト数／日」なので、100人の環境であれば最大1000/日リクエストまで可能です。
レートリミットに達すると で返されエラーとなります。
制限は毎日0時にリセットされるため、リセットまで最大24時間かかります。再試行しても成功する見込みが低いことから、リトライは実装していません。