エージェント ID 認証プロバイダを管理する

Agent Identity 認証マネージャーでは、認証プロバイダの詳細を編集したり、有効または無効にしたり、必要に応じて削除して復元したりすることで、認証プロバイダを管理します。

始める前に

  1. 正しい認証方法を選択していることを確認します。
  2. このタスクを完了するために必要なロールが付与されていることを確認します。

必要なロール

Agent Identity 認証プロバイダの管理に必要な権限を取得するには、プロジェクトに対するAgent Identity 編集者 （roles/agentidentity.editor）IAM ロールを付与するよう管理者に依頼してください。ロールの付与については、プロジェクト、フォルダ、組織に対するアクセス権の管理をご覧ください。

この事前定義ロールには Agent Identity 認証プロバイダの管理に必要な権限が含まれています。必要とされる正確な権限については、「必要な権限」セクションを開いてご確認ください。

必要な権限

Agent Identity 認証プロバイダを管理するには、次の権限が必要です。

  • agentidentity.authProviders.update
  • agentidentity.authProviders.delete

カスタムロールや他の事前定義ロールを使用して、これらの権限を取得することもできます。

認証プロバイダを編集する

認証プロバイダの説明または認証の詳細を更新するには、 Google Cloud コンソールまたは Google Cloud CLI を使用します。

認証プロバイダを更新するには、次のコマンドを実行します。

gcloud alpha agent-identity authProviders update AUTH_PROVIDER_NAME \
    --location="LOCATION" \
    --description="NEW_DESCRIPTION" \
    --three-legged-oauth-client-id="NEW_CLIENT_ID" \
    --three-legged-oauth-client-secret="NEW_CLIENT_SECRET" \
    --three-legged-oauth-authorization-url="NEW_ENDPOINT"

次のように置き換えます。

  • AUTH_PROVIDER_NAME: 認証プロバイダの名前。
  • LOCATION: 認証プロバイダのロケーション。
  • NEW_DESCRIPTION: 認証プロバイダの新しい説明。
  • NEW_CLIENT_ID: サードパーティ アプリケーションの新しいクライアント ID。
  • NEW_CLIENT_SECRET: サードパーティ アプリケーションの新しいクライアント シークレット。
  • NEW_ENDPOINT: サードパーティ認証サーバーの新しい URL。

認証プロバイダを有効または無効にする

認証プロバイダを削除せずに、エージェントが認証プロバイダを使用しないように一時的に停止する場合は、認証プロバイダを無効にできます。いつでも再度有効にできます。

  1. 認証プロバイダを有効にするには、次のコマンドを実行します。

    gcloud alpha agent-identity authProviders enable AUTH_PROVIDER_NAME \
    --location="LOCATION"

  2. 認証プロバイダを無効にするには、次のコマンドを実行します。

    gcloud alpha agent-identity authProviders disable AUTH_PROVIDER_NAME \
    --location="LOCATION"

次のように置き換えます。

  • AUTH_PROVIDER_NAME: 認証プロバイダの名前。
  • LOCATION: 認証プロバイダのロケーション。

認証プロバイダを削除する

認証プロバイダが不要になったら、削除できます。認証プロバイダを削除すると、無効になり、30 日間は削除済み（復元可能）の状態になります。この期間中は、必要に応じて認証プロバイダを復元できます。30 日後、ポリシーが消去されるまでにさらに 1 日かかります。その時点で、同じ名前の認証プロバイダを作成できます。

認証プロバイダを削除するには、次のコマンドを実行します。

gcloud alpha agent-identity authProviders delete AUTH_PROVIDER_NAME \
    --location="LOCATION"

次のように置き換えます。

  • AUTH_PROVIDER_NAME: 認証プロバイダの名前。
  • LOCATION: 認証プロバイダのロケーション。

削除した認証プロバイダを復元する

認証プロバイダを誤って削除した場合は、削除後 30 日以内であれば、削除済み（復元可能）の状態から復元できます。この期間中は、必要に応じて認証プロバイダを復元できます。 30 日後、ポリシーが消去されるまでにさらに 1 日かかります。その時点で、同じ名前の認証プロバイダを作成できます。

認証プロバイダを復元するには、次のコマンドを実行します。

gcloud alpha agent-identity authProviders undelete AUTH_PROVIDER_NAME \
    --location="LOCATION"

次のように置き換えます。

  • AUTH_PROVIDER_NAME: 認証プロバイダの名前。
  • LOCATION: 認証プロバイダのロケーション。

次のステップ