驗證 JWT 政策部署錯誤

您目前查看的是 Apigee 和 Apigee Hybrid 說明文件。
查看 Apigee Edge 說明文件。

InvalidNameForAdditionalClaim

錯誤訊息

透過 Apigee 使用者介面或 API 部署 API Proxy 時失敗，並顯示以下錯誤訊息：

Error Saving Revision revision_number
Invalid name for additional claim : policy(policy_name) claim(claim_name).

錯誤訊息示例

Error Saving Revision 2
Invalid name for additional claim : policy(JWT-Verify-RS256) claim(iss).

螢幕截圖範例

Apigee UI 會顯示含有錯誤的對話方塊：

額外聲明錯誤訊息的名稱無效。

原因

如果 <AdditionalClaims> 元素的子項元素 <Claim> 中使用的聲明名稱是下列其中一個已註冊的名稱，就會發生這項錯誤：

「kid」、「iss」、「sub」、「aud」、「iat」、「exp」、「nbf」、「jti」

註冊的聲明定義於 RFC 7519。

舉例來說，在 <AdditionalClaims> 元素下使用聲明名稱 iss 會導致這項錯誤。

診斷

  1. 從錯誤訊息中找出「驗證 JWT」政策的名稱和聲明名稱。舉例來說，在下列錯誤訊息中，「Verify JWT」政策的名稱為 JWT-Verify-RS256，聲明名稱為 iss：

    Invalid name for additional claim : policy(JWT-Verify-RS256) claim(iss).

  2. 確認失敗的「驗證 JWT」政策 XML 中 <AdditionalClaims> 元素下使用的憑證名稱，與步驟 1 中錯誤訊息所指出的憑證名稱相符。舉例來說，下列政策將聲明指定為 iss，與錯誤訊息中的內容相符：

    <VerifyJWT name="JWT-Verify-RS256">
    <DisplayName>JWT Verify RS256</DisplayName>
    <Algorithm>RS256</Algorithm>
    <IgnoreUnresolvedVariables>false</IgnoreUnresolvedVariables>
    <SecretKey>
        <Value ref="private.secretkey"/>
        <Id>1918290</Id>
    </SecretKey>
    <ExpiresIn>1h</ExpiresIn>
    <Subject>monty-pythons-flying-circus</Subject>
    <Issuer>urn://apigee-edge-JWT-policy-test</Issuer>
    <Audience>fans</Audience>
    <Id/>
    <AdditionalClaims>
        <Claim name="iss"/>
    </AdditionalClaims>
</VerifyJWT>

  3. 如果 <AdditionalClaims> 元素的子項元素 <Claim> 中使用的聲明名稱是下列其中一個已註冊的名稱：

    「kid」、「iss」、「sub」、「aud」、「iat」、「exp」、「nbf」、「jti」

    這就是錯誤原因。

    在上述「驗證 JWT 政策」範例中，<Claim> 名稱在 <AdditionalClaims> 元素下指定為 iss，因此會導致錯誤：

    Invalid name for additional claim : policy(JWT-Verify-RS256) claim(iss).

解析度

請勿在 <AdditionalClaims> 元素的子項元素 <Claim> 中使用任何已註冊的名稱，例如「kid」、「iss」、「sub」、「aud」、「iat」、「exp」、「nbf」或「jti」。

如要修正範例「驗證 JWT」政策的問題，請將聲明名稱變更為 status：

<VerifyJWT name="JWT-Verify-RS256">
    <DisplayName>JWT Verify RS256</DisplayName>
    <Algorithm>RS256</Algorithm>
    <IgnoreUnresolvedVariables>false</IgnoreUnresolvedVariables>
    <SecretKey>
        <Value ref="private.secretkey"/>
        <Id>1918290</Id>
    </SecretKey>
    <ExpiresIn>1h</ExpiresIn>
    <Subject>monty-pythons-flying-circus</Subject>
    <Issuer>urn://apigee-edge-JWT-policy-test</Issuer>
    <Audience>fans</Audience>
    <Id/>
    <AdditionalClaims>
        <Claim name='status' type='string'>Development</Claim>
    </AdditionalClaims>
</VerifyJWT>

InvalidTypeForAdditionalClaim

錯誤訊息

透過 Apigee 使用者介面或 API 部署 API Proxy 時失敗，並顯示以下錯誤訊息：

Error Saving Revision revision_number
Invalid type for additional claim : policy(policy_name) claim(claim_name) type(type_name).

錯誤訊息示例

Error Saving Revision 2
Invalid type for additional claim : policy(JWT-Verify-RS256) claim(claim) type(integer).

螢幕截圖範例

Apigee UI 會顯示含有錯誤的對話方塊：

額外聲明錯誤訊息的類型無效。

原因

VerifyJWT 政策的 <AdditionalClaims> 元素子項 <Claim> 中使用的聲明類型，並非下列類型之一：

string (預設)、number、boolean 或 map

舉例來說，在 <AdditionalClaims> 元素下使用 integer 聲明類型會導致錯誤。

診斷

  1. 從錯誤訊息中找出「驗證 JWT」政策的名稱、聲明名稱和類型。舉例來說，在下列錯誤訊息中，「Verify JWT」政策的名稱為 JWT-Verify-RS256，聲明名稱為 claim，類型為 integer:

    Invalid type for additional claim : policy(JWT-Verify-RS256) claim(claim) type(integer).

  2. 確認失敗的「驗證 JWT」政策 XML 中 <AdditionalClaims> 元素下使用的聲明名稱和類型，與步驟 1 中錯誤訊息所指出的聲明名稱和類型相符。舉例來說，下列政策會將聲明指定為 claim，類型指定為 integer，這與錯誤訊息中的內容相符：

    <VerifyJWT name="JWT-Verify-RS256">
  <DisplayName>JWT Verify RS256</DisplayName>
  <Algorithm>RS256</Algorithm>
 <IgnoreUnresolvedVariables>false</IgnoreUnresolvedVariables>
  <SecretKey>
      <Value ref="private.secretkey"/>
      <Id>1918290</Id>
  </SecretKey>
  <ExpiresIn>1h</ExpiresIn>
  <Subject>monty-pythons-flying-circus</Subject>
  <Issuer>urn://apigee-edge-JWT-policy-test</Issuer>
  <Audience>fans</Audience>
  <Id/>
  <AdditionalClaims>
      <Claim name='claim' ref='reqclaim' type='integer'/>
  </AdditionalClaims>
</VerifyJWT>

  3. 如果 <AdditionalClaims> 元素的子項元素 <Claim> 中使用的聲明類型不是下列類型：

    string (預設)、number、boolean 或 map

    這就是錯誤原因。

    在上述「驗證 JWT」政策範例中，<Claim> 類型是在 <AdditionalClaims> 元素下指定為 integer。由於 integer 不是支援的類型，因此會出現下列錯誤：

    Invalid type for additional claim : policy(JWT-Verify-RS256) claim(claim) type(integer).

解析度

確認 <AdditionalClaims> 元素的子項元素 <Claim> 中，只使用支援的資料類型 string (預設)、number、boolean 或 map。

如要修正「驗證 JWT」政策範例，請將宣告類型變更為 boolean：

<VerifyJWT name="JWT-Verify-RS256">
    <DisplayName>JWT Verify RS256</DisplayName>
    <Algorithm>RS256</Algorithm>
    <IgnoreUnresolvedVariables>false</IgnoreUnresolvedVariables>
    <SecretKey>
        <Value ref="private.secretkey"/>
        <Id>1918290</Id>
    </SecretKey>
    <ExpiresIn>1h</ExpiresIn>
    <Subject>monty-pythons-flying-circus</Subject>
    <Issuer>urn://apigee-edge-JWT-policy-test</Issuer>
    <Audience>fans</Audience>
    <Id/>
    <AdditionalClaims>
        <Claim name='claim' ref='reqclaim' type='boolean'/>
    </AdditionalClaims>
</VerifyJWT>

MissingNameForAdditionalClaim

錯誤訊息

透過 Apigee 使用者介面或 API 部署 API Proxy 時失敗，並顯示以下錯誤訊息：

Error Saving Revision revision_number
Error occurred while validation of bean(policy_name.xml) Reason: - Required attribute name is missing in Claim.

錯誤訊息示例

Error Saving Revision 2
Error occurred while validation of bean JWT-Verify-RS256.xml. Reason: - Required attribute name is missing in Claim

螢幕截圖範例

Apigee UI 會顯示含有錯誤的對話方塊：

聲明錯誤訊息中缺少屬性名稱。

原因

如果 <AdditionalClaims> 或 <AdditionalHeaders> 元素的子元素 <Claim> 中未指定聲明名稱，就會發生這項錯誤。

診斷

  1. 從錯誤訊息中找出「Verify JWT」政策的名稱。舉例來說，在下列錯誤訊息中，「Verify JWT」政策的名稱為 JWT-Verify-RS256：

    Error occurred while validation of bean JWT-Verify-RS256.xml. Reason: - Required attribute name is missing in Claim

  2. 檢查失敗的「驗證 JWT 政策」XML，並確認子項元素 <Claims> 的 <AdditionalClaims> 或 <AdditionalHeaders> 元素中缺少聲明名稱。舉例來說，下列「驗證 JWT」政策未在 <AdditionalClaims> 元素下方指定要求名稱：

    <VerifyJWT name="JWT-Verify-RS256">
    <DisplayName>JWT Verify RS256</DisplayName>
    <Algorithm>RS256</Algorithm>
    <IgnoreUnresolvedVariables>false</IgnoreUnresolvedVariables>
    <SecretKey>
        <Value ref="private.secretkey"/>
        <Id>1918290</Id>
    </SecretKey>
    <ExpiresIn>1h</ExpiresIn>
    <Subject>monty-pythons-flying-circus</Subject>
    <Issuer>urn://apigee-edge-JWT-policy-test</Issuer>
    <Audience>fans</Audience>
    <Id/>
    <AdditionalClaims>
        <Claim ref='reqclaim' type='boolean'/>
    </AdditionalClaims>
</VerifyJWT>

    由於 <Claim> 名稱未在 <AdditionalClaims> 元素下指定，因此會收到下列錯誤：

    Error occurred while validation of bean JWT-Verify-RS256.xml. Reason: - Required attribute name is missing in Claim

解析度

請務必在 <AdditionalClaims> 或 <AdditionalHeaders> 元素的子項元素 <Claim> 中指定聲明名稱。

如要修正「驗證 JWT」政策範例，請指定宣告名稱，如下所示：

<VerifyJWT name="JWT-Verify-RS256">
    <DisplayName>JWT Verify RS256</DisplayName>
    <Algorithm>RS256</Algorithm>
    <IgnoreUnresolvedVariables>false</IgnoreUnresolvedVariables>
    <SecretKey>
        <Value ref="private.secretkey"/>
        <Id>1918290</Id>
    </SecretKey>
    <ExpiresIn>1h</ExpiresIn>
    <Subject>monty-pythons-flying-circus</Subject>
    <Issuer>urn://apigee-edge-JWT-policy-test</Issuer>
    <Audience>fans</Audience>
    <Id/>
    <AdditionalClaims>
        <Claim name='claim' ref='reqclaim' type='boolean'/>
    </AdditionalClaims>
</VerifyJWT>

InvalidNameForAdditionalHeader

錯誤訊息

透過 Apigee 使用者介面或 API 部署 API Proxy 時失敗，並顯示以下錯誤訊息：

Error Saving Revision revision_number
Invalid name for additional header : policy(policy_name)header(header_name).

錯誤訊息示例

Error Saving Revision 2
Invalid name for additional header: policy(JWT-Verify-RS256) header(alg).

螢幕截圖範例

Apigee UI 會顯示含有錯誤的對話方塊：

額外標頭錯誤訊息的名稱無效。

原因

如果 <AdditionalHeaders> 元素的子項 <Claim> 中使用的聲明名稱是下列其中一個標準 JWT 標頭，就會發生這項錯誤：

alg或typ

舉例來說，在 <AdditionalHeaders> 元素下使用 alg 聲明名稱會導致錯誤。

診斷

  1. 從錯誤訊息中找出「驗證 JWT」政策的名稱和標頭名稱。舉例來說，在下列錯誤訊息中，「驗證 JWT」政策的名稱為 JWT-Verify-RS256，標頭名稱為 alg：

    Invalid name for additional header: policy(JWT-Verify-RS256) header(alg).

  2. 確認失敗的「驗證 JWT」政策 XML 中，子項元素 <AdditionalHeaders> 內 <Claim> 使用的標頭名稱，與步驟 1 中的錯誤訊息所指出的標頭名稱相符。舉例來說，下列政策將標頭指定為 alg，與錯誤訊息中的內容相符：

    <VerifyJWT name="JWT-Verify-RS256">
    <DisplayName>JWT Verify RS256</DisplayName>
    <Algorithm>RS256</Algorithm>
    <IgnoreUnresolvedVariables>false</IgnoreUnresolvedVariables>
    <SecretKey>
        <Value ref="private.secretkey"/>
        <Id>1918290</Id>
    </SecretKey>
    <ExpiresIn>1h</ExpiresIn>
    <Subject>monty-pythons-flying-circus</Subject>
    <Issuer>urn://apigee-edge-JWT-policy-test</Issuer>
    <Audience>fans</Audience>
    <Id/>
    <AdditionalHeaders>
        <Claim name="alg"/>
    </AdditionalHeaders>
</VerifyJWT>

  3. 如果 <AdditionalClaims> 元素的子項元素 <Claim> 中使用的標頭名稱是下列其中一個標準 JWT 標頭：

    alg或typ

    這就是錯誤原因。

    在上述「驗證 JWT 政策」範例中，<Claim> 名稱在 <AdditionalClaims> 元素下指定為 alg，因此會導致錯誤：

    Invalid name for additional header: policy(JWT-Verify-RS256) header(alg).

解析度

請勿在 <AdditionalHeaders> 元素的子項元素 <Claim> 中使用標準 JWT 標頭 alg 或 typ。

如要修正範例 Verify JWT 政策，請在 <AdditionalHeaders> 元素的子項元素 <Claim> 中使用 x5c 名稱：

<VerifyJWT name="JWT-Verify-RS256">
    <DisplayName>JWT Verify RS256</DisplayName>
    <Algorithm>RS256</Algorithm>
    <IgnoreUnresolvedVariables>false</IgnoreUnresolvedVariables>
    <SecretKey>
        <Value ref="private.secretkey"/>
        <Id>1918290</Id>
    </SecretKey>
    <ExpiresIn>1h</ExpiresIn>
    <Subject>monty-pythons-flying-circus</Subject>
    <Issuer>urn://apigee-edge-JWT-policy-test</Issuer>
    <Audience>fans</Audience>
    <Id/>
    <AdditionalHeaders>
        <Claim name='x5c'/>
    </AdditionalHeaders>
</VerifyJWT>

InvalidTypeForAdditionalHeader

錯誤訊息

透過 Apigee 使用者介面或 API 部署 API Proxy 時失敗，並顯示以下錯誤訊息：

Error Saving Revision revision_number
Invalid type for additional header : policy(policy_name) claim(claim_name) type(type_name).

錯誤訊息示例

Error Saving Revision 2
Invalid type for additional header : policy(JWT-Verify-RS256) claim(claim1) type(integer).

螢幕截圖範例

Apigee UI 會顯示含有錯誤的對話方塊：

額外標題錯誤訊息的類型無效。

原因

如果 Verify JWT 政策的 <AdditionalHeaders> 元素子元素 <Claim> 中使用的聲明類型不是下列類型，就會發生錯誤：

string (預設)、number、boolean 或 map

舉例來說，在 <AdditionalHeaders> 元素下使用 integer 聲明類型會導致錯誤。

診斷

  1. 從錯誤訊息中找出「驗證 JWT」政策名稱、聲明名稱和類型。舉例來說，在下列錯誤訊息中，「Verify JWT」政策的名稱為 JWT-Verify-RS256，聲明名稱為 claim，類型為 integer：

    Invalid type for additional header : policy(JWT-Verify-RS256) claim(claim) type(integer).

  2. 確認失敗的「驗證 JWT」政策 XML 中 <AdditionalClaims> 元素下使用的聲明名稱和類型，與步驟 1 中錯誤訊息所指出的聲明名稱和類型相符。舉例來說，下列政策會將聲明指定為 claim，並將聲明類型指定為 integer,，這與錯誤訊息中的內容相符：

    <VerifyJWT name="JWT-Verify-RS256">
    <DisplayName>JWT Verify RS256</DisplayName>
    <Algorithm>RS256</Algorithm>
    <IgnoreUnresolvedVariables>false</IgnoreUnresolvedVariables>
    <SecretKey>
        <Value ref="private.secretkey"/>
        <Id>1918290</Id>
    </SecretKey>
    <ExpiresIn>1h</ExpiresIn>
    <Subject>monty-pythons-flying-circus</Subject>
    <Issuer>urn://apigee-edge-JWT-policy-test</Issuer>
    <Audience>fans</Audience>
    <Id/>
    <AdditionalHeaders>
        <Claim name='claim' ref='reqclaim' type='integer'/>
    </AdditionalHeaders>
</VerifyJWT>

  3. 如果 <AdditionalHeaders> 元素的子項元素 <Claim> 中使用的聲明類型不是下列類型：

    string (預設)、number、boolean 或 map

    這就是錯誤原因。

    在上述「驗證 JWT」政策範例中，<AdditionalHeaders> 元素下的 <Claim> 類型指定為 integer。由於 integer 不是支援的類型，因此會出現下列錯誤：

    Invalid type for additional header : policy(JWT-Verify-RS256) claim(claim) type(integer).

解析度

確認 <AdditionalHeaders> 元素的子項元素 <Claim> 中只使用支援的資料類型 string、number、boolean 或 map。

如要修正「驗證 JWT」政策範例，請將宣告類型變更為 boolean：

<VerifyJWT name="JWT-Verify-RS256">
    <DisplayName>JWT Verify RS256</DisplayName>
    <Algorithm>RS256</Algorithm>
    <IgnoreUnresolvedVariables>false</IgnoreUnresolvedVariables>
    <SecretKey>
        <Value ref="private.secretkey"/>
        <Id>1918290</Id>
    </SecretKey>
    <ExpiresIn>1h</ExpiresIn>
    <Subject>monty-pythons-flying-circus</Subject>
    <Issuer>urn://apigee-edge-JWT-policy-test</Issuer>
    <Audience>fans</Audience>
    <Id/>
    <AdditionalHeaders>
        <Claim name='claim' ref='reqclaim' type='boolean'/>
    </AdditionalHeaders>
</VerifyJWT>

InvalidValueOfArrayAttribute

錯誤訊息

透過 Apigee 使用者介面或 API 部署 API Proxy 時失敗，並顯示以下錯誤訊息：

Error Saving Revision revision_number
Invalid value for array attribute: policy(policy_name)claim(claim_name).

錯誤訊息示例

Error Saving Revision 2
Invalid value for array attribute: policy(JWT-Verify-RS256) claim(claim).

螢幕截圖範例

Apigee UI 會顯示含有錯誤的對話方塊：

陣列屬性的值無效錯誤訊息。

原因

如果 <AdditionalClaims> 或 <AdditionalHeaders> 元素的子元素 <Claim> 中的陣列屬性值未設為 true 或 false，就會發生這項錯誤。

舉例來說，在 <AdditionalClaims> 或 <AdditionalHeaders> 元素的子項元素 <Claim> 中，將陣列屬性的值設為 yes，就會導致錯誤。

診斷

  1. 從錯誤訊息中找出「驗證 JWT」政策的名稱和聲明名稱。舉例來說，在下列錯誤訊息中，「Verify JWT」政策的名稱為 JWT-Verify-RS256，而聲明名稱為 claim：

    Invalid value for array attribute: policy(JWT-Verify-RS256) claim(claim).

  2. 確認失敗的「驗證 JWT 政策」XML 中，<AdditionalHeaders> 元素下子元素 <Claim> 使用的聲明名稱，與步驟 1 中錯誤訊息所指出的聲明名稱相符。舉例來說，下列政策將聲明名稱指定為 claim，與錯誤訊息中的名稱相符：

    <VerifyJWT name="JWT-Verify-RS256">
    <DisplayName>JWT Verify RS256</DisplayName>
    <Algorithm>RS256</Algorithm>
    <IgnoreUnresolvedVariables>false</IgnoreUnresolvedVariables>
    <SecretKey>
        <Value ref="private.secretkey"/>
        <Id>1918290</Id>
    </SecretKey>
    <ExpiresIn>1h</ExpiresIn>
    <Subject>monty-pythons-flying-circus</Subject>
    <Issuer>urn://apigee-edge-JWT-policy-test</Issuer>
    <Audience>fans</Audience>
    <Id/>
    <AdditionalClaims>
        <Claim name='claim' ref='reqclaim' type='string' array='yes'/>
    </AdditionalClaims>
</VerifyJWT>

  3. 如果 <AdditionalClaims> 元素的子元素 <Claim> 中，array 屬性的值未設為 true 或 false，就會導致錯誤。

    由於上述範例中，<AdditionalClaims> 元素的子項元素 <Claim> 中的 array 屬性設為 yes，因此會出現下列錯誤：

    Invalid value for array attribute: policy(JWT-Verify-RS256) claim(claim).

解析度

確認 <AdditionalClaims> 或 <AdditionalHeaders> 元素子元素 <Claim> 中的陣列屬性值設為 true 或 false。

如要修正上述範例中的「驗證 JWT」政策，請將陣列屬性的值變更為 true：

<VerifyJWT name="JWT-Verify-RS256">
    <DisplayName>JWT Verify RS256</DisplayName>
    <Algorithm>RS256</Algorithm>
    <IgnoreUnresolvedVariables>false</IgnoreUnresolvedVariables>
    <SecretKey>
        <Value ref="private.secretkey"/>
        <Id>1918290</Id>
    </SecretKey>
    <ExpiresIn>1h</ExpiresIn>
    <Subject>monty-pythons-flying-circus</Subject>
    <Issuer>urn://apigee-edge-JWT-policy-test</Issuer>
    <Audience>fans</Audience>
    <Id/>
    <AdditionalHeaders>
        <Claim name='claim' ref='reqclaim' type='string' array='true'/>
    </AdditionalHeaders>
</VerifyJWT>

InvalidValueForElement

錯誤訊息

透過 Apigee 使用者介面或 API 部署 API Proxy 時失敗，並顯示以下錯誤訊息：

Error Saving Revision
Invalid Value for element : policy(policy_name) element(element_name).

錯誤訊息示例

Error Saving Revision
Invalid Value for element : policy(JWT-Verify-RS256) element(Algorithm).

螢幕截圖範例

Apigee UI 會顯示含有錯誤的對話方塊：

元素錯誤訊息的值無效。

原因

如果 <Algorithm> 元素中指定的值不是下列其中一個值，就會發生這個錯誤：

HS256、HS384、HS512、RS256、RS384、RS512

舉例來說，如果在 <Algorithm> 元素中將演算法值指定為 RS128，就會導致這項錯誤。

診斷

  1. 從錯誤訊息中找出「Verify JWT」政策的名稱和元素名稱。舉例來說，在下列錯誤訊息中，「Verify JWT」政策的名稱為 JWT-Verify-RS256，元素名稱為 Algorithm：

    Invalid Value for element : policy(JWT-Verify-RS256) element(Algorithm).

  2. 檢查失敗的「驗證 JWT 政策」XML，並檢查為 <Algorithm> 元素指定的值。

    以下是驗證 JWT 政策的範例：

    <VerifyJWT name="JWT-Verify-RS256">
    <DisplayName>JWT Verify RS256</DisplayName>
    <Algorithm>RS128</Algorithm>
    <IgnoreUnresolvedVariables>false</IgnoreUnresolvedVariables>
    <SecretKey>
        <Value ref="private.secretkey"/>
        <Id>1918290</Id>
    </SecretKey>
    <ExpiresIn>1h</ExpiresIn>
    <Subject>monty-pythons-flying-circus</Subject>
    <Issuer>urn://apigee-edge-JWT-policy-test</Issuer>
    <Audience>fans</Audience>
    <Id/>
    <AdditionalClaims>
        <Claim name='status' type='string'>Development</Claim>
    </AdditionalClaims>
</VerifyJWT>

  3. 檢查 <Algorithm> 元素中指定的值。如果不是下列其中一個值：

    HS256、HS384、HS512、RS256、RS384、RS512

    這就是錯誤原因。

    在上述「驗證 JWT」政策範例中，<Algorithm> 名稱指定為 HS128。由於系統不支援這個演算法，因此會顯示以下錯誤訊息：

    Invalid Value for element : policy(JWT-Verify-RS256) element(Algorithm).

解析度

確認 <Algorithm> 元素中指定的值是支援的值：

HS256、HS384、HS512、RS256、RS384、RS512

如要修正上述使用 <SecretKey> 元素的「驗證 JWT」政策範例，請將 <Algorithm> 的值變更為 HS25。請注意，使用 <SecretKey> 元素時，只能使用 HS Family 演算法。

<VerifyJWT name="JWT-Verify-RS256">
    <DisplayName>JWT Verify RS256</DisplayName>
    <Algorithm>RS256</Algorithm>
    <IgnoreUnresolvedVariables>false</IgnoreUnresolvedVariables>
    <SecretKey>
        <Value ref="private.secretkey"/>
        <Id>1918290</Id>
    </SecretKey>
    <ExpiresIn>1h</ExpiresIn>
    <Subject>monty-pythons-flying-circus</Subject>
    <Issuer>urn://apigee-edge-JWT-policy-test</Issuer>
    <Audience>fans</Audience>
    <Id/>
    <AdditionalClaims>
        <Claim name='status' type='string'>Development</Claim>
    </AdditionalClaims>
</VerifyJWT>

MissingConfigurationElement

錯誤訊息

透過 Apigee 使用者介面或 API 部署 API Proxy 時失敗，並顯示以下錯誤訊息：

Error Saving Revision
Missing configuration element : policy(policy_name) element(element_name).

錯誤訊息示例

Error Saving Revision
Missing configuration element : policy(JWT-Verify-RS256) element(PublicKey).

螢幕截圖範例

Apigee UI 會顯示含有錯誤的對話方塊：

缺少設定元素錯誤訊息。

原因

如果 Verify JWT 政策中<PublicKey>元素未與 RSA 系列演算法搭配使用，就會發生這個錯誤。同樣地，如果 <SecretKey> 元素未在「驗證 JWT」政策中與 HS Family 演算法搭配使用，也可能發生錯誤。

舉例來說，如果未使用 RSA Family 演算法的 <PublicKey> 元素，就會導致這項錯誤。

診斷

  1. 從錯誤訊息中找出「驗證 JWT」政策的名稱和缺少的元素名稱。舉例來說，在下列錯誤訊息中，「Verify JWT」政策的名稱為 JWT-Verify-RS256，而缺少的元素名稱為 PublicKey：

    Missing configuration element : policy(JWT-Verify-RS256) element(PublicKey).

  2. 檢查失敗的「驗證 JWT」政策 XML，確認錯誤訊息中指出的元素是否遺失。如果缺少這個檔案，就是導致錯誤的原因。

    舉例來說，下列政策顯示缺少 PublicKey，且使用的 Algorithm 為 RS256：

    <VerifyJWT name="JWT-Verify-RS256">
    <DisplayName>JWT Verify RS256</DisplayName>
    <Algorithm>RS256</Algorithm>
    <IgnoreUnresolvedVariables>false</IgnoreUnresolvedVariables>
    <ExpiresIn>1h</ExpiresIn>
    <Subject>monty-pythons-flying-circus</Subject>
    <Issuer>urn://apigee-edge-JWT-policy-test</Issuer>
    <Audience>fans</Audience>
    <Id/>
    <AdditionalClaims>
        <Claim name='claim' ref='reqclaim' type='string' array='true'/>
    </AdditionalClaims>
</VerifyJWT>

    範例「Verify JWT」政策使用 HS 系列演算法，但缺少必要元素 PublicKey，因此會產生錯誤：

    Missing configuration element : policy(JWT-Verify-RS256) element(PublicKey).

解析度

確認使用 RSA 系列演算法時，會使用必要 <PublicKey> 元素，使用 HS 系列演算法時，會使用必要 <SecretKey> 元素。

如要修正上述範例中使用的 RS256 演算法，請將 <PublicKey> 元素新增至 VerifyJWT 政策：

<VerifyJWT name="JWT-Verify-RS256">
    <DisplayName>JWT Verify RS256</DisplayName
    <IgnoreUnresolvedVariables>false</IgnoreUnresolvedVariables>
    <Algorithm>RS256</Algorithm>
    <PublicKey>
      <Value ref="public.publickey"/>
    </PublicKey>
    <ExpiresIn>1h</ExpiresIn>
    <Subject>monty-pythons-flying-circus</Subject>
    <Issuer>urn://apigee-edge-JWT-policy-test</Issuer>
    <Audience>fans</Audience>
    <Id/>
    <AdditionalHeaders>
        <Claim name='claim' ref='reqclaim' type='string' array='true'/>
    </AdditionalHeaders>
</VerifyJWT>

InvalidKeyConfiguration

錯誤訊息

透過 Apigee 使用者介面或 API 部署 API Proxy 時失敗，並顯示以下錯誤訊息：

Error Saving Revision 
Invalid Key configuration : policy(policy_name).

錯誤訊息示例

Error Saving Revision 2
Invalid Key configuration : policy(JWT-Verify-RS256).

螢幕截圖範例

Apigee UI 會顯示含有錯誤的對話方塊：

無效的金鑰設定錯誤訊息。

原因

如果子項元素 <Value> 或必要子項元素 <JWKS> 未在「驗證 JWT」政策的 <PublicKey> 或 <SecretKey> 元素中定義，就會發生這項錯誤。

診斷

  1. 從錯誤訊息中找出「Verify JWT」政策的名稱。舉例來說，在下列錯誤訊息中，「Verify JWT」政策的名稱為 JWT-Verify-RS256：

    Invalid Key configuration : policy(JWT-Verify-RS256).

  2. 檢查失敗的「驗證 JWT 政策」XML，確認子元素 <Value> 或子元素 <JWKS> 是否未在 <PublicKey> 或 <SecretKey> 元素中定義。如果未定義子元素，這就是錯誤原因。

    舉例來說，下列政策顯示子項元素 <Value> 或 <JWKS> 未在 <PublicKey> 元素中定義：

    <VerifyJWT name="JWT-Verify-RS256">
    <DisplayName>JWT Verify RS256</DisplayName>
    <Algorithm>RS256</Algorithm>
    <IgnoreUnresolvedVariables>false</IgnoreUnresolvedVariables>
    <ExpiresIn>1h</ExpiresIn>
    <PublicKey>
    </PublicKey>
    <Subject>monty-pythons-flying-circus</Subject>
    <Issuer>urn://apigee-edge-JWT-policy-test</Issuer>
    <Audience>fans</Audience>
    <Id/>
    <AdditionalClaims>
        <Claim name='claim' ref='reqclaim' type='string' array='true'/>
    </AdditionalClaims>
</VerifyJWT>

    由於子項元素 <Value> 或 <JWKS> 未在「驗證 JWT」政策的 <PublicKey> 元素中定義，因此您會收到下列錯誤訊息：

    Invalid Key configuration : policy(JWT-Verify-RS256).

解析度

請務必在「驗證 JWT」政策的 <PublicKey> 元素中定義子項元素 <Value> 或 <JWKS>。

如要修正「驗證 JWT」政策範例，請在 <PublicKey> 元素下方定義子項元素 <Value> 或 <JWKS>，如下所示：

<VerifyJWT name="JWT-Verify-RS256">
    <DisplayName>JWT Verify RS256</DisplayName>
    <Algorithm>RS256</Algorithm>
    <IgnoreUnresolvedVariables>false</IgnoreUnresolvedVariables>
    <PublicKey>
        <Value ref="public.publickey"/>
    </PublicKey>
    <ExpiresIn>1h</ExpiresIn>
    <Subject>monty-pythons-flying-circus</Subject>
    <Issuer>urn://apigee-edge-JWT-policy-test</Issuer>
    <Audience>fans</Audience>
    <Id/>
    <AdditionalHeaders>
        <Claim name='claim' ref='reqclaim' type='string' array='true'/>
    </AdditionalHeaders>
</PublicJWT>

EmptyElementForKeyConfiguration

錯誤訊息

透過 Apigee 使用者介面或 API 部署 API Proxy 時失敗，並顯示以下錯誤訊息：

Error Saving Revision revision_number
Empty Element for Key Configuration : policy(policy_name) element(element_name).

錯誤訊息示例

Error Saving Revision 2
Empty Element for Key Configuration : policy(JWT-Verify-RS256) element(PublicKey/Value).

螢幕截圖範例

Apigee UI 會顯示含有錯誤的對話方塊：

金鑰設定錯誤訊息的空白元素。

原因

如果 <PublicKey> 元素的子項元素 <Value> 或 <JWKS> 中的 ref 屬性未指定或空白，就會發生這個錯誤。

舉例來說，如果 <PublicKey> 元素的子元素 <Value> 為空，就會發生錯誤。

診斷

  1. 從錯誤訊息中找出 Verify JWT 政策的名稱和空白元素名稱。舉例來說，在下列錯誤訊息中，「Verify JWT」政策的名稱為 JWT-Verify-RS256，元素名稱為 PublicKey/Value：

    Empty Element for Key Configuration : policy(JWT-Verify-RS256) element(PublicKey/Value).

  2. 檢查失敗的「驗證 JWT」政策 XML，確認步驟 1 中識別的元素為空白。如果為空白，就是造成錯誤的原因。

    舉例來說，下列政策顯示 <PublicKey> 元素的子項元素 <Value> 為空：

    <VerifyJWT name="JWT-Verify-RS256">
    <DisplayName>JWT Verify RS256</DisplayName>
    <Algorithm>RS256</Algorithm>
    <IgnoreUnresolvedVariables>false</IgnoreUnresolvedVariables>
    <ExpiresIn>1h</ExpiresIn>
    <PublicKey>
        <Value/>
    </PublicKey>
    <Subject>monty-pythons-flying-circus</Subject>
    <Issuer>urn://apigee-edge-JWT-policy-test</Issuer>
    <Audience>fans</Audience>
    <Id/>
    <AdditionalClaims>
        <Claim name='claim' ref='reqclaim' type='string' array='true'/>
    </AdditionalClaims>
</VerifyJWT>

    由於「驗證 JWT」政策的 <PublicKey> 元素子項 <Value> 為空白，因此您會收到下列錯誤訊息：

    Empty Element for Key Configuration : policy(JWT-Verify-RS256) element(PublicKey/Value).

解析度

請務必指定 <PublicKey> 元素子項元素 <Value> 或 <JWKS> 中的 ref 屬性。

如要修正範例「驗證 JWT」政策，請在 <PublicKey> 元素的子項元素 <Value> 中使用流程變數 public.publickey：

<VerifyJWT name="JWT-Verify-RS256">
    <DisplayName>JWT Verify RS256</DisplayName>
    <Algorithm>RS256</Algorithm>
    <IgnoreUnresolvedVariables>false</IgnoreUnresolvedVariables>
    <PublicKey>
        <Value ref="public.publickey"/>
    </PublicKey>
    <ExpiresIn>1h</ExpiresIn>
    <Subject>monty-pythons-flying-circus</Subject>
    <Issuer>urn://apigee-edge-JWT-policy-test</Issuer>
    <Audience>fans</Audience>
    <Id/>
    <AdditionalHeaders>
        <Claim name='claim' ref='reqclaim' type='string' array='true'/>
    </AdditionalHeaders>
</VerifyJWT>

InvalidConfigurationForVerify

錯誤訊息

透過 Apigee 使用者介面或 API 部署 API Proxy 時失敗，並顯示以下錯誤訊息：

Error Saving Revision revision_number
Invalid configuration element for verify : policy(policy_name) element(element_name).

錯誤訊息示例

Error Saving Revision 3
Invalid configuration element for verify : policy(JWT-Verify-HS256) element(SecretKey/Id).

螢幕截圖範例

Apigee UI 會顯示含有錯誤的對話方塊：

驗證錯誤訊息的設定元素無效。

原因

如果元素 <Id> 是在 VerifyJWT 政策的 <SecretKey> 元素中定義，就會發生這個錯誤。

舉例來說，如果元素 <Id> 是在 <SecretKey> 元素中定義，就會發生這個錯誤。

診斷

  1. 從錯誤訊息中找出「驗證 JWT」政策的名稱和無效元素名稱。舉例來說，在下列錯誤訊息中，「Verify JWT」政策的名稱是 JWT-Verify-RS256，元素名稱則是 SecretKey/Id：

    Invalid configuration element for verify : policy(JWT-Verify-HS256) element(SecretKey/Id)

  2. 檢查失敗的「驗證 JWT」政策 XML，確認步驟 1 中識別出的無效元素已定義。如果已定義，這就是錯誤原因。

    舉例來說，下列政策顯示已定義 <SecretKey> 元素的子項元素 <Id>：

    <VerifyJWT name="JWT-Verify-RS256">
    <DisplayName>JWT Verify RS256</DisplayName>
    <Algorithm>RS256</Algorithm>
    <IgnoreUnresolvedVariables>false</IgnoreUnresolvedVariables>
    <ExpiresIn>1h</ExpiresIn>
    <SecretKey>
        <Value ref="private.secretkey"/>
        <Id/>
    </SecretKey>
    <Subject>monty-pythons-flying-circus</Subject>
    <Issuer>urn://apigee-edge-JWT-policy-test</Issuer>
    <Audience>fans</Audience>
    <Id/>
    <AdditionalClaims>
        <Claim name='claim' ref='reqclaim' type='string' array='true'/>
    </AdditionalClaims>
</VerifyJWT>

    由於 <Id> 元素是在「驗證 JWT」政策的 <SecretKey> 元素中定義，因此您會收到下列錯誤訊息：

    Invalid configuration element for verify : policy(JWT-Verify-HS256) element(SecretKey/Id)

解析度

請確保 <Id> 元素絕不會在驗證 JWT 政策的 <SecretKey> 元素中定義。

如要修正「驗證 JWT」政策範例，請從 <SecretKey> 元素中移除子項元素 <Id>：

<VerifyJWT name="JWT-Verify-RS256">
    <DisplayName>JWT Verify RS256</DisplayName>
    <Algorithm>RS256</Algorithm>
    <IgnoreUnresolvedVariables>false</IgnoreUnresolvedVariables>
    <SecretKey>
        <Value ref='private.secretkey'/>
    </SecretKey>
    <ExpiresIn>1h</ExpiresIn>
    <Subject>monty-pythons-flying-circus</Subject>
    <Issuer>urn://apigee-edge-JWT-policy-test</Issuer>
    <Audience>fans</Audience>
    <Id/>
    <AdditionalHeaders>
        <Claim name='claim' ref='reqclaim' type='string' array='true'/>
    </AdditionalHeaders>
</VerifyJWT>

InvalidEmptyElement

錯誤訊息

透過 Apigee 使用者介面或 API 部署 API Proxy 時失敗，並顯示以下錯誤訊息：

Error Saving Revision 
Invalid empty element : policy(policy_name) element(element_name).

錯誤訊息示例

Error Saving Revision 3
Invalid empty element : policy(JWT-Verify-HS256) element(Source).

螢幕截圖範例

Apigee UI 會顯示含有錯誤的對話方塊：

無效的空白元素錯誤訊息。

原因

如果「驗證 JWT 政策」的 <Source> 元素為空白，就會發生這個錯誤。如果有的話，必須以流程變數名稱定義。

診斷

  1. 從錯誤訊息中找出「驗證 JWT」政策的名稱和空白元素名稱。舉例來說，在下列錯誤訊息中，「Verify JWT」政策的名稱為 JWT-Verify-RS256，元素名稱為 PublicKey/Value：

    Invalid empty element : policy(JWT-Verify-HS256) element(Source).

  2. 檢查失敗的「驗證 JWT」政策 XML，確認步驟 1 中識別的元素為空白。如果為空白，就是造成錯誤的原因。

    舉例來說，下列政策顯示元素 <Source> 為空：

    <VerifyJWT name="JWT-Verify-RS256">
    <DisplayName>JWT Verify RS256</DisplayName>
    <Algorithm>RS256</Algorithm>
    <IgnoreUnresolvedVariables>false</IgnoreUnresolvedVariables>
    <ExpiresIn>1h</ExpiresIn>
    <Source></Source>
    <PublicKey>
        <Value ref="public.publickey"/>
    </PublicKey>
    <Subject>monty-pythons-flying-circus</Subject>
    <Issuer>urn://apigee-edge-JWT-policy-test</Issuer>
    <Audience>fans</Audience>
    <Id/>
    <AdditionalClaims>
        <Claim name='claim' ref='reqclaim' type='string' array='true'/>
    </AdditionalClaims>
</VerifyJWT>

    由於「Verify JWT」政策的 <Source> 元素為空白，因此您會收到下列錯誤：

    Invalid empty element : policy(JWT-Verify-HS256) element(Source).

解析度

如果「驗證 JWT」政策中存在 <Source> 元素，請確認該元素指定了流程變數。

如要修正範例「驗證 JWT」政策，請在 <Source> 元素中使用有效的流程變數：

<VerifyJWT name="JWT-Verify-RS256">
    <DisplayName>JWT Verify RS256</DisplayName>
    <Algorithm>RS256</Algorithm>
    <IgnoreUnresolvedVariables>false</IgnoreUnresolvedVariables>
    <Source>jwt-variable</Source>
    <PublicKey>
        <Value ref="public.publickey"/>
    </PublicKey>
    <ExpiresIn>1h</ExpiresIn>
    <Subject>monty-pythons-flying-circus</Subject>
    <Issuer>urn://apigee-edge-JWT-policy-test</Issuer>
    <Audience>fans</Audience>
    <Id/>
    <AdditionalHeaders>
        <Claim name='claim' ref='reqclaim' type='string' array='true'/>
    </AdditionalHeaders>
</VerifyJWT>

InvalidPublicKeyValue

錯誤訊息

透過 Apigee 使用者介面或 API 部署 API Proxy 時失敗，並顯示以下錯誤訊息：

Error Saving Revision revision_number
Invalid Public Key Value in Configuration : policy(policy_name) element(element_name).

錯誤訊息示例

Error Saving Revision 2
Invalid Public Key Value in Configuration : policy(JWT-Verify-RS256) element(PublicKey/JWKS).

螢幕截圖範例

Apigee UI 會顯示含有錯誤的對話方塊：

設定錯誤訊息中的公開金鑰值無效。

原因

如果 <PublicKey> 元素的子項元素 <JWKS> 中使用的值格式無效 (如 RFC 7517 所指定)，就會發生這個錯誤。

舉例來說，在 <PublicKey> 元素下，將 abc 做為子項元素 <JWKS> 的值，就會導致這項錯誤。

診斷

  1. 從錯誤訊息中找出「驗證 JWT」政策的名稱，以及含有無效值的元素名稱。舉例來說，在下列錯誤訊息中，「Verify JWT」政策的名稱為 JWT-Verify-RS256，元素為 PublicKey/JWKS：

    Invalid Public Key Value in Configuration : policy(JWT-Verify-RS256) element(PublicKey/JWKS).

  2. 檢查失敗的「驗證 JWT」政策 XML，確認步驟 1 中識別的元素是否包含符合 RFC 7517 規範的有效格式值。如果元素的值格式無效，就會導致錯誤。

    <VerifyJWT name="JWT-Verify-RS256">
    <DisplayName>JWT Verify RS256</DisplayName>
    <Algorithm>RS256</Algorithm>
    <IgnoreUnresolvedVariables>false</IgnoreUnresolvedVariables>
    <PublicKey>
        <JWKS>abc<JWKS>
    </PublicKey>
    <ExpiresIn>1h</ExpiresIn>
    <Subject>monty-pythons-flying-circus</Subject>
    <Issuer>urn://apigee-edge-JWT-policy-test</Issuer>
    <Audience>fans</Audience>
    <Id/>
</VerifyJWT>

    由於 <PublicKey> 元素的子項元素 <JWKS> 中的值格式無效 (不符合 RFC 7517)，因此您會收到下列錯誤訊息：

    Invalid Public Key Value in Configuration : policy(JWT-Verify-RS256) element(PublicKey/JWKS).

解析度

確認 <PublicKey> 元素的子項元素 <JWKS> 中指定的值是有效的字串或流程變數，且採用有效的 JWKS 格式 (RFC 7517)。

如要修正範例「驗證 JWT」政策，請按照下方所示變更 <JWKS> 的值：

    <VerifyJWT name="JWT-Verify-RS256">
        <DisplayName>JWT Verify RS256</DisplayName>
        <Algorithm>RS256</Algorithm>
        <IgnoreUnresolvedVariables>false</IgnoreUnresolvedVariables>
        <PublicKey>
        <JWKS>eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VySWQiOiJiMDhmODZhZi0zNWRhLTQ4ZjItOGZhYi1jZWYzOTA0NjYwYmQifQ.-xN_h82PHVTCMA9vdoHrcZxH-x5mb11y1537t3rGzcM</JWKS>
        </PublicKey>
        <ExpiresIn>1h</ExpiresIn>
        <Subject>monty-pythons-flying-circus</Subject>
        <Issuer>urn://apigee-edge-JWT-policy-test</Issuer>
        <Audience>fans</Audience>
        <Id/>
    </VerifyJWT>

InvalidConfigurationForActionAndAlgorithm

錯誤訊息

透過 Apigee 使用者介面或 API 部署 API Proxy 時失敗，並顯示以下錯誤訊息：

Error Saving Revision <var>revision_number</var>
Invalid configuration element for this action and algorithm Family: policy(<var>policy_name</var>) element(<var>element_name</var>) action(<var>action_name</var>) family(<var>family_name</var>).

錯誤訊息示例

Error Saving Revision
Invalid configuration element for this action and algorithm Family: policy(JWT-Verify-HS256) element(PublicKey) action(Verify) family(RSA).

螢幕截圖範例

Apigee UI 會顯示含有錯誤的對話方塊：

這個動作的設定元素無效，且演算法錯誤訊息。

原因

如果 <PublicKey> 元素搭配 HS 系列演算法使用，而 <SecretKey> 元素搭配 RSA 系列演算法使用，就會發生這個錯誤。如果任一條件成立，也會發生錯誤。

舉例來說，使用 <PublicKey> 元素搭配 HS Family 演算法會導致這項錯誤。

診斷

  1. 從錯誤訊息中找出驗證 JWT 政策的名稱、元素名稱和演算法系列名稱。舉例來說，在下列錯誤訊息中，「Verify JWT」政策的名稱為 JWT-Verify-HS256，元素名稱為 PublicKey，演算法系列為 RSA：

    Invalid configuration element for this action and algorithm Family: policy(JWT-Verify-HS256) element(PublicKey) action(Verify) family(RSA).

  2. 確認失敗的「驗證 JWT 政策」XML 中使用的元素和演算法系列，與步驟 1 錯誤訊息中識別的元素和演算法系列相符。舉例來說，下列政策將元素指定為 PublicKey，演算法系列指定為 HMAC，與錯誤訊息中的內容相符

    <VerifyJWT name="JWT-Verify-HS256">
    <DisplayName>JWT Verify HS256</DisplayName>
    <Algorithm>HS256</Algorithm>
    <IgnoreUnresolvedVariables>false</IgnoreUnresolvedVariables>
    <Source>request.formparam.jwt</Source>
    <PublicKey>
        <Value ref="var-value"/>
    </PublicKey>
    <SecretKey>
        <Value ref="private.secretkey"/>
    </SecretKey>
        <ExpiresIn>1h</ExpiresIn>
        <Subject>monty-pythons-flying-circus</Subject>
        <Issuer>urn://apigee-edge-JWT-policy-test</Issuer>
        <Audience>fans</Audience>
    </VerifyJWT>

  3. 如果 <Algorithm> 元素的值為 HS256，但你使用的是 <PublicKey>，就會導致錯誤。

    在上述「驗證 JWT」政策範例中，即使 <Algorithm> 設為系列演算法 HS256，仍會使用 <PublicKey> 元素，導致發生下列錯誤：

    Invalid configuration element for this action and algorithm Family: policy(JWT-Verify-HS256) element(PublicKey) action(Verify) family(RSA).

解析度

請確保 <PublicKey> 元素僅用於 RSA 系列演算法，而 <SecretKey> 元素僅用於 HS 系列演算法。

如要修正範例 Verify JWT 政策，請使用採用 HS256 演算法的 VerifyJWT 政策中的 <SecretKey>：

    <VerifyJWT name="JWT-Verify-HS256">
        <DisplayName>JWT Verify HS256</DisplayName>
        <Algorithm>HS256</Algorithm>
        <IgnoreUnresolvedVariables>false</IgnoreUnresolvedVariables>
        <Source>request.formparam.jwt</Source>
        <SecretKey>
        <Value ref="private.secretkey"/>
    </SecretKey>
        <ExpiresIn>1h</ExpiresIn>
        <Subject>monty-pythons-flying-circus</Subject>
        <Issuer>urn://apigee-edge-JWT-policy-test</Issuer>
        <Audience>fans</Audience>
    </VerifyJWT>