Kickflow（※リリース予定）
概要
kickflowは、株式会社kickflowが提供するクラウド型ワークフローサービスです。 稟議・申請・承認などのワークフローをオンラインで効率化し、組織の意思決定プロセスをデジタル化するサービスです。
接続先サービス関連リンク
管理対象
アカウントの管理対象
「ユーザー」をアカウントとして管理します。
備考
kickflowのユーザーには以下のステータスが存在します。
- ：招待済み（未ログイン）
- ：有効（ログイン済み）
- ：停止中
- ：無効化済み（論理削除）
割当の管理対象
以下を割当として管理します。
- ロール（管理者権限）
割当対象の補足
- ロール: 管理者ロール。権限（）の管理が可能です。複数ロールの同時付与に対応しています。
- チーム: メンバーシップに （役職ID）と （上長フラグ）の指定が必須であり、チーム所属と役職をセットで管理する必要があるため、割当ではなく同期する項目で対応します。
- 組織図: チーム操作の前提として参照のみに使用されます。
業務アセットの接続
接続に必要な情報
接続は管理画面から発行したAPIアクセストークンを利用します。
| フィールド名 | 必須 | 説明 |
|---|---|---|
| APIアクセストークン | ✅ | kickflowの管理画面から発行できるAPIアクセストークンを入力してください。 |
kickflow APIのベースURLは固定です。
アクセストークンの権限
アクセストークンを発行するユーザーの管理者ロールに、以下の管理権限が必要です。
| kickflow管理権限 | 必要な操作 |
|---|---|
| ユーザーの管理権限 | ユーザー・役職の参照・作成・更新・停止・再開・削除 |
| チームの管理権限 | 組織図・チーム・所属の参照・作成・更新・削除 |
| 管理者ロールの管理権限 | 管理者ロール・ロールメンバーシップの参照・作成・更新・削除 |
アカウント管理
アカウントの作成
YESOD で「アカウント作成」タスクを実行すると、kickflow に対して一意の識別子として メールアドレス を渡します。このメールアドレスが kickflow 側に既に存在するかどうかで、作成／更新／再有効化の挙動が変わります。
| 条件 | 挙動 |
|---|---|
| 同一メールアドレスのアカウントがkickflowに存在しない | アカウントを新規作成する |
| 同一メールアドレスの有効（/）なアカウントが存在する | そのアカウントの情報を更新する |
| 同一メールアドレスの停止中（）のアカウントが存在する | アカウントを再有効化（）してから情報を更新する |
| 同一メールアドレスの削除済み（）のアカウントが存在する | アカウントを再招待（）してから情報を更新する |
ユーザーコード（）について
kickflowのユーザー作成時には （ユーザーコード）の指定が必須です。他のサービスと異なり自動採番されないため、デフォルトではYESODの社員番号（）の先頭値を使用します。
パスワード管理
kickflowではAPIおよび管理者側からユーザーのパスワードを操作する手段が提供されていないため、パスワード管理には非対応です。パスワードリセット機能は利用できません。
アカウント作成時のメール送信
アカウント作成時にデフォルトで招待メールが送られます。 を指定することで招待メール送信を抑制可能です。
アカウントの削除
kickflowではユーザーの「停止」と「削除（無効化）」がありますが、コネクタ経由でのアカウント削除はサービス上での 削除（deactivate） が利用されます。
- 停止（）：ステータスが になる。再開（）が可能。チーム所属・ロール所属は保持される。
- 削除（）：論理削除。ステータスが へ変更され、 にタイムスタンプが設定される。削除後もAPI経由で取得可能。
警告
- ステータスのユーザーは停止できません（ のみ停止可能）。 のユーザーを無効化するには削除（）を使用する必要があります。
- すべてのステータス（・・）から削除は可能です。
ステータス遷移図。
割当種別
| 割当種別名 | タイプ | 割当項目の例 | 備考 |
|---|---|---|---|
| ロール | • スーパー管理者 • ユーザー管理者 • ... | 管理者ロール。スーパー管理者はテナント作成時から存在する特殊なロールで、すべての管理権限を持ちます。ロールはカスタム作成が可能で、複数のパーミッションを組み合わせて定義します（詳細はkickflow公式ドキュメントを参照）。 |
同期する項目
基本属性
| 必須 | 属性名 | key | デフォルト値 | 型 | 備考 |
|---|---|---|---|---|---|
| ✅ | メールアドレス | ユーザアカウントとの紐付けに使用する項目です | |||
| ✅ | 姓 | - | |||
| ✅ | 名 | - | |||
| ✅ | ユーザーコード | 一意。自動採番されないため社員番号の先頭値をデフォルトで使用します | |||
| 社員番号 | - | / | 任意 | ||
| 招待メール送信 | アカウント作成時のみ有効。 で招待メール送信を抑制可能 |
チーム所属属性（）
kickflowのチーム所属は「チームID × 役職IDリスト × 上長フラグ」の3要素で1エントリを構成します。1ユーザーが複数チームに所属できるため、属性キーにはインデックス付き動的キー（, , ...）を使用します。
| 必須 | 属性名 | key | 型 | 備考 |
|---|---|---|---|---|
| エントリ追加時に必須 | チーム識別子 | kickflow 上のチームのUUID または チームの「コード」のいずれか | ||
| エントリ追加時に必須 | 役職IDリスト | kickflow 上の役職IDリスト。kickflow API 仕様上 1つ以上必須 | ||
| 任意 | 上長フラグ | チームの上長として所属するかどうか。省略時は |
は から始まる連番で、所属の数だけ並べます。
チーム識別子・役職IDの取得方法
チーム識別子 は次のいずれかを指定できます（kickflow API がどちらも受け付ける仕様）。
- UUID: kickflow 管理画面の各チームページのURL末尾から取得
- 例: の末尾
- コード: チーム編集画面の「コード」欄で利用者が任意に設定する文字列、または未設定時に kickflow が自動採番する文字列
- 人間が読みやすい識別子として運用したい場合に有効
役職ID は kickflow 管理画面からは確認できないため、APIアクセストークンを用いて API 経由で取得します。
レスポンスは役職の配列で、各要素の フィールドが役職IDです。
属性式の書式（SpEL）
属性式は SpEL（Spring Expression Language）で評価されるため、各リテラルは SpEL の構文に従って記述します。
- 文字列リテラル: シングルクォート またはダブルクォート で囲む
- リストリテラル: 波括弧 で囲む
- 真偽値: / （クォート不要）
リストリテラルに角括弧 は使えません
SpEL の構文において はプロパティのインデックスアクセス（Indexer）として解釈されます。リストとして記述したつもりでも UUID 文字列がキーとして解釈され への変換エラー等が発生するため、リストには必ず波括弧 を使用してください。
設定例
「営業チームに部長として上長で所属」＋「開発チームにメンバーとして所属」の場合:
以下の例で使用するUUIDは説明用のプレースホルダーで、実際の値は kickflow から取得した値（チームID は管理画面のURL末尾、役職ID は前述の のレスポンス）に置き換えてください。
| プレースホルダー | 説明 |
|---|---|
| 営業チームのID | |
| 開発チームのID | |
| 部長役職のID | |
| メンバー役職のID |
| 属性キー | 属性式 |
|---|---|
同期挙動
- アカウント新規作成時: 設定したチーム所属がすべて反映されます。
- アカウント更新・属性同期時: YESOD側の設定と現状の差分（追加・更新・削除）のみが適用されます。
- オプトイン: プレフィックスのマッピングが1つも存在しない場合、チーム所属の同期自体をスキップし、kickflow 側の現状所属に一切手を加えません。
- 同一 のマージ: 同一 を複数インデックスで指定した場合、 は和集合にマージされ、 はいずれか1つでも であれば として畳み込まれます。
バリデーション
- が未設定で または のいずれかが設定されている場合、設定ミスとしてエラーになります。
- が設定されているが が空・未設定の場合、kickflow API の仕様上役職IDが1つ以上必要なためエラーになります。
備考
- ユーザーGETにはチーム・ロール情報は含まれないため、、 で別途取得が必要です。
- 一覧エンドポイント（）と詳細エンドポイント（）でフィールドに差があり、詳細のみ （LINE WORKS連携）、（招待情報）が含まれます。
- 同期対象は kickflow 上の の組織図配下のチームのみです。next/past 組織図への同期はサポートしません。
グループプッシュ
非対応。