認証情報とは
認証情報は、外部サービスと連携(API 呼び出しなど)するために使う認証情報です。OAuth や APIキーなど、さまざまな認証方式に対応しています。
認証情報まわりは、次の 3 つの要素で構成されます。
- 認証情報タイプ — 連携先サービスの種類です。どのような認証が必要か(OAuth/APIキーなど)を定義します。
- 認証情報の鍵 — 認証情報(シークレット)を暗号化するための鍵です。
- 認証情報 — 実際に連携するアカウント単位の認証情報です。
作成した認証情報は、フローやファンクションから参照して外部サービスを呼び出すのに使います。1 か所で管理しておくことで、複数のフローやファンクションから同じ連携設定を再利用できます。
- 認証情報タイプを確認する — 連携したいサービスのタイプ(APIキー / OAuth / Google など)を確認します。
- 認証情報の鍵を作成する — シークレットを暗号化する鍵を作成し、秘密鍵ファイルを保管します。
- 認証情報を作成する — タイプと鍵を選び、認証に必要な情報を入力します。
有効期限と使用履歴を確認する
Section titled “有効期限と使用履歴を確認する”認証情報の詳細画面は、次の 3 つのタブに分かれています。開いているタブは URL に出るので(例: …/credentials/{id}/history)、そのまま共有したりブックマークしたりできます。
| タブ | 内容 |
|---|---|
| 基本情報 | 名前・コード・連携済みかどうか・タイプ・鍵・スコープなどの基本情報と、カスタムフィールド。OAuth の認証情報では「トークンの有効期限」と「再連携の期限」も表示されます |
| 使用先 | この認証情報を使っているフローの一覧 |
| 使用履歴 | ジョブがいつ認証情報を使い始めたか(使用開始)、いつトークンを更新したか(リフレッシュ)、更新に失敗したか(リフレッシュ失敗)、画面などから連携し直したか(再連携)の一覧 |
- トークンの有効期限/再連携の期限 — アクセストークンとリフレッシュトークンの有効期限です。再連携の期限を過ぎると連携し直す必要があります(詳しくは認証情報を再連携する)。
- 使用履歴 — 日時・種別(使用開始/リフレッシュ/リフレッシュ失敗/再連携)のほか、更新後(リフレッシュ・再連携で受け取った)トークンの有効期限、失敗の理由、使われたランナージョブへのリンクが表示されます。リンクは、フローで使われたものは「フロー名 ノード名」、ファンクションのテスト実行で使われたものはファンクション名で表示されます。日時・種別・失敗の理由で絞り込めます。ランナージョブを削除しても、履歴そのものは残ります(リンクだけが消えます)。
- 再連携 — 編集画面の「連携し直す」や API で秘密情報を差し替えたときに残ります。「再連携した人」の列に、操作したメンバー(API で行ったときは API キー)が表示されます。ジョブの中のリフレッシュは「リフレッシュ」として残り、再連携には数えません。未連携に戻す操作も残りません。
- リフレッシュ失敗 — 失敗の理由には、連携先が返した HTTP ステータスとエラーコード(
invalid_grantなど)が表示されます。invalid_grantはリフレッシュトークンが失効・取り消しされたときによく返るもので、再連携が必要です。連携先が返した詳しいメッセージは、そのジョブのログで確認できます。
トークンのリフレッシュは、ジョブの中で認証情報を使うときに期限が近ければ自動で行われます。複数のジョブが同じ認証情報を同時に使ったときの動きは、トークンのリフレッシュのしくみを参照してください。
連携が切れたとき
Section titled “連携が切れたとき”作成したあとで連携が切れたとき(リフレッシュトークンの期限切れなど)や、秘密情報がまだ登録されていない「未連携」の認証情報を連携するときは、認証情報を再連携するを参照してください。