Freshservice について
Iru は Freshservice API v2 から、チケット、変更(承認ステータスと実施日を含む)、インシデント、問題、CMDB の資産、エージェントとそのロール を読み取ります。認証には Profile Settings にある API キー を使用します。リクエストの送信先はアカウントのドメインhttps://YOUR_DOMAIN.freshservice.com/api/v2 です。コネクタウィザードでは、最初に Basic 認証情報、次に ドメイン を入力します。
仕組み
X という文字をそのまま使用します。エンコードは Iru が処理します。ユーザー名とパスワードによる Basic 認証は 2023 年 5 月 31 日に廃止 され、現在は失敗するため、API キーが唯一サポートされている方法です。
API キーは キーを生成したエージェントの権限をそのまま 持ち、エンドポイントごとのスコープはありません。権限が制限されたエージェントのキーでは、チケットや変更の一部しか取得できません。エビデンスを完全に保つため、管理者レベルの専用サービスアカウントを使用してください。
公式リファレンス: API v2 リファレンス、API キーの確認場所。
前提条件
- ドメイン(
https://acme.freshservice.comのacme)。 - キーを生成するための 管理者レベルのエージェントアカウント。個人のエージェントアカウントを使用すると、エビデンスの収集が 1 人の権限に依存し、その人がオフボーディングされると機能しなくなります。
- 対象範囲を決定します。Freshservice では、チケットの種類を除外したり、資産インベントリをスキップしたり、部門でフィルタリングしたりできます。基となるデータが除外されている場合、Iru は影響を受けるコントロールを検証不可としてマークします。
Freshservice を Iru に接続する
- Freshservice
- Iru Compliance
Compliance でソースを接続する前に、このタブの手順を完了してください。
1
Freshservice にサインインする
連携に継承させる権限を持つ 管理者レベルのエージェント として、
https://YOUR_DOMAIN.freshservice.com にサインインします。2
Profile Settings を開く
右上の プロフィールアバター を選択し、Profile Settings を選択します。
3
API キーをコピーする
そのページで Your API Key を見つけてコピーします。Freshservice は毎回新しいキーを生成するのではなく、プロフィールページにキーを表示するため、後で再度確認することもできます。
4
パスワードの慣例を確認する
Basic 認証の パスワード は
X という文字そのものです。これは Freshservice ではなく Iru で入力します。Iru Compliance タブに進んでください。
トラブルシューティング
ソースをオンにしても何も開かない
ソースをオンにしても何も開かない
Iru サイトの ポップアップブロッカー の設定を確認して、もう一度お試しください。
401 で unsupported_authentication_type が返される
401 で unsupported_authentication_type が返される
API キーではなく、メールアドレスとパスワードが使用されています。この方法は 2023 年 5 月 31 日に削除されました。キーを ユーザー名 として使用してください。
詳細なしで 401 が返される
詳細なしで 401 が返される
API キー全体を貼り付け、パスワード フィールドに
X などの空でない値が入力されていることを確認してください。パスワードが空の場合は失敗します。一部のエンドポイントで access_denied が返される
一部のエンドポイントで access_denied が返される
キーを生成したエージェントに、変更、資産、または問題に対する権限がありません。管理者レベルのエージェントでキーを再生成してください。
資産が表示されない
資産が表示されない
CMDB がこの接続の対象範囲外であるか、エージェントが資産を読み取れません。Iru はこれらのケースを区別できません。
ウィザードでホストに到達できないと表示される
ウィザードでホストに到達できないと表示される
ドメイン を修正して再接続してください。ドメインはサブドメインのみで、完全な URL ではありません。
関連記事
Sources の管理
すべての Compliance ソースを参照、管理します。
Freshsales
CRM のエビデンスを得るために Freshsales を接続します。
Compliance を使い始める
フレームワーク、アクション、アーティファクト。
Artifacts の管理
ソースやアクションから得たエビデンスをアップロード、確認、整理します。
