icon-zslogin.svg
ZIdentity

APIクライアントの追加

Zscaler APIリソースにアクセスするアプリケーションまたはサービスには、APIクライアントが作成され、ZIdentity管理ポータルでプロビジョニングされている必要があります。APIクライアントが認証リクエストを送信すると、ZIdentityは認証メカニズムに応じてクライアントのシークレットまたはアサーションを検証し、アクセス トークンを発行します。APIクライアントは、このアクセス トークンを使用して、必須APIリソースへのアクセスを要求します。ZIdentityは、APIクライアントを承認するためにOAuth 2.0クライアント資格情報付与タイプをサポートしています。

APIクライアントおよびリソース モジュールにアクセスするための完全な権限が割り当てられたZIdentity管理者は、ZIdentity管理ポータルでAPIクライアントを構成できます。詳細は、管理者ロールと権限を参照してください。

APIクライアントを追加するには、次の手順を実行します。

  1. [統合]>[APIクライアント]に移動します。
  2. [APIクライアントの追加]をクリックします。
  3. [APIクライアントの追加]ページでは、[クライアント]タブがデフォルトで選択されています。次の詳細を入力します。
    • [クライアント情報]:
      • [名前]: APIクライアントを識別するための名前を入力します。
      • [説明]: APIクライアントの目的を示す簡単な説明を入力します(例：この名前を使用して、OneAPIと対話するソフトウェア アプリケーションまたはスクリプト)。

      • [ステータス]:ステータスを有効にします。これにより、APIクライアントはAPIリソースを認証して使用できます。

        ステータスが無効の場合、APIクライアントはZIdentityによって発行されたアクセス トークンを取得できません。

      • [アクセストークンの有効期間]: APIリソースへのアクセスに使用されるアクセス トークンの有効性。時間を分単位で入力します。最小有効期間は1分、有効期間は最長24時間です。

    • [クライアント認証]:サポートされている認証方法として、JSON Web Key (JWK)仕様、証明書と公開キー、またはシークレットのいずれかを設定します。また、アプリケーションで同じ認証方法を設定する必要があります。例えば、ZIdentity管理ポータルでJWKを設定する場合、アプリケーションは認証用に送信される際に、同じキーを使用してJSON Webトークン(JWT)に署名し、検証する必要があります。

      • [クライアントJWKs URL]:検証のためにキーを取得する必要がある[クライアントJWKs URL]を入力します。JWTは、アプリケーション間でデータを安全に送信するために使用されるURLセーフ トークンです。JWK URLは、APIクライアントによって発行されたJWTの署名を検証するために、APIサーバーによって使用される、JSON形式の公開キーのセットをホストします。

      • [証明書/公開キー]:公開キーを含む.pemファイルをアップロードします。ZIdentityは公開キーを読み取り、認証を確認します。

      • [シークレット]: [追加]をクリックします。キーは自動生成され、有効期間とともに表示されます。このキーは一度生成されると、更新することはできません。最短期間は30日、最長期間は365日です。シークレット キーをコピーして、再度表示されないように、ローカル フォルダーに保存します。最大2つのクライアント シークレットを追加できます。3つ目のクライアント シークレットを追加すると、新しい値によって最新のクライアント シークレットが置き換えられます。そのため、クライアント シークレットは常に2つのみ設定できます。

  4. [リソース]タブを選択します。

    ロール(範囲)といっしょにテナントにリンクされているZscalerサービスのAPIを参照できます。範囲とは、特定のAPIリソースへのアクセスを制限する権限を指します。ロールは、それぞれのZscalerサービス管理ポータルで割り当てられ、ZIdentityと同期されます。詳細は、OneAPIについての理解を参照してください。

  5. APIクライアントがアクセスできる必須 API リソースを選択します。お客様は、割り当てられている範囲に応じて、各Zscaler サービスおよび各 one API リソース対象のみを選択できます。

  6. 保存 をクリックします。

    APIクライアントの詳細を保存すると、ZIdentityはクライアントIDを自動生成され、[APIクライアント]のページに表示されます。

  7. API呼び出しを行うには、トークンまたはシークレットと共にクライアントIDを提供する必要があるため、クライアントIDをコピーして保存します。
    • [APIクライアントを編集]のウィンドウからクライアントIDをコピーすることもできます。
      1. [APIクライアント]ページで、新しく設定したAPIクライアントの[編集]アイコンをクリックします。

      2. [APIクライアントの編集]ウィンドウで、クライアントIDをコピーしてローカル フォルダーに保存します。

関連記事s
OneAPI認証についてAPIクライアントについてAPIクライアントの追加APIクライアントの編集または削除APIリソースの表示アクセス トークンについてアクセス トークンの取り消し