Workload Identity Federation 可讓您透過工作負載身分集區和連結的識別資訊提供者 (IdP),將Google Cloud 資源的存取權授予外部工作負載。隨著需求變化,您可以使用Google Cloud 控制台、Google Cloud CLI 或 REST API,建立、查看、更新、刪除或取消刪除集區和提供者。
事前準備
建立 workload identity pool。如需操作說明,請參閱 Workload Identity Federation 設定指南。
必要的角色
如要取得管理 workload identity pool 和提供者所需的權限,請要求管理員在專案中授予您下列 IAM 角色:
-
如要查看集區和提供者:IAM Workload Identity 集區檢視者 (
roles/iam.workloadIdentityPoolViewer) -
如要查看、建立、更新及刪除集區和提供者:IAM Workload Identity 集區管理員 (
roles/iam.workloadIdentityPoolAdmin)
如要進一步瞭解如何授予角色,請參閱「管理專案、資料夾和組織的存取權」。
這些預先定義的角色具備管理 workload identity pool 和提供者所需的權限。如要查看確切的必要權限,請展開「Required permissions」(必要權限) 部分:
所需權限
必須具備下列權限,才能管理 workload identity pool 和提供者:
-
如要查看 workload identity pool 和提供者,請按照下列步驟操作:
-
iam.googleapis.com/workloadIdentityPoolProviders.get -
iam.googleapis.com/workloadIdentityPoolProviders.list -
iam.googleapis.com/workloadIdentityPools.get -
iam.googleapis.com/workloadIdentityPools.list
-
-
如要建立、更新及刪除集區和提供者,請按照下列步驟操作:
-
iam.googleapis.com/workloadIdentityPoolProviders.create -
iam.googleapis.com/workloadIdentityPoolProviders.delete -
iam.googleapis.com/workloadIdentityPoolProviders.undelete -
iam.googleapis.com/workloadIdentityPoolProviders.update -
iam.googleapis.com/workloadIdentityPools.create -
iam.googleapis.com/workloadIdentityPools.delete -
iam.googleapis.com/workloadIdentityPools.undelete -
iam.googleapis.com/workloadIdentityPools.update
-
管理 workload identity pool
本節說明如何管理 workload identity pool。
建立集區
如要在專案中建立 workload identity pool,請按照下列步驟操作:
控制台
-
前往 Google Cloud 控制台的「New workload provider and pool」(新增工作負載提供者和集區) 頁面。
-
在「Create an identity pool」(建立身分集區) 區段中,輸入集區名稱。
Google Cloud 控制台會使用這個名稱建立集區 ID。如要變更集區 ID,請按一下「Edit」(編輯)。集區 ID 設定後即無法變更。
- 選用:在「Description」(說明) 欄位中輸入集區說明。
- 選用:如要在停用狀態下建立集區,請按一下「Enabled pool」(已啟用集區) 切換鈕。
- 按一下「繼續」。
- 在「Add a provider to pool」(將提供者新增至集區) 和「Configure provider attributes」(設定提供者屬性) 區段中,為集區設定識別資訊提供者。如需操作說明,請參閱「建立提供者」。
- 按一下「儲存」。
gcloud
gcloud iam workload-identity-pools create 指令會在專案中建立 workload identity pool。
使用下列任何指令資料前,請先替換以下項目:
POOL_ID:workload identity pool 的專屬 ID,例如my-pool。必須是 4 到 32 個小寫英數字元或連字號,且開頭不得為gcp-。PROJECT_ID:您的 Google Cloud 專案 ID。專案 ID 是英數字串,例如my-project。DISPLAY_NAME:選用。workload identity pool 的顯示名稱,最多 32 個字元,例如My workload pool。DESCRIPTION:選用。workload identity pool 的說明,最多 256 個字元。
執行下列指令:
Linux、macOS 或 Cloud Shell
gcloud iam workload-identity-pools create POOL_ID \ --project=PROJECT_ID \ --location="global" \ --display-name="DISPLAY_NAME" \ --description="DESCRIPTION"
Windows (PowerShell)
gcloud iam workload-identity-pools create POOL_ID ` --project=PROJECT_ID ` --location="global" ` --display-name="DISPLAY_NAME" ` --description="DESCRIPTION"
Windows (cmd.exe)
gcloud iam workload-identity-pools create POOL_ID ^ --project=PROJECT_ID ^ --location="global" ^ --display-name="DISPLAY_NAME" ^ --description="DESCRIPTION"
您應該會收到類似以下的回應:
Create request issued for: [my-pool] Waiting for operation [projects/123456789012/locations/global/workloadIdentityPools/my-pool/operations/operation-1700000000000-0123456789abcdef] to complete...done. Created workloadIdentityPool [my-pool].
REST
projects.locations.workloadIdentityPools.create 方法會在專案中建立 workload identity pool。
使用任何要求資料之前,請先修改下列項目的值:
PROJECT_ID:您的 Google Cloud 專案 ID。專案 ID 是英數字串,例如my-project。POOL_ID:workload identity pool 的專屬 ID,例如my-pool。必須是 4 到 32 個小寫英數字元或連字號,且開頭不得為gcp-。DISPLAY_NAME:選用。workload identity pool 的顯示名稱,最多 32 個字元,例如My workload pool。DESCRIPTION:選用。workload identity pool 的說明,最多 256 個字元。
HTTP 方法和網址:
POST https://iam.googleapis.com/v1/projects/PROJECT_ID/locations/global/workloadIdentityPools?workloadIdentityPoolId=POOL_ID
JSON 要求主體:
{
"displayName": "DISPLAY_NAME",
"description": "DESCRIPTION"
}
請展開以下其中一個選項,以傳送要求:
回應會包含代表要求的長時間執行的作業。如要確認集區是否建立完成,請參閱本頁的「查看長時間執行的作業狀態」一節。
{
"name": "projects/123456789012/locations/global/workloadIdentityPools/my-pool/operations/operation-1700000000000-0123456789abcdef",
"metadata": {
"@type": "type.googleapis.com/google.iam.v1.WorkloadIdentityPoolOperationMetadata"
},
"done": false
}
列出集區
如要列出專案中的所有 workload identity pool,請按照下列步驟操作:
控制台
-
前往 Google Cloud 控制台的「Workload Identity Pools」頁面。
- 在表格中查看 workload identity pool 清單。
- 選用:如要在清單中加入已刪除的集區和提供者,請按一下「Show deleted pools and providers」(顯示已刪除的集區和提供者) 切換鈕。
gcloud
gcloud iam workload-identity-pools list 指令會列出專案中的 workload identity pool。
使用下列任何指令資料前,請先替換以下項目:
-
PROJECT_ID:您的 Google Cloud 專案 ID。專案 ID 是英數字串,例如my-project。如要在輸出內容中加入虛刪除的集區,請新增--show-deleted旗標。
執行下列指令:
Linux、macOS 或 Cloud Shell
gcloud iam workload-identity-pools list \ --project=PROJECT_ID \ --location="global" \ --format="json"
Windows (PowerShell)
gcloud iam workload-identity-pools list ` --project=PROJECT_ID ` --location="global" ` --format="json"
Windows (cmd.exe)
gcloud iam workload-identity-pools list ^ --project=PROJECT_ID ^ --location="global" ^ --format="json"
您應該會收到類似以下的回應:
[
{
"description": "Workload identity pool for external workloads.",
"displayName": "My workload pool",
"name": "projects/123456789012/locations/global/workloadIdentityPools/my-pool",
"state": "ACTIVE"
}
]
REST
projects.locations.workloadIdentityPools.list 方法會列出專案中的 workload identity pool。
使用任何要求資料之前,請先修改下列項目的值:
-
PROJECT_ID:您的 Google Cloud 專案 ID。專案 ID 是英數字串,例如my-project。如要在回應中加入虛刪除的集區,請將?showDeleted=true附加至要求網址。
HTTP 方法和網址:
GET https://iam.googleapis.com/v1/projects/PROJECT_ID/locations/global/workloadIdentityPools
請展開以下其中一個選項,以傳送要求:
您應該會收到如下的 JSON 回覆:
{
"workloadIdentityPools": [
{
"name": "projects/123456789012/locations/global/workloadIdentityPools/my-pool",
"displayName": "My workload pool",
"description": "Workload identity pool for external workloads.",
"state": "ACTIVE"
}
]
}
取得集區
如要取得特定 workload identity pool 的詳細資料,請按照下列步驟操作:
控制台
-
前往 Google Cloud 控制台的「Workload Identity Pools」頁面。
- 找出要查看的工作負載身分集區,然後按一下其顯示名稱。 Google Cloud 控制台會顯示 workload identity pool 的詳細資料。
gcloud
gcloud iam workload-identity-pools describe 指令會取得 workload identity pool 的詳細資料。
使用下列任何指令資料前,請先替換以下項目:
POOL_ID:workload identity pool 的 ID,例如my-pool。PROJECT_ID:您的 Google Cloud 專案 ID。專案 ID 是英數字串,例如my-project。
執行下列指令:
Linux、macOS 或 Cloud Shell
gcloud iam workload-identity-pools describe POOL_ID \ --project=PROJECT_ID \ --location="global" \ --format="json"
Windows (PowerShell)
gcloud iam workload-identity-pools describe POOL_ID ` --project=PROJECT_ID ` --location="global" ` --format="json"
Windows (cmd.exe)
gcloud iam workload-identity-pools describe POOL_ID ^ --project=PROJECT_ID ^ --location="global" ^ --format="json"
您應該會收到類似以下的回應:
{
"name": "projects/123456789012/locations/global/workloadIdentityPools/my-pool",
"displayName": "My workload pool",
"description": "Workload identity pool for external workloads.",
"state": "ACTIVE"
}
REST
projects.locations.workloadIdentityPools.get 方法會取得 workload identity pool 的詳細資料。
使用任何要求資料之前,請先修改下列項目的值:
PROJECT_ID:您的 Google Cloud 專案 ID。專案 ID 是英數字串,例如my-project。POOL_ID:workload identity pool 的 ID,例如my-pool。
HTTP 方法和網址:
GET https://iam.googleapis.com/v1/projects/PROJECT_ID/locations/global/workloadIdentityPools/POOL_ID
請展開以下其中一個選項,以傳送要求:
您應該會收到如下的 JSON 回覆:
{
"name": "projects/123456789012/locations/global/workloadIdentityPools/my-pool",
"displayName": "My workload pool",
"description": "Workload identity pool for external workloads.",
"state": "ACTIVE"
}
更新集區
您可以啟用或停用 workload identity pool。您也可以變更顯示名稱或說明。
如要更新現有的 workload identity pool,請按照下列步驟操作:
控制台
-
前往 Google Cloud 控制台的「Workload Identity Pools」頁面。
- 找出要編輯的 workload identity pool。
- 按一下 workload identity pool 的顯示名稱。
-
如要編輯 workload identity pool 的顯示名稱,請按照下列步驟操作:
- 在「Pool details」(集區詳細資料) 頁面中,按一下顯示名稱旁的 「Edit」(編輯) 圖示。
- 在隨即顯示的「Edit pool display name」(編輯集區顯示名稱) 對話方塊中,更新顯示名稱。
- 按一下「儲存」。
- 如要停用或啟用 workload identity pool,請按一下「Status」(狀態) 切換鈕,然後點選「Disable」(停用) 或「Enable」(啟用)。
-
如要編輯說明,請按照下列步驟操作:
- 在「說明」中,按一下說明文字旁的 「編輯」。
- 更新說明。
- 按一下「儲存」。
gcloud
gcloud iam workload-identity-pools update 指令會更新現有的 workload identity pool。
使用下列任何指令資料前,請先替換以下項目:
POOL_ID:workload identity pool 的 ID,例如my-pool。PROJECT_ID:您的 Google Cloud 專案 ID。專案 ID 是英數字串,例如my-project。DISPLAY_NAME:workload identity pool 的顯示名稱,最多 32 個字元,例如My updated pool。-
DESCRIPTION:workload identity pool 的說明,最多 256 個半形字元。如要停用或啟用集區,請一併傳遞--disabled或--no-disabled旗標。
執行下列指令:
Linux、macOS 或 Cloud Shell
gcloud iam workload-identity-pools update POOL_ID \ --project=PROJECT_ID \ --location="global" \ --display-name="DISPLAY_NAME" \ --description="DESCRIPTION"
Windows (PowerShell)
gcloud iam workload-identity-pools update POOL_ID ` --project=PROJECT_ID ` --location="global" ` --display-name="DISPLAY_NAME" ` --description="DESCRIPTION"
Windows (cmd.exe)
gcloud iam workload-identity-pools update POOL_ID ^ --project=PROJECT_ID ^ --location="global" ^ --display-name="DISPLAY_NAME" ^ --description="DESCRIPTION"
您應該會收到類似以下的回應:
Update request issued for: [my-pool] Waiting for operation [projects/123456789012/locations/global/workloadIdentityPools/my-pool/operations/operation-1700000000001-0123456789abcdef] to complete...done. Updated workloadIdentityPool [my-pool].
REST
projects.locations.workloadIdentityPools.patch 方法會更新現有的 workload identity pool。
使用任何要求資料之前,請先修改下列項目的值:
PROJECT_ID:您的 Google Cloud 專案 ID。專案 ID 是英數字串,例如my-project。POOL_ID:workload identity pool 的 ID,例如my-pool。UPDATE_MASK:以半形逗號分隔的更新欄位清單,例如displayName,description,disabled。DISPLAY_NAME:workload identity pool 的顯示名稱,最多 32 個字元,例如My updated pool。DESCRIPTION:workload identity pool 的說明,最多 256 個字元。DISABLED:集區是否已停用。設為true即可停用集區,設為false則可啟用。
HTTP 方法和網址:
PATCH https://iam.googleapis.com/v1/projects/PROJECT_ID/locations/global/workloadIdentityPools/POOL_ID?updateMask=UPDATE_MASK
JSON 要求主體:
{
"displayName": "DISPLAY_NAME",
"description": "DESCRIPTION",
"disabled": DISABLED
}
請展開以下其中一個選項,以傳送要求:
回應會包含代表要求的長時間執行的作業。如要確認集區更新是否完成,請參閱本頁的「查看長時間執行的作業狀態」一節。
{
"name": "projects/123456789012/locations/global/workloadIdentityPools/my-pool/operations/operation-1700000000001-0123456789abcdef",
"metadata": {
"@type": "type.googleapis.com/google.iam.v1.WorkloadIdentityPoolOperationMetadata"
},
"done": false
}
刪除集區
刪除 workload identity pool 時,也會一併刪除其 workload identity pool 提供者。因此,集區中的身分會失去Google Cloud 資源的存取權。
您可以在刪除集區後的 30 天內取消刪除集區。30 天後,系統會永久刪除資料。在集區永久刪除之前,您無法在建立新的 workload identity pool 時重複使用其名稱。
如要刪除 workload identity pool 及其 IdP,請按照下列步驟操作:
控制台
-
前往 Google Cloud 控制台的「Workload Identity Pools」頁面。
- 找出要刪除的工作負載身分集區,然後按一下其顯示名稱。
- 依序點選「 刪除集區」和「刪除」。workload identity pool 及其 IdP 會遭到刪除。
gcloud
gcloud iam workload-identity-pools delete 指令會刪除 workload identity pool。
使用下列任何指令資料前,請先替換以下項目:
POOL_ID:要刪除的 workload identity pool ID,例如my-pool。PROJECT_ID:您的 Google Cloud 專案 ID。專案 ID 是英數字串,例如my-project。
執行下列指令:
Linux、macOS 或 Cloud Shell
gcloud iam workload-identity-pools delete POOL_ID \ --project=PROJECT_ID \ --location="global"
Windows (PowerShell)
gcloud iam workload-identity-pools delete POOL_ID ` --project=PROJECT_ID ` --location="global"
Windows (cmd.exe)
gcloud iam workload-identity-pools delete POOL_ID ^ --project=PROJECT_ID ^ --location="global"
您應該會收到類似以下的回應:
Delete request issued for: [my-pool] Waiting for operation [projects/123456789012/locations/global/workloadIdentityPools/my-pool/operations/operation-1700000000002-0123456789abcdef] to complete...done. Deleted workloadIdentityPool [my-pool].
REST
projects.locations.workloadIdentityPools.delete 方法會刪除 workload identity pool。
使用任何要求資料之前,請先修改下列項目的值:
PROJECT_ID:您的 Google Cloud 專案 ID。專案 ID 是英數字串,例如my-project。POOL_ID:要刪除的 workload identity pool ID,例如my-pool。
HTTP 方法和網址:
DELETE https://iam.googleapis.com/v1/projects/PROJECT_ID/locations/global/workloadIdentityPools/POOL_ID
請展開以下其中一個選項,以傳送要求:
回應會包含代表要求的長時間執行的作業。如要確認集區是否已刪除,請參閱本頁的「查看長時間執行的作業狀態」一節。
{
"name": "projects/123456789012/locations/global/workloadIdentityPools/my-pool/operations/operation-1700000000002-0123456789abcdef",
"metadata": {
"@type": "type.googleapis.com/google.iam.v1.WorkloadIdentityPoolOperationMetadata"
},
"done": false
}
取消刪除集區
刪除 workload identity pool 後,您可以在 30 天內復原。
如要取消刪除集區,請按照下列步驟操作:
控制台
-
前往 Google Cloud 控制台的「Workload Identity Pools」頁面。
- 點選「顯示已刪除的集區和提供者」切換鈕。
- 找出要取消刪除的 workload identity pool,然後按一下 「Restore」(還原) 圖示。
- 按一下「還原」。集區及其提供者已還原。
gcloud
gcloud iam workload-identity-pools undelete 指令會還原虛刪除的 workload identity pool。
使用下列任何指令資料前,請先替換以下項目:
POOL_ID:要還原的已刪除 workload identity pool ID,例如my-pool。PROJECT_ID:您的 Google Cloud 專案 ID。專案 ID 是英數字串,例如my-project。
執行下列指令:
Linux、macOS 或 Cloud Shell
gcloud iam workload-identity-pools undelete POOL_ID \ --project=PROJECT_ID \ --location="global"
Windows (PowerShell)
gcloud iam workload-identity-pools undelete POOL_ID ` --project=PROJECT_ID ` --location="global"
Windows (cmd.exe)
gcloud iam workload-identity-pools undelete POOL_ID ^ --project=PROJECT_ID ^ --location="global"
您應該會收到類似以下的回應:
Undelete request issued for: [my-pool] Waiting for operation [projects/123456789012/locations/global/workloadIdentityPools/my-pool/operations/operation-1700000000003-0123456789abcdef] to complete...done. Undeleted workloadIdentityPool [my-pool].
REST
projects.locations.workloadIdentityPools.undelete 方法會還原虛刪除的 workload identity pool。
使用任何要求資料之前,請先修改下列項目的值:
PROJECT_ID:您的 Google Cloud 專案 ID。專案 ID 是英數字串,例如my-project。POOL_ID:要還原的已刪除 workload identity pool ID,例如my-pool。
HTTP 方法和網址:
POST https://iam.googleapis.com/v1/projects/PROJECT_ID/locations/global/workloadIdentityPools/POOL_ID:undelete
JSON 要求主體:
{}
請展開以下其中一個選項,以傳送要求:
回應會包含代表要求的長時間執行的作業。如要確認集區還原作業是否完成,請參閱本頁的「查看長時間執行的作業狀態」一節。
{
"name": "projects/123456789012/locations/global/workloadIdentityPools/my-pool/operations/operation-1700000000003-0123456789abcdef",
"metadata": {
"@type": "type.googleapis.com/google.iam.v1.WorkloadIdentityPoolOperationMetadata"
},
"done": false
}
管理 workload identity pool 提供者
本節說明如何管理 workload identity pool 提供者。
建立提供者
如要在現有的 workload identity pool 中建立 workload identity pool 提供者,請按照下列步驟操作:
控制台
-
前往 Google Cloud 控制台的「Workload Identity Pools」頁面。
- 找出要新增提供者的 workload identity pool,然後按一下其「Display name」(顯示名稱)。
- 按一下「 新增供應商」。
-
選取要建立的供應商類型:
- AWS:Amazon Web Services (AWS) IdP。
- OpenID Connect (OIDC):與 OIDC 相容的 IdP。包括 Microsoft Azure。
-
輸入提供者名稱。
Google Cloud 控制台會使用這個名稱建立供應商 ID。如要變更提供者 ID,請按一下「Edit」(編輯)。供應商 ID 設定後即無法變更。
-
填寫供應商的其他欄位:
- AWS:輸入 AWS 帳戶 ID。
-
OIDC:輸入核發者網址。如果是 Azure,核發者網址會採用
https://sts.windows.net/AZURE_TENANT_ID格式。如需其他供應商的資訊,請參閱供應商的說明文件。
完成後,按一下「繼續」。
-
如要設定屬性對應,請按一下「Edit mapping」。您可以透過屬性對應,使用外部身分的相關資訊,將存取權授予部分身分。
-
AWS:本步驟為選擇性步驟。您可以使用預設對應。
詳情請參閱「AWS 和 Azure 的識別資訊提供者設定」。
-
OIDC:建議將
google.subject對應至assertion.sub。其他對應則為選用。詳情請參閱 Azure 或其他 OIDC 供應商的 IdP 設定。
-
- 選用:如要提供屬性條件,指定可驗證的身分,請按一下「Add condition」(新增條件),然後輸入有效的通用運算語言 (CEL) 運算式。詳情請參閱「屬性條件」。
- 按一下 [儲存]。workload identity pool 提供者已建立。
gcloud
建立 AWS 提供者
gcloud iam workload-identity-pools providers create-aws 指令會建立 AWS workload identity pool 提供者。
使用下列任何指令資料前,請先替換以下項目:
PROVIDER_ID:供應商的專屬 ID,例如my-aws-provider。必須是 4 到 32 個小寫英數字元或連字號,且開頭不得為gcp-。PROJECT_ID:您的 Google Cloud 專案 ID。專案 ID 是英數字串,例如my-project。POOL_ID:要新增提供者的 workload identity pool ID,例如my-pool。DISPLAY_NAME:選用。提供者的顯示名稱,最多 32 個字元,例如My AWS provider。AWS_ACCOUNT_ID:12 位數的 AWS 帳戶 ID,例如123456789012。ATTRIBUTE_CONDITION:選用。一般運算語言 (CEL) 運算式,用於限制可驗證的身分,例如attribute.aws_role == 'arn:aws:sts::123456789012:assumed-role/my-role'。
執行下列指令:
Linux、macOS 或 Cloud Shell
gcloud iam workload-identity-pools providers create-aws PROVIDER_ID \ --project=PROJECT_ID \ --location="global" \ --workload-identity-pool="POOL_ID" \ --display-name="DISPLAY_NAME" \ --account-id="AWS_ACCOUNT_ID" \ --attribute-condition="ATTRIBUTE_CONDITION"
Windows (PowerShell)
gcloud iam workload-identity-pools providers create-aws PROVIDER_ID ` --project=PROJECT_ID ` --location="global" ` --workload-identity-pool="POOL_ID" ` --display-name="DISPLAY_NAME" ` --account-id="AWS_ACCOUNT_ID" ` --attribute-condition="ATTRIBUTE_CONDITION"
Windows (cmd.exe)
gcloud iam workload-identity-pools providers create-aws PROVIDER_ID ^ --project=PROJECT_ID ^ --location="global" ^ --workload-identity-pool="POOL_ID" ^ --display-name="DISPLAY_NAME" ^ --account-id="AWS_ACCOUNT_ID" ^ --attribute-condition="ATTRIBUTE_CONDITION"
您應該會收到類似以下的回應:
Create request issued for: [my-aws-provider] Waiting for operation [projects/123456789012/locations/global/workloadIdentityPools/my-pool/providers/my-aws-provider/operations/operation-1700000000010-0123456789abcdef] to complete...done. Created workloadIdentityPoolProvider [my-aws-provider].
建立 OIDC 提供者
gcloud iam workload-identity-pools providers create-oidc 指令會建立 OIDC workload identity pool 提供者。
使用下列任何指令資料前,請先替換以下項目:
PROVIDER_ID:供應商的專屬 ID,例如my-oidc-provider。必須是 4 到 32 個小寫英數字元或連字號,且開頭不得為gcp-。PROJECT_ID:您的 Google Cloud 專案 ID。專案 ID 是英數字串,例如my-project。POOL_ID:要新增提供者的 workload identity pool ID,例如my-pool。DISPLAY_NAME:選用。提供者的顯示名稱,最多 32 個字元,例如My OIDC provider。ISSUER_URI:OIDC 核發者 HTTPS 網址,例如https://idp.example.com或https://sts.windows.net/AZURE_TENANT_ID。DISCOVERY_URI:選用。擷取 OIDC 導覽文件的網址,會覆寫預設的ISSUER_URI/.well-known/openid-configuration網址,例如https://idp.example.com/.well-known/custom-openid-configuration。配置、主機和通訊埠必須與ISSUER_URI相符,且路徑必須包含/.well-known/區段,後方則須加上非空白後置字串。ATTRIBUTE_CONDITION:選用。一般運算語言 (CEL) 運算式,用於限制可驗證的身分,例如assertion.sub.startsWith('repo:my-org/')。ACTOR_PROVIDERS:選用。最多三個 workload identity pool 提供者的完整資源名稱,這些提供者位於同一個集區,且有權為這個提供者核發 actor 權杖,例如projects/my-project/locations/global/workloadIdentityPools/my-pool/providers/my-actor-provider。每個資源名稱中的專案 ID,都必須符合您用於這個提供者的專案 ID 或專案編號格式。詳情請參閱「設定身分委派和執行者權杖」。
執行下列指令:
Linux、macOS 或 Cloud Shell
gcloud iam workload-identity-pools providers create-oidc PROVIDER_ID \ --project=PROJECT_ID \ --location="global" \ --workload-identity-pool="POOL_ID" \ --display-name="DISPLAY_NAME" \ --issuer-uri="ISSUER_URI" \ --discovery-uri="DISCOVERY_URI" \ --attribute-mapping="google.subject=assertion.sub" \ --attribute-condition="ATTRIBUTE_CONDITION" \ --actor-providers="ACTOR_PROVIDERS"
Windows (PowerShell)
gcloud iam workload-identity-pools providers create-oidc PROVIDER_ID ` --project=PROJECT_ID ` --location="global" ` --workload-identity-pool="POOL_ID" ` --display-name="DISPLAY_NAME" ` --issuer-uri="ISSUER_URI" ` --discovery-uri="DISCOVERY_URI" ` --attribute-mapping="google.subject=assertion.sub" ` --attribute-condition="ATTRIBUTE_CONDITION" ` --actor-providers="ACTOR_PROVIDERS"
Windows (cmd.exe)
gcloud iam workload-identity-pools providers create-oidc PROVIDER_ID ^ --project=PROJECT_ID ^ --location="global" ^ --workload-identity-pool="POOL_ID" ^ --display-name="DISPLAY_NAME" ^ --issuer-uri="ISSUER_URI" ^ --discovery-uri="DISCOVERY_URI" ^ --attribute-mapping="google.subject=assertion.sub" ^ --attribute-condition="ATTRIBUTE_CONDITION" ^ --actor-providers="ACTOR_PROVIDERS"
您應該會收到類似以下的回應:
Create request issued for: [my-oidc-provider] Waiting for operation [projects/123456789012/locations/global/workloadIdentityPools/my-pool/providers/my-oidc-provider/operations/operation-1700000000011-0123456789abcdef] to complete...done. Created workloadIdentityPoolProvider [my-oidc-provider].
REST
建立 AWS 提供者
projects.locations.workloadIdentityPools.providers.create
方法會建立 AWS workload identity pool 提供者。
使用任何要求資料之前,請先修改下列項目的值:
PROJECT_ID:您的 Google Cloud 專案 ID。專案 ID 是英數字串,例如my-project。POOL_ID:要新增提供者的 workload identity pool ID,例如my-pool。PROVIDER_ID:供應商的專屬 ID,例如my-aws-provider。必須是 4 到 32 個小寫英數字元或連字號,且開頭不得為gcp-。DISPLAY_NAME:選用。提供者的顯示名稱,最多 32 個字元,例如My AWS provider。AWS_ACCOUNT_ID:12 位數的 AWS 帳戶 ID,例如123456789012。ATTRIBUTE_CONDITION:選用。一般運算語言 (CEL) 運算式,用於限制可驗證的身分,例如attribute.aws_role == 'arn:aws:sts::123456789012:assumed-role/my-role'。
HTTP 方法和網址:
POST https://iam.googleapis.com/v1/projects/PROJECT_ID/locations/global/workloadIdentityPools/POOL_ID/providers?workloadIdentityPoolProviderId=PROVIDER_ID
JSON 要求主體:
{
"displayName": "DISPLAY_NAME",
"aws": {
"accountId": "AWS_ACCOUNT_ID"
},
"attributeCondition": "ATTRIBUTE_CONDITION"
}
請展開以下其中一個選項,以傳送要求:
回應會包含代表要求的長時間執行的作業。如要確認供應商是否建立完成,請參閱本頁面的「查看長時間執行的作業狀態」一節。
{
"name": "projects/123456789012/locations/global/workloadIdentityPools/my-pool/providers/my-aws-provider/operations/operation-1700000000010-0123456789abcdef",
"metadata": {
"@type": "type.googleapis.com/google.iam.v1.WorkloadIdentityPoolProviderOperationMetadata"
},
"done": false
}
建立 OIDC 提供者
projects.locations.workloadIdentityPools.providers.create 方法會建立 OIDC workload identity pool 提供者。
使用任何要求資料之前,請先修改下列項目的值:
PROJECT_ID:您的 Google Cloud 專案 ID。專案 ID 是英數字串,例如my-project。POOL_ID:要新增提供者的 workload identity pool ID,例如my-pool。PROVIDER_ID:供應商的專屬 ID,例如my-oidc-provider。必須是 4 到 32 個小寫英數字元或連字號,且開頭不得為gcp-。DISPLAY_NAME:選用。提供者的顯示名稱,最多 32 個字元,例如My OIDC provider。ISSUER_URI:OIDC 核發者 HTTPS 網址,例如https://idp.example.com或https://sts.windows.net/AZURE_TENANT_ID。DISCOVERY_URI:選用。擷取 OIDC 導覽文件的網址,會覆寫預設的ISSUER_URI/.well-known/openid-configuration網址,例如https://idp.example.com/.well-known/custom-openid-configuration。配置、主機和通訊埠必須與ISSUER_URI相符,且路徑必須包含/.well-known/區段,後方則須加上非空白後置字串。ATTRIBUTE_CONDITION:選用。一般運算語言 (CEL) 運算式,用於限制可驗證的身分,例如assertion.sub.startsWith('repo:my-org/')。ACTOR_PROVIDERS:選用。最多三個 workload identity pool 提供者的完整資源名稱,這些提供者位於同一個集區,且有權為這個提供者核發 actor 權杖,例如projects/my-project/locations/global/workloadIdentityPools/my-pool/providers/my-actor-provider。每個資源名稱中的專案 ID,都必須符合您用於這個提供者的專案 ID 或專案編號格式。詳情請參閱「設定身分委派和執行者權杖」。
HTTP 方法和網址:
POST https://iam.googleapis.com/v1/projects/PROJECT_ID/locations/global/workloadIdentityPools/POOL_ID/providers?workloadIdentityPoolProviderId=PROVIDER_ID
JSON 要求主體:
{
"displayName": "DISPLAY_NAME",
"oidc": {
"issuerUri": "ISSUER_URI",
"discoveryUri": "DISCOVERY_URI"
},
"attributeMapping": {
"google.subject": "assertion.sub"
},
"attributeCondition": "ATTRIBUTE_CONDITION",
"actorProviders": [
"ACTOR_PROVIDERS"
]
}
請展開以下其中一個選項,以傳送要求:
回應會包含代表要求的長時間執行的作業。如要確認供應商是否建立完成,請參閱本頁面的「查看長時間執行的作業狀態」一節。
{
"name": "projects/123456789012/locations/global/workloadIdentityPools/my-pool/providers/my-oidc-provider/operations/operation-1700000000011-0123456789abcdef",
"metadata": {
"@type": "type.googleapis.com/google.iam.v1.WorkloadIdentityPoolProviderOperationMetadata"
},
"done": false
}
列出供應商
如要列出專案中的 workload identity pool 提供者,請按照下列步驟操作:
控制台
-
前往 Google Cloud 控制台的「Workload Identity Pools」頁面。
- 如要查看 workload identity pool 的提供者,請按一下集區的 「Expand node」(展開節點) 圖示。
gcloud
gcloud iam workload-identity-pools providers list 指令會列出 workload identity pool 中的提供者。
使用下列任何指令資料前,請先替換以下項目:
PROJECT_ID:您的 Google Cloud 專案 ID。專案 ID 是英數字串,例如my-project。-
POOL_ID:要列出供應商的 workload identity pool ID,例如my-pool。如要在輸出內容中加入虛刪除的供應商,請新增--show-deleted旗標。
執行下列指令:
Linux、macOS 或 Cloud Shell
gcloud iam workload-identity-pools providers list \ --project=PROJECT_ID \ --location="global" \ --workload-identity-pool="POOL_ID" \ --format="json"
Windows (PowerShell)
gcloud iam workload-identity-pools providers list ` --project=PROJECT_ID ` --location="global" ` --workload-identity-pool="POOL_ID" ` --format="json"
Windows (cmd.exe)
gcloud iam workload-identity-pools providers list ^ --project=PROJECT_ID ^ --location="global" ^ --workload-identity-pool="POOL_ID" ^ --format="json"
您應該會收到類似以下的回應:
[
{
"attributeMapping": {
"google.subject": "assertion.sub"
},
"displayName": "My OIDC provider",
"name": "projects/123456789012/locations/global/workloadIdentityPools/my-pool/providers/my-oidc-provider",
"oidc": {
"issuerUri": "https://idp.example.com"
},
"state": "ACTIVE"
}
]
REST
projects.locations.workloadIdentityPools.providers.list 方法會列出 workload identity pool 中的提供者。
使用任何要求資料之前,請先修改下列項目的值:
PROJECT_ID:您的 Google Cloud 專案 ID。專案 ID 是英數字串,例如my-project。-
POOL_ID:要列出供應商的 workload identity pool ID,例如my-pool。如要在回應中加入虛刪除的供應商,請在要求網址中附加?showDeleted=true。
HTTP 方法和網址:
GET https://iam.googleapis.com/v1/projects/PROJECT_ID/locations/global/workloadIdentityPools/POOL_ID/providers
請展開以下其中一個選項,以傳送要求:
您應該會收到如下的 JSON 回覆:
{
"workloadIdentityPoolProviders": [
{
"name": "projects/123456789012/locations/global/workloadIdentityPools/my-pool/providers/my-oidc-provider",
"displayName": "My OIDC provider",
"state": "ACTIVE",
"attributeMapping": {
"google.subject": "assertion.sub"
},
"oidc": {
"issuerUri": "https://idp.example.com"
}
}
]
}
取得供應商
如要取得特定 workload identity pool 提供者的詳細資料,請按照下列步驟操作:
控制台
-
前往 Google Cloud 控制台的「Workload Identity Pools」頁面。
- 找出包含提供者的 workload identity pool,然後按一下該集區的 「Expand node」(展開節點) 圖示。
- 找出要查看的 workload identity pool provider,然後按一下其 「Edit」(編輯) 圖示。 Google Cloud 控制台會顯示供應商的詳細資訊。
gcloud
gcloud iam workload-identity-pools providers describe 指令會取得 workload identity pool 提供者的詳細資料。
使用下列任何指令資料前,請先替換以下項目:
PROVIDER_ID:workload identity pool 提供者的 ID,例如my-oidc-provider。PROJECT_ID:您的 Google Cloud 專案 ID。專案 ID 是英數字串,例如my-project。POOL_ID:包含提供者的 workload identity pool ID,例如my-pool。
執行下列指令:
Linux、macOS 或 Cloud Shell
gcloud iam workload-identity-pools providers describe PROVIDER_ID \ --project=PROJECT_ID \ --location="global" \ --workload-identity-pool="POOL_ID" \ --format="json"
Windows (PowerShell)
gcloud iam workload-identity-pools providers describe PROVIDER_ID ` --project=PROJECT_ID ` --location="global" ` --workload-identity-pool="POOL_ID" ` --format="json"
Windows (cmd.exe)
gcloud iam workload-identity-pools providers describe PROVIDER_ID ^ --project=PROJECT_ID ^ --location="global" ^ --workload-identity-pool="POOL_ID" ^ --format="json"
您應該會收到類似以下的回應:
{
"name": "projects/123456789012/locations/global/workloadIdentityPools/my-pool/providers/my-oidc-provider",
"displayName": "My OIDC provider",
"state": "ACTIVE",
"attributeMapping": {
"google.subject": "assertion.sub"
},
"oidc": {
"issuerUri": "https://idp.example.com"
}
}
REST
projects.locations.workloadIdentityPools.providers.get 方法會取得 workload identity pool 提供者的詳細資料。
使用任何要求資料之前,請先修改下列項目的值:
PROJECT_ID:您的 Google Cloud 專案 ID。專案 ID 是英數字串,例如my-project。POOL_ID:包含提供者的 workload identity pool ID,例如my-pool。PROVIDER_ID:workload identity pool 提供者的 ID,例如my-oidc-provider。
HTTP 方法和網址:
GET https://iam.googleapis.com/v1/projects/PROJECT_ID/locations/global/workloadIdentityPools/POOL_ID/providers/PROVIDER_ID
請展開以下其中一個選項,以傳送要求:
您應該會收到如下的 JSON 回覆:
{
"name": "projects/123456789012/locations/global/workloadIdentityPools/my-pool/providers/my-oidc-provider",
"displayName": "My OIDC provider",
"state": "ACTIVE",
"attributeMapping": {
"google.subject": "assertion.sub"
},
"oidc": {
"issuerUri": "https://idp.example.com"
}
}
更新提供者
您可以啟用或停用 workload identity pool 提供者。您也可以更新帳戶資訊、屬性對應、顯示名稱和說明。
如要更新現有的 workload identity pool 提供者,請按照下列步驟操作:
控制台
前往 Google Cloud 控制台的「Workload Identity Pools」頁面。
找出包含提供者的 workload identity pool,然後按一下該集區的 「Expand node」(展開節點) 圖示。
找出要編輯的 workload identity pool 提供者,然後按一下「 Edit」(編輯) 圖示。
編輯供應商資訊,然後按一下「儲存」。
gcloud
更新 AWS 供應商
gcloud iam workload-identity-pools providers update-aws 指令會更新現有的 AWS workload identity pool 提供者。
使用下列任何指令資料前,請先替換以下項目:
PROVIDER_ID:要更新的供應商 ID,例如my-aws-provider。PROJECT_ID:您的 Google Cloud 專案 ID。專案 ID 是英數字串,例如my-project。POOL_ID:包含提供者的 workload identity pool ID,例如my-pool。DISPLAY_NAME:供應商的顯示名稱,最多 32 個字元,例如Updated AWS provider。-
DESCRIPTION:提供者的說明,最多 256 個字元。如要停用或啟用供應器,請一併傳遞--disabled或--no-disabled旗標。
執行下列指令:
Linux、macOS 或 Cloud Shell
gcloud iam workload-identity-pools providers update-aws PROVIDER_ID \ --project=PROJECT_ID \ --location="global" \ --workload-identity-pool="POOL_ID" \ --display-name="DISPLAY_NAME" \ --description="DESCRIPTION"
Windows (PowerShell)
gcloud iam workload-identity-pools providers update-aws PROVIDER_ID ` --project=PROJECT_ID ` --location="global" ` --workload-identity-pool="POOL_ID" ` --display-name="DISPLAY_NAME" ` --description="DESCRIPTION"
Windows (cmd.exe)
gcloud iam workload-identity-pools providers update-aws PROVIDER_ID ^ --project=PROJECT_ID ^ --location="global" ^ --workload-identity-pool="POOL_ID" ^ --display-name="DISPLAY_NAME" ^ --description="DESCRIPTION"
您應該會收到類似以下的回應:
Update request issued for: [my-aws-provider] Waiting for operation [projects/123456789012/locations/global/workloadIdentityPools/my-pool/providers/my-aws-provider/operations/operation-1700000000012-0123456789abcdef] to complete...done. Updated workloadIdentityPoolProvider [my-aws-provider].
更新 OIDC 提供者
gcloud iam workload-identity-pools providers update-oidc 指令會更新現有的 AWS workload identity pool 提供者。
使用下列任何指令資料前,請先替換以下項目:
PROVIDER_ID:要更新的 OIDC 提供者 ID,例如my-oidc-provider。PROJECT_ID:您的 Google Cloud 專案 ID。專案 ID 是英數字串,例如my-project。POOL_ID:包含提供者的 workload identity pool ID,例如my-pool。DISPLAY_NAME:供應商的顯示名稱,最多 32 個字元,例如Updated OIDC provider。DESCRIPTION:提供者的說明,最多 256 個字元。-
ISSUER_URI:OIDC 核發者 HTTPS 網址,例如https://idp.example.com。如要停用或啟用供應器,請一併傳遞--disabled或--no-disabled旗標。
執行下列指令:
Linux、macOS 或 Cloud Shell
gcloud iam workload-identity-pools providers update-oidc PROVIDER_ID \ --project=PROJECT_ID \ --location="global" \ --workload-identity-pool="POOL_ID" \ --display-name="DISPLAY_NAME" \ --description="DESCRIPTION" \ --issuer-uri="ISSUER_URI"
Windows (PowerShell)
gcloud iam workload-identity-pools providers update-oidc PROVIDER_ID ` --project=PROJECT_ID ` --location="global" ` --workload-identity-pool="POOL_ID" ` --display-name="DISPLAY_NAME" ` --description="DESCRIPTION" ` --issuer-uri="ISSUER_URI"
Windows (cmd.exe)
gcloud iam workload-identity-pools providers update-oidc PROVIDER_ID ^ --project=PROJECT_ID ^ --location="global" ^ --workload-identity-pool="POOL_ID" ^ --display-name="DISPLAY_NAME" ^ --description="DESCRIPTION" ^ --issuer-uri="ISSUER_URI"
您應該會收到類似以下的回應:
Update request issued for: [my-oidc-provider] Waiting for operation [projects/123456789012/locations/global/workloadIdentityPools/my-pool/providers/my-oidc-provider/operations/operation-1700000000013-0123456789abcdef] to complete...done. Updated workloadIdentityPoolProvider [my-oidc-provider].
REST
projects.locations.workloadIdentityPools.providers.patch 方法會更新現有的 workload identity pool 提供者。
使用任何要求資料之前,請先修改下列項目的值:
PROJECT_ID:您的 Google Cloud 專案 ID。專案 ID 是英數字串,例如my-project。POOL_ID:包含提供者的 workload identity pool ID,例如my-pool。PROVIDER_ID:要更新的供應商 ID,例如my-aws-provider。UPDATE_MASK:以半形逗號分隔的清單,列出要更新的欄位,例如displayName,description,disabled。DISPLAY_NAME:供應商的顯示名稱,最多 32 個字元,例如Updated AWS provider。DESCRIPTION:提供者的說明,最多 256 個字元。DISABLED:供應器是否已停用。設為true可停用供應器,設為false則可啟用。
HTTP 方法和網址:
PATCH https://iam.googleapis.com/v1/projects/PROJECT_ID/locations/global/workloadIdentityPools/POOL_ID/providers/PROVIDER_ID?updateMask=UPDATE_MASK
JSON 要求主體:
{
"displayName": "DISPLAY_NAME",
"description": "DESCRIPTION",
"disabled": DISABLED
}
請展開以下其中一個選項,以傳送要求:
回應會包含代表要求的長時間執行的作業。如要確認供應商更新是否完成,請參閱本頁的「查看長時間執行的作業狀態」一節。
{
"name": "projects/123456789012/locations/global/workloadIdentityPools/my-pool/providers/my-aws-provider/operations/operation-1700000000012-0123456789abcdef",
"metadata": {
"@type": "type.googleapis.com/google.iam.v1.WorkloadIdentityPoolProviderOperationMetadata"
},
"done": false
}
刪除提供者
刪除 workload identity pool 提供者後,該提供者的身分將無法存取 Google Cloud 資源。
您可以在刪除提供者後的 30 天內取消刪除。30 天後,系統會永久刪除。在永久刪除提供者之前,您無法在建立新提供者時重複使用其名稱。
如要刪除 workload identity pool 提供者,請按照下列步驟操作:
控制台
前往 Google Cloud 控制台的「Workload Identity Pools」頁面。
找出包含提供者的 workload identity pool,然後按一下其「Display name」(顯示名稱)。
在「Providers」(供應商) 窗格中,找出要刪除的供應商,然後按一下「Delete」(刪除) 圖示 。
按一下「刪除」即可刪除提供者。
gcloud
gcloud iam workload-identity-pools providers delete 指令會刪除 workload identity pool 提供者。
使用下列任何指令資料前,請先替換以下項目:
PROVIDER_ID:要刪除的 workload identity pool 提供者 ID,例如my-oidc-provider。PROJECT_ID:您的 Google Cloud 專案 ID。專案 ID 是英數字串,例如my-project。POOL_ID:包含提供者的 workload identity pool ID,例如my-pool。
執行下列指令:
Linux、macOS 或 Cloud Shell
gcloud iam workload-identity-pools providers delete PROVIDER_ID \ --project=PROJECT_ID \ --location="global" \ --workload-identity-pool="POOL_ID"
Windows (PowerShell)
gcloud iam workload-identity-pools providers delete PROVIDER_ID ` --project=PROJECT_ID ` --location="global" ` --workload-identity-pool="POOL_ID"
Windows (cmd.exe)
gcloud iam workload-identity-pools providers delete PROVIDER_ID ^ --project=PROJECT_ID ^ --location="global" ^ --workload-identity-pool="POOL_ID"
您應該會收到類似以下的回應:
Delete request issued for: [my-oidc-provider] Waiting for operation [projects/123456789012/locations/global/workloadIdentityPools/my-pool/providers/my-oidc-provider/operations/operation-1700000000014-0123456789abcdef] to complete...done. Deleted workloadIdentityPoolProvider [my-oidc-provider].
REST
projects.locations.workloadIdentityPools.providers.delete 方法會刪除 workload identity pool 提供者。
使用任何要求資料之前,請先修改下列項目的值:
PROJECT_ID:您的 Google Cloud 專案 ID。專案 ID 是英數字串,例如my-project。POOL_ID:包含提供者的 workload identity pool ID,例如my-pool。PROVIDER_ID:要刪除的 workload identity pool 提供者 ID,例如my-oidc-provider。
HTTP 方法和網址:
DELETE https://iam.googleapis.com/v1/projects/PROJECT_ID/locations/global/workloadIdentityPools/POOL_ID/providers/PROVIDER_ID
請展開以下其中一個選項,以傳送要求:
回應會包含代表要求的長時間執行的作業。如要確認供應商是否已刪除完畢,請參閱本頁的「查看長時間執行的作業狀態」一節。
{
"name": "projects/123456789012/locations/global/workloadIdentityPools/my-pool/providers/my-oidc-provider/operations/operation-1700000000014-0123456789abcdef",
"metadata": {
"@type": "type.googleapis.com/google.iam.v1.WorkloadIdentityPoolProviderOperationMetadata"
},
"done": false
}
取消刪除提供者
刪除 workload identity pool 提供者後,您可以在 30 天內復原。如要取消刪除供應商,請按照下列步驟操作:
控制台
前往 Google Cloud 控制台的「Workload Identity Pools」頁面。
點選「顯示已刪除的集區和提供者」切換鈕。
找出包含提供者的 workload identity pool,然後按一下該集區的 「Expand node」(展開節點) 圖示。
找出要取消刪除的供應商,然後按一下其 「Restore」(還原) 圖示。
按一下「還原」。供應商已還原。
gcloud
gcloud iam workload-identity-pools providers undelete 指令會還原虛刪除的 workload identity pool 提供者。
使用下列任何指令資料前,請先替換以下項目:
PROVIDER_ID:要還原的已刪除 workload identity pool 提供者 ID,例如my-oidc-provider。PROJECT_ID:您的 Google Cloud 專案 ID。專案 ID 是英數字串,例如my-project。POOL_ID:包含提供者的 workload identity pool ID,例如my-pool。
執行下列指令:
Linux、macOS 或 Cloud Shell
gcloud iam workload-identity-pools providers undelete PROVIDER_ID \ --project=PROJECT_ID \ --location="global" \ --workload-identity-pool="POOL_ID"
Windows (PowerShell)
gcloud iam workload-identity-pools providers undelete PROVIDER_ID ` --project=PROJECT_ID ` --location="global" ` --workload-identity-pool="POOL_ID"
Windows (cmd.exe)
gcloud iam workload-identity-pools providers undelete PROVIDER_ID ^ --project=PROJECT_ID ^ --location="global" ^ --workload-identity-pool="POOL_ID"
您應該會收到類似以下的回應:
Undelete request issued for: [my-oidc-provider] Waiting for operation [projects/123456789012/locations/global/workloadIdentityPools/my-pool/providers/my-oidc-provider/operations/operation-1700000000015-0123456789abcdef] to complete...done. Undeleted workloadIdentityPoolProvider [my-oidc-provider].
REST
projects.locations.workloadIdentityPools.providers.undelete 方法會還原虛刪除的 workload identity pool 提供者。
使用任何要求資料之前,請先修改下列項目的值:
PROJECT_ID:您的 Google Cloud 專案 ID。專案 ID 是英數字串,例如my-project。POOL_ID:包含提供者的 workload identity pool ID,例如my-pool。PROVIDER_ID:要還原的已刪除 workload identity pool 提供者 ID,例如my-oidc-provider。
HTTP 方法和網址:
POST https://iam.googleapis.com/v1/projects/PROJECT_ID/locations/global/workloadIdentityPools/POOL_ID/providers/PROVIDER_ID:undelete
JSON 要求主體:
{}
請展開以下其中一個選項,以傳送要求:
回應會包含代表要求的長時間執行的作業。如要確認供應商還原作業是否完成,請參閱本頁的「查看長時間執行的作業狀態」。
{
"name": "projects/123456789012/locations/global/workloadIdentityPools/my-pool/providers/my-oidc-provider/operations/operation-1700000000015-0123456789abcdef",
"metadata": {
"@type": "type.googleapis.com/google.iam.v1.WorkloadIdentityPoolProviderOperationMetadata"
},
"done": false
}
查看長時間執行的作業狀態
使用 REST API 時,任何建立、更新、刪除或還原 workload identity pool 或提供者的方法,都會傳回長時間執行的作業 (LRO)。長時間執行的作業會追蹤要求狀態,並指出變更是否完成。
gcloud
gcloud iam workload-identity-pools operations describe 指令會傳回長時間執行的作業的狀態。
使用下列任何指令資料前,請先替換以下項目:
-
OPERATION_NAME:原始回應name欄位中的作業完整資源名稱:-
集區作業:
projects/PROJECT_NUMBER/locations/global/workloadIdentityPools/POOL_ID/operations/OPERATION_ID -
供應商作業:
projects/PROJECT_NUMBER/locations/global/workloadIdentityPools/POOL_ID/providers/PROVIDER_ID/operations/OPERATION_ID
如要執行供應商作業,請改為執行
gcloud iam workload-identity-pools providers operations describe指令。 -
集區作業:
執行下列指令:
Linux、macOS 或 Cloud Shell
gcloud iam workload-identity-pools operations describe OPERATION_NAME
Windows (PowerShell)
gcloud iam workload-identity-pools operations describe OPERATION_NAME
Windows (cmd.exe)
gcloud iam workload-identity-pools operations describe OPERATION_NAME
您應該會收到類似以下的回應:
{
"name": "projects/123456789012/locations/global/workloadIdentityPools/my-pool/operations/operation-1700000000000-0123456789abcdef",
"metadata": {
"@type": "type.googleapis.com/google.iam.v1.WorkloadIdentityPoolOperationMetadata"
},
"done": true,
"response": {
"@type": "type.googleapis.com/google.iam.v1.WorkloadIdentityPool",
"name": "projects/123456789012/locations/global/workloadIdentityPools/my-pool",
"displayName": "My workload pool",
"description": "Workload identity pool for external workloads.",
"state": "ACTIVE"
}
}
REST
projects.locations.workloadIdentityPools.operations.get 方法會傳回長時間執行的作業的狀態。
使用任何要求資料之前,請先修改下列項目的值:
-
OPERATION_NAME:原始回應name欄位中的作業完整資源名稱:-
集區作業:
projects/PROJECT_NUMBER/locations/global/workloadIdentityPools/POOL_ID/operations/OPERATION_ID -
供應商作業:
projects/PROJECT_NUMBER/locations/global/workloadIdentityPools/POOL_ID/providers/PROVIDER_ID/operations/OPERATION_ID
-
集區作業:
HTTP 方法和網址:
GET https://iam.googleapis.com/v1/OPERATION_NAME
請展開以下其中一個選項,以傳送要求:
您應該會收到如下的 JSON 回覆:
{
"name": "projects/123456789012/locations/global/workloadIdentityPools/my-pool/operations/operation-1700000000000-0123456789abcdef",
"metadata": {
"@type": "type.googleapis.com/google.iam.v1.WorkloadIdentityPoolOperationMetadata"
},
"done": true,
"response": {
"@type": "type.googleapis.com/google.iam.v1.WorkloadIdentityPool",
"name": "projects/123456789012/locations/global/workloadIdentityPools/my-pool",
"displayName": "My workload pool",
"description": "Workload identity pool for external workloads.",
"state": "ACTIVE"
}
}
如果作業的 done 欄位為 false 或省略,請重複取得作業,繼續監控其狀態。使用部分指數輪詢,在要求之間加入延遲時間。done 欄位設為 true 時,即代表作業完成。
管理 Workload Identity Federation 的限制
您可以使用組織政策限制,限制 Google Cloud 組織中資源的使用方式。
本節說明使用 Workload Identity Federation 時建議採用的限制。
管理允許的 IdP
組織管理員可以決定組織允許與哪些 IdP 建立聯盟。
如要管理允許的 IdP,請在組織的組織政策中啟用 constraints/iam.workloadIdentityPoolProviders 清單限制。這項限制會指定允許的供應商核發者 URI。您可以使用 Google Cloud 控制台或 Google Cloud CLI 啟用這項限制。
如要僅允許來自 AWS 的聯合,請使用 URI https://sts.amazonaws.com 建立單一限制。以下範例說明如何使用 gcloud CLI 建立這項限制:
gcloud resource-manager org-policies allow constraints/iam.workloadIdentityPoolProviders \ https://sts.amazonaws.com --organization=ORGANIZATION_NUMBER
您也可以指定哪些 AWS 帳戶 ID 有權存取Google Cloud 資源。如要指定帳戶 ID,請使用 constraints/iam.workloadIdentityPoolAwsAccounts 清單限制:
gcloud resource-manager org-policies allow constraints/iam.workloadIdentityPoolAwsAccounts \ ACCOUNT_ID --organization=ORGANIZATION_NUMBER
如要僅允許來自單一 OIDC 供應商的聯合,請使用允許供應商的 issuer_uri 建立單一限制。舉例來說,下列指令只允許從特定 Azure 租戶進行聯合:
gcloud resource-manager org-policies allow constraints/iam.workloadIdentityPoolProviders \ https://sts.windows.net/AZURE_TENANT_ID --organization=ORGANIZATION_NUMBER
從 SAML IdP 建立聯盟時,由於用於驗證宣告的公開金鑰是在設定 SAML IdP 時提供,因此因此,惡意使用者可能會嘗試使用公開金鑰,上傳含有貴組織 IdP 實體 ID 的 SAML 中繼資料文件。在這種情況下,使用實體 ID 限制聯合身分,只會造成安全的假象。
為降低這項風險,強烈建議您只允許在貴組織集中管理的 Google Cloud 專案中,透過 SAML 聯合建立 workload identity pool。接著,視需要將該 workload identity pool 中的外部身分存取權,授予整個組織的資源。
如要允許來自 SAML IdP 的聯合,請建立允許特殊關鍵字 KEY_UPLOAD 的限制。
gcloud resource-manager org-policies allow constraints/iam.workloadIdentityPoolProviders \ KEY_UPLOAD --organization=ORGANIZATION_NUMBER
您可以重複執行這些指令,允許其他提供者進行聯合。
如要封鎖所有供應商的聯合身分:
建立包含下列內容的 YAML 檔案:
constraint: constraints/iam.workloadIdentityPoolProviders listPolicy: allValues: DENY
將檔案傳遞至
gcloud resource-manager org-policies set-policy指令:gcloud resource-manager org-policies set-policy FILE_NAME.yaml \ --organization=ORGANIZATION_NUMBER
限制服務帳戶金鑰建立
Workload Identity Federation 可讓您從 Google Cloud 外部存取 Google Cloud 資源,不需使用服務帳戶金鑰。如果您從不使用服務帳戶金鑰進行驗證,可以停用金鑰建立功能,降低風險。
如要停用服務帳戶金鑰建立功能,請在組織政策中強制執行 iam.disableServiceAccountKeyCreation 布林限制。您也可以強制執行 iam.disableServiceAccountKeyUpload 布林值限制,禁止上傳服務帳戶的公開金鑰。
您可以使用 Google Cloud 控制台或 gcloud CLI 啟用這些限制。例如,下列 gcloud CLI 指令會啟用這兩項限制:
gcloud resource-manager org-policies enable-enforce \ constraints/iam.disableServiceAccountKeyCreation \ --organization=ORGANIZATION_NUMBER gcloud resource-manager org-policies enable-enforce \ constraints/iam.disableServiceAccountKeyUpload \ --organization=ORGANIZATION_NUMBER
監控 Workload Identity Federation
您可以使用 Cloud Monitoring 指標,監控 workload identity pool 和提供者的驗證事件。如需可用指標清單,請參閱「IAM 指標」。
後續步驟
進一步瞭解 Workload Identity Federation。