APIコンシューマーアプリと認証情報を管理
顧客統合管理者またはVMSユーザーは、セルフサービス機能を介して、APIコンシューマーアプリを登録し、CCW APIにアクセスするために必要な資格情報を管理できます。
ワクチンの仕組み
CCW APIとの統合を検討している顧客およびパートナーは、システムをAPIコンシューマーアプリとして登録する必要があります。これは、共通の資格情報セットでアクセス可能なCCW APIリソースのセットです。アプリは、APIがアクセスできるリソースと実行できるアクションを制御する一連のAPIスコープとアクセス許可に関連付けられています。
新しいアプリを登録します。
カスタマーインテグレーション管理者は、[ インテグレーションツールキット] > [APIコンシューマー アプリ]に移動 し、[作成]をクリックしてAPIコンシューマーアプリを登録できます。
APIアプリを作成するには、次の情報を入力してください(すべてのフィールドが必須)。
- アプリケーション名- APIアプリを識別するための名前を入力します。
- アプリケーションの説明-アプリの用途を説明します。
- お問い合わせ先の氏名/メールアドレス-アプリに技術的な問題がある場合にCCWのサポートチームが連絡できる担当者の名前とメールアドレスを入力します。
- アプリケーションタイプ-現在、クライアント資格情報の付与タイプとのマシン間 統合を必要とするOpenId Connectアプリのみがサポートされています。今後のリリースでは、認証コード、 デバイスコード、およびその他の助成金タイプを必要とするウェブアプリケーションとデバイスアプリがサポートされます。
- 応募カテゴリー-最も当てはまるカテゴリーを選択してください。 顧客、パートナー、サプライヤー、またはMSP。
- アクティブ-アプリのステータスは、デフォルトでアクティブに設定されています。チェックマークを外してアプリを無効にします。
- 資格情報タイプ-共有シークレットに設定します。これらの設定が保存されると、シークレットが生成されます。将来のリリースでは、JSON Web Key (JWKS)ベースの資格情報タイプもサポートされます。
- クライアントID (読み取り専用フィールド) -自動生成されたクライアントIDは、CCW APIへの要求を認証するために使用されるOAuth 2.0クライアント資格情報の一部です。クライアントIDは、"CCW" +クライアントプレフィックスで始まる一意のランダムな文字列です。クライアントIDをコピーするには、フィールドの右側にある[コピー]ボタンをクリックします。
- APIユーザー-選択したアプリケーションカテゴリに基づいて、事前定義されたAPIユーザー(クライアント、MSP、またはサプライヤーのいずれかのユーザー)を選択します。
- スコープ-すべてのCCW APIには、特定のスコープまたはエンドポイントが必要です。現在、スコープが設定されているAPIは次のとおりです。
[ 保存]をクリックします。 クライアントシークレットが生成され、緑色のバナーに表示されます。Xをクリックしてバナーを閉じる前に、クライアントシークレットをコピー/ペーストし、安全な場所に保存します。
クライアントシークレットを紛失した場合は、アプリを編集し、[クライアントID]フィールドの横にある[生成]をクリックして資格情報を再生成する必要があります。セキュリティのため、クライアントシークレットはCCWシステムには保存されません。
アプリを見る
あなたや組織内の他のユーザーがすでにアプリを作成している場合、[ 統合ツールキット] > [APIコンシューマーアプリ]に移動すると、既存の アプリを一覧表示するグリッドが表示されます。
[ステータス]列には、アプリが有効か無効かが表示されます。[ステータス]列の右側にある3つのドットをクリックして、その行のアプリを編集します。非アクティブなアプリの場合は、アプリを削除するオプションも利用できます。
アプリの長いリストがある場合は、アプリ名またはカテゴリ、ユーザー(作成者列にリストされている)、日付(作成日列と最終更新日列にリストされている)などを検索できます。 検索 ボックスに入力し、虫眼鏡アイコンをクリックして結果を絞り込みます。
役割と権利
新しいアクセス権は、ユーザーが 統合ツールキット> APIコンシューマーアプリにアクセスして、既存の アプリ を表示したり、新しいアプリを作成(登録)したり、資格情報を管理したりできるかどうかを決定します。
- インテグレーションツールキット> APIコンシューマーアプリ> APIクライアントアプリの表示 - APIコンシューマーアプリのリストを表示するためのアクセスを可能にします。既定ではオフになっています。
- 統合ツールキット> APIコンシューマーアプリ> APIクライアントアプリの管理 - APIコンシューマーアプリの作成と管理にアクセスできます。既定ではオフになっています。