内容

はじめに

Umbrella APIの概要

APIエンドポイントと管理

APIの使用例とエンドポイントグループ

APIキーのアクセスと有効期限

認証とトークンのライフサイクル

ドキュメントとリソース

サポート

はじめに

このドキュメントでは、Umbrella APIプラットフォームの機能、設定オプション、および使用可能なリソースについて説明します。

Umbrella APIの概要

Umbrella APIプラットフォームは、Umbrellaを構築、拡張、統合するための安全な環境を提供します。APIを使用して、他のセキュリティソリューションと脅威インテリジェンスを集約するクロスプラットフォームワークフローを作成し、適用の拡大、可視性の向上、インシデント対応の自動化を実現します。

APIエンドポイントと管理

- Umbrella APIのすべてのエンドポイントは、api.umbrella.comでホストされます。

- エンドポイントは、ユースケースごとにグループ化され、それぞれに特定のパスが付けられます。

- UmbrellaダッシュボードのAdmin > API keysで、またはKeyAdmin APIを使用してプログラムにより、APIキーを管理します。

APIの使用例とエンドポイントグループ

次の主要な使用例に基づいてグループ化された詳細なスコープを使用して、各APIキーを設定します。

- Admin APIエンドポイント:APIキーとユーザのプロビジョニングと管理、ロールの表示、およびプロバイダーとマネージドプロバイダーの顧客の管理を行います。

- Auth APIエンドポイント:Umbrellaと他のサービス間の統合を承認します。

- APIエンドポイントの導入：ネットワークとエンティティをプロビジョニング、監視、および管理し、既存のUmbrellaポリシーで設定することでネットワークとエンティティを保護します。

- ポリシーAPIエンドポイント：宛先リストと宛先をリストごとにプロビジョニングおよび管理します。

- APIエンドポイントの調査:Umbrellaリゾルバによって観察されたドメイン、IPアドレス、およびURLを調査します。

- レポートAPIエンドポイント：導入に関するリアルタイムのセキュリティ情報を読み取り、監査します。App Discovery APIは、クラウドベースのアプリケーションに対する洞察を提供します。

APIキーのアクセスと有効期限

- 各スコープのアクセスレベルを、使用目的に応じて読み取り/書き込みまたは読み取り専用に設定します。

- 必要に応じて、事前定義された日付に期限切れになるようにAPIキーを設定します。

15143392160916

認証とトークンのライフサイクル

- APIクレデンシャルは、60分間有効なアクセストークンを生成します。

- 認証プロセスでは、OAuth 2.0クライアント資格情報フローを使用します。

- 複数組織またはサービスプロバイダー環境では、親組織のAPIクレデンシャルは、認証時に指定された子組織と同じスコープのアクセストークンを生成できます。

ドキュメントとリソース

- 包括的な手順とユースケースドキュメントにアクセスします。

- 各APIの使用例については、「APIリファレンス」を参照してください。

- すべてのエンドポイントとパラメータは、各ユースケース概要の下部にリンクされた「OpenAPI Specification」に記載されています。

- レガシーUmbrella APIを使用する場合は、『API移行ガイド』を参照してください。

- 初期テストには、Umbrella API用のPostmanコレクションを使用します。

- シスコ開発者ページのクラウドセキュリティセクションで、追加のリソース、ラーニングラボ、およびAPIテスト用のサンドボックスをご覧ください。

サポート

Umbrella APIに関する質問や追加のサポートについては、Umbrellaサポートにお問い合わせください。