Amazon API Gateway 與 IAM 搭配運作的方式

在您使用 IAM 來管理 API Gateway 的存取權之前，您應該了解提供哪些 IAM 功能與 API Gateway 搭配使用。若要深入瞭解 API Gateway 和其他 AWS 服務如何與 IAM 搭配運作，請參閱 IAM 使用者指南中的與 IAM 搭配使用的AWS 服務。

API Gateway 身分類型政策

使用 IAM 身分型政策，您可以指定允許或拒絕的動作和資源，以及在何種條件下允許或拒絕動作。API Gateway 支援特定動作、資源和條件索引鍵。如需有關 API Gateway 特定動作、資源和條件索引鍵的詳細資訊，請參閱 Amazon API Gateway Management 的動作、資源和條件索引鍵和 Amazon API Gateway Management V2 的動作、資源和條件索引鍵。有關您在 JSON 政策中使用之所有元素的資訊，請參閱 IAM 使用者指南中的 IAM JSON 政策元素參考。

下列範例顯示允許使用者僅建立或更新私有 REST API 的身分型政策。如需更多範例，請參閱 Amazon API Gateway 身分型政策範例。

{
  "Version": "2012-10-17",
  "Statement": [
    {
      "Sid": "ScopeToPrivateApis",
      "Effect": "Allow",
      "Action": [
        "apigateway:PATCH",
        "apigateway:POST",
        "apigateway:PUT"
      ],
      "Resource": [
        "arn:aws:apigateway:us-east-1::/restapis",
        "arn:aws:apigateway:us-east-1::/restapis/??????????"
      ],
      "Condition": {
        "ForAllValues:StringEqualsIfExists": {
          "apigateway:Request/EndpointType": "PRIVATE",
          "apigateway:Resource/EndpointType": "PRIVATE"
        }
      }
    },
    {
      "Sid": "AllowResourcePolicyUpdates",
      "Effect": "Allow",
      "Action": [
          "apigateway:UpdateRestApiPolicy"
      ],
      "Resource": [
          "arn:aws:apigateway:us-east-1::/restapis/*"
      ]
    }
  ]
}

動作

JSON 原則的 Action 元素描述您可以用來允許或拒絕原則中存取的動作。

API Gateway 中的政策動作會在動作之前使用下列字首：apigateway:。政策陳述式必須包含 Action 或 NotAction 元素。API Gateway 會定義自己的一組動作，描述您可以使用此服務執行的任務。

API 管理 Action 表達式具有格式 apigateway:action，其中動作是下列 API Gateway 動作之一：GET、POST、PUT、DELETE、PATCH (以更新資源)，或 * (此為前述所有動作)。

Action 表達式的一些範例包括：

• apigateway:* 是所有 API Gateway 動作。

• apigateway:GET 只有 API Gateway 中的 GET 動作。

若要在單一陳述式中指定多個動作，請用逗號分隔，如下所示：

"Action": [
      "apigateway:action1",
      "apigateway:action2"

如需要用於特定 API Gateway 操作的 HTTP 動詞的詳細資訊，請參閱 Amazon API Gateway 第 1 版 API 參考 (REST API) 和 Amazon API Gateway 第 2 版 API 參考 (WebSocket 和 HTTP API)。

如需詳細資訊，請參閱 Amazon API Gateway 身分型政策範例。

資源

管理員可以使用 AWS JSON 政策來指定誰可以存取哪些內容。也就是說，哪個主體在什麼條件下可以對什麼資源執行哪些動作。

Resource JSON 政策元素可指定要套用動作的物件。陳述式必須包含 Resource 或 NotResource 元素。最佳實務是使用其 Amazon Resource Name (ARN) 來指定資源。您可以針對支援特定資源類型的動作 (稱為資源層級許可) 來這麼做。

對於不支援資源層級許可的動作 (例如列出作業)，請使用萬用字元 (*) 來表示陳述式適用於所有資源。

"Resource": "*"

API Gateway 資源具有以下 ARN 格式：

arn:aws:apigateway:region::resource-path-specifier

例如，若要指定具有 ID api-id 及其子資源的 REST API，例如陳述式中的授權者，請使用下列 ARN：

"Resource": "arn:aws:apigateway:us-east-2::/restapis/api-id/*"

若要指定屬於特定帳戶的所有 REST API 和子資源，請使用萬用字元 (*)：

"Resource": "arn:aws:apigateway:us-east-2::/restapis/*"

若要查看 API Gateway 資源類型及其 ARN 的清單，請參閱API Gateway Amazon Resource Name (ARN) 參考資料。

條件索引鍵

管理員可以使用 AWS JSON 政策來指定誰可以存取哪些內容。也就是說，哪個主體在什麼條件下可以對什麼資源執行哪些動作。

Condition 元素 (或 Condition 區塊) 可讓您指定使陳述式生效的條件。Condition 元素是選用項目。您可以建立使用條件運算子的條件運算式 (例如等於或小於)，來比對政策中的條件和請求中的值。

若您在陳述式中指定多個 Condition 元素，或是在單一 Condition 元素中指定多個索引鍵， AWS 會使用邏輯 AND 操作評估他們。如果您為單一條件索引鍵指定多個值，請使用邏輯OR運算來 AWS 評估條件。必須符合所有條件，才會授與陳述式的許可。

您也可以在指定條件時使用預留位置變數。例如，您可以只在使用者使用其 IAM 使用者名稱標記時，將存取資源的許可授予該 IAM 使用者。如需更多資訊，請參閱 IAM 使用者指南中的 IAM 政策元素：變數和標籤。

AWS 支援全域條件金鑰和服務特定條件金鑰。若要查看所有 AWS 全域條件金鑰，請參閱《IAM 使用者指南》中的AWS 全域條件內容金鑰。

API Gateway 會定義自己的一組條件金鑰，也支援使用一些全域條件金鑰。若要查看 API Gateway 條件索引鍵清單，請參閱《IAM 使用者指南》中的 Amazon API Gateway 條件索引鍵。若要了解您可以搭配條件索引鍵使用哪些動作和資源，請參閱 Amazon API Gateway 定義的動作。

如需有關標記的資訊 (包括屬性型存取控制)，請參閱 API Gateway 資源的標記。

範例

若要了解 API Gateway 身分型政策的範例，請參閱Amazon API Gateway 身分型政策範例。

API Gateway 資源類型政策

資源型政策是 JSON 政策文件，這些文件會指定指定的主體可對 API Gateway 資源以及在怎樣的條件下執行哪些動作。API Gateway 支援適用於 REST API 的資源型許可政策。您可以使用資源政策來控制誰可以叫用 REST API。如需詳細資訊，請參閱 控制對RESTAPI具有API閘道資源策略的存取。

範例

若要了解 API Gateway 資源型政策的範例，請參閱API閘道資源策略範例。

根據 API Gateway 標籤授權

您可以將標籤連接到 API Gateway 資源，或是在請求中將標籤傳遞給 API Gateway。若要根據標籤控制存取，請使用 apigateway:ResourceTag/key-name、aws:RequestTag/key-name 或 aws:TagKeys 條件金鑰，在原則的條件元素中，提供標籤資訊。如需標記 API Gateway 資源的詳細資訊，請參閱使用標籤來控制對 API Gateway REST API 資源的存取。

若要了解身分型政策範例，以根據該資源上的標籤來限制存取資源，請參閱使用標籤來控制對 API Gateway REST API 資源的存取。

API Gateway IAM 角色

IAM 角色是您 AWS 帳戶中具有特定許可的實體。

搭配 API Gateway 使用暫時登入資料

您可以搭配聯合使用暫時憑證、擔任 IAM 角色，或是擔任跨帳戶角色。您可以透過呼叫AssumeRole或等 AWS STS API 作業來取得臨時安全登入資料GetFederationToken。

API Gateway 支援使用臨時登入資料。

服務連結角色

服務連結角色可讓 AWS 服務存取其他服務中的資源，以代表您完成動作。服務連結角色會顯示在您的 IAM 帳戶中，並由該服務所擁有。IAM 管理員可以檢視，但不能編輯服務連結角色的許可。

API Gateway 支援服務連結角色。如需關於建立或管理 API Gateway 服務連結角色的資訊，請參閱使用 API Gateway 的服務連結角色。

服務角色

服務可代表您擔任服務角色。服務角色可讓服務存取其他服務中的資源，以代表您完成動作。服務角色會出現在您的 IAM 帳戶中，並由該帳戶擁有，因此管理員可以變更此角色的許可。不過，這樣可能會破壞此服務的功能。

API Gateway 支援服務角色。