この機能を使用できるユーザー
クレデンシャル管理で実現できること
クレデンシャル管理は、クレデンシャルを作成し管理するための、QDICの機能です。クレデンシャル管理画面から以下を実現できます。
- 新規クレデンシャルの作成
- 既存クレデンシャルの編集および削除
クレデンシャル管理へのアクセス
ナビゲーションパネルから設定アイコンをクリックし、[組織管理]»[クレデンシャル管理]を選択します。クレデンシャル管理画面が表示されます。
クレデンシャルとは
当社は、ユーザー組織のカタログと外部のシステム(クライアント)と連携することを可能にする外部APIを提供しています。(QDIC外部APIの詳細は、QDIC 外部API(External API)を参照してください。)クレデンシャルとは、この外部APIからテナントに接続する際の認証に必要な情報をいいます。
外部APIの使用では、以下のクレデンシャル情報を必要とします。
- クライアントID
- クライアントシークレット
- トークンURL
クレデンシャルは、Intelligence Agentが外部APIを使用してカタログにメタデータを反映する際にも使用されるため、Intelligence Agentの構築でも必要な情報です。
Intelligence Agentの構築では、以下のクレデンシャル情報を必要とします。
- クライアントID
- クライアントシークレット
クレデンシャル管理画面の操作
新規クレデンシャルの作成
1. 新規クレデンシャルを作成
クレデンシャル管理画面で、以下の操作を行います。
- クレデンシャル管理画面右上の〈新規追加する〉ボタンをクリックして、 「新しいクレデンシャルを作成」ダイアログボックスを開きます。
- [クライアント名]フィールドに任意の名称を入力します。
- [アクセストークンの有効期限(分)]フィールドは、表示されているデフォルト値(60)のままでかまいません。
- 〈確定〉 ボタンをクリックします。
- 新しいクレデンシャルが作成されると、以下のメッセージと共にクレデンシャル情報がダイアログボックスに表示されます。このダイアログボックスは閉じずに、手順2の「2. クレデンシャル情報を取得」操作に進みます。
新しいクレデンシャルが正常に作成されました。
クライアントIDおよびクライアントシークレットをコピーしてください。このウィンドウを閉じた後、クライアントシークレットは再度表示されません。
2. クレデンシャル情報を取得
「新しいクレデンシャル情報が作成されました」ダイアログボックスで、以下の操作を行います。
- [クライアントID]フィールド右のコピーアイコンをクリックして、表示されているクライアントIDをコピーします。コピーした情報は、テキストファイル等に入力する等、記録します。
- [クライアントシークレット]フィールドをクリックして(フィールドには「クリックして閲覧」と表示されています。)クライアントシークレットが表示させます。フィールド右にコピーアイコンが現れるので、このコピーアイコンをクリックして、表示されているクライアントシークレットをコピーします。コピーした情報は、テキストファイル等に入力する等、記録します。
- 〈確定〉ボタンをクリックすると、ダイアログボックスは閉じられます。
既存クレデンシャルの編集
クレデンシャル管理画面から、編集するクライアントに対して、以下の操作を行います。
- 編集するクライアントが表示された枠をクリックします。もしくは、枠の右をクリックして操作メニューを表示し、[クレデンシャルを編集]を選択します。「クレデンシャルを編集」ダイアログボックスが表示されます。
- 編集できるのは、[クライアント名]フィールドと[アクセストークンの有効期限(分)]フィールドです。
- 〈確定〉ボタンをクリックし、編集されたフィールドを保存します。ダイアログボックスは閉じられます。
既存クレデンシャルの削除
クレデンシャル管理画面から、削除するクライアントに対して、以下の操作を行います。なお、操作方法は2つあり、どちらの方法で削除してもかまいません。
操作方法1.「クレデンシャルを編集」ダイアログボックスから削除
- 削除するクライアント名が表示された枠をクリックします。もしくは、枠の右をクリックして操作メニューを表示し、[クレデンシャルを編集]を選択します。「クレデンシャルを編集」ダイアログボックスが表示されます。
- 画面下の〈クレデンシャルを削除〉ボタンをクリックします。
-
削除確認のダイアログボックスが表示されます。[クライアント名を入力]フィールドに削除するクライアント名を入力します。
クライアント名
を完全に削除しますか?
(中略)
確認のため、クライアント名を入力してください。 - 入力した文字列と削除対象のクライアント名が一致すると、〈確定〉ボタンが有効になります。
- 〈確定〉ボタンをクリックし、クライアントを削除します。ダイアログボックスは閉じられます。
操作方法2.[クレデンシャルを削除]から削除
- 削除するクライアントが表示された枠の右をクリックして操作メニューを表示し、[クレデンシャルを削除]を選択します。
-
削除確認のダイアログボックスが表示されます。[クライアント名を入力]フィールドに削除するクライアント名を入力します。
クライアント名
を完全に削除しますか?
(中略)
確認のため、クライアント名を入力してください。 - 入力した文字列と削除対象のクライアント名が一致すると、〈確定〉ボタンが有効になります。
- 〈確定〉ボタンをクリックし、クライアントを削除します。ダイアログボックスは閉じられます。
留意事項
クライアントシークレットの扱い方
重要な注意
- 作成したクレデンシャル情報は保存され「クレデンシャルの編集」ダイアログボックスから確認できますが、クライアントシークレットはダイアログボックスに表示されません。必ず、「クレデンシャルの作成」手順2.2でコピーした情報を記録してください。
- 万一、クライアントシークレットを失念した場合は、改めて新しいクレデンシャルを作成する必要があります。