查看 Apigee Edge 說明文件。
前往
Apigee X說明文件。 資訊
InvalidNameForAdditionalClaim
錯誤訊息
透過 Edge UI 或 Edge Management API 部署 API Proxy 會失敗,並顯示以下錯誤訊息:
Error Saving Revision 2 Invalid name for additional claim : policy(policy_name) claim(claim_name).
錯誤訊息示例
Error Saving Revision 2
Invalid name for additional claim : policy(JWT-Generate-HS256) claim(iss).
螢幕截圖範例
邊緣 UI 中會顯示錯誤訊息:
原因
如果 <AdditionalClaims>
元素的子元素 <Claim>
所使用聲明的名稱是下列其中一個註冊名稱,就會發生這個錯誤:
「kid」、「iss」、「sub」、「aud」、「iat」、「exp」、「nbf」、「jti」
已註冊的聲明會在 RFC7519 中指定。
舉例來說,如果在 <AdditionalClaims>
元素下方使用著作權聲明名稱 iss
,就會導致這項錯誤。
診斷
找出「Generate JWT」政策的名稱,以及錯誤訊息中的憑證附加資訊名稱。舉例來說,在下列錯誤訊息中,「Generate JWT」政策名稱為
JWT-Generate-HS256
,憑證附加資訊名稱為iss
:Invalid name for additional claim : policy(JWT-Generate-HS256) claim(iss).
確認失敗的 Generate JWT 政策 XML 之下
<AdditionalClaims>
元素使用的憑證名稱與錯誤訊息 (上述的步驟 1) 中的憑證附加資訊名稱相符。舉例來說,下列政策將聲明指定為iss
,與錯誤訊息中的內容相符:<GenerateJWT name="JWT-Generate-HS256"> <DisplayName>JWT Generate HS256</DisplayName> <Algorithm>HS256</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> </GenerateJWT>
如果
<Claim>
<AdditionalClaims>
元素的子元素使用著作權聲明名稱是下列其中一個註冊名稱:「kid」、「iss」、「sub」、「aud」、「iat」、「exp」、「nbf」、「jti」
這就是發生錯誤的原因
在上述的「產生 JWT 政策」範例中,將
<Claim>
名稱指定為<AdditionalClaims>
元素下的iss
,導致發生錯誤:Invalid name for additional claim : policy(JWT-Generate-HS256) claim(iss).
解析度
請勿使用任何已註冊的名稱「kid」、「iss」、「sub」、「aud」、「iat」、「exp」、「nbf」或「jti」在 <AdditionalClaims>
元素的<Claim>
子項元素中。
如要修正上述範例 JWT 政策,請將憑證附加資訊名稱變更為 status
:
<GenerateJWT name="JWT-Generate-HS256">
<DisplayName>JWT Generate HS256</DisplayName>
<Algorithm>HS256</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>
</GenerateJWT>
InvalidTypeForAdditionalClaim
錯誤訊息
透過 Edge UI 或 Edge Management API 部署 API Proxy 會失敗,並顯示以下錯誤訊息:
Error Saving Revision 2 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-Generate-HS256) claim(claim) type(integer).
螢幕截圖範例
邊緣 UI 中會顯示錯誤訊息:
原因
如果 GenerateJWT 政策 <AdditionalClaims>
元素的子項元素 <Claim>
使用的聲明類型並非下列其中一種類型,就會發生這個錯誤:
string
(預設)、number
、boolean
或 map
舉例來說,如果在 <AdditionalClaims>
元素下方使用著作權聲明類型 integer
,就會發生錯誤。
診斷
找出錯誤訊息中「Generate JWT」政策的名稱、憑證附加資訊名稱,以及憑證附加資訊類型。舉例來說,在下列錯誤訊息中,「Generate JWT」政策名稱為
JWT-Generate-HS256
,憑證附加資訊名稱為claim
,憑證附加資訊類型為integer
:Invalid type for additional claim : policy(JWT-Generate-HS256) claim(claim) type(integer).
確認失敗 JWT 政策 XML 中
<AdditionalClaims>
元素所用的憑證名稱和類型,與步驟 1 的錯誤訊息中指出的聲明名稱和類型相符。舉例來說,下列政策將聲明指定為claim
,類型則指定為integer
,與錯誤訊息的內容相符:<GenerateJWT name="JWT-Generate-HS256"> <DisplayName>JWT Generate HS256</DisplayName> <Algorithm>HS256</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> </GenerateJWT>
如果
<AdditionalClaims>
元素子項元素<Claim>
中使用的聲明類型並非下列其中一種類型:string
(預設)、number
、boolean
或map
這就是發生錯誤的原因
在上述的「Generate JWT」政策範例中,
<AdditionalClaims>
元素下的<Claim>
類型指定為integer
。由於integer
不是支援的類型,您會收到以下錯誤訊息:Invalid type for additional claim : policy(JWT-Generate-HS256) claim(claim) type(integer).
解析度
確認 <AdditionalClaims>
元素的子項元素 <Claim>
只能使用支援的資料類型,例如 string
、number
、boolean
或 map
。
如要修正上述範例 JWT 政策,請將憑證附加資訊類型變更為 boolean
。
<GenerateJWT name="JWT-Generate-HS256">
<DisplayName>JWT Generate HS256</DisplayName>
<Algorithm>HS256</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>
</GenerateJWT>
MissingNameForAdditionalClaim
錯誤訊息
透過 Edge UI 或 Edge Management API 部署 API Proxy 會失敗,並顯示以下錯誤訊息:
Error Saving Revision 2 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-Generate-HS256.xml. Reason: - Required attribute name is missing in Claim
螢幕截圖範例
邊緣 UI 中會顯示錯誤訊息:
原因
如果未在 <AdditionalClaims>
或 <AdditionalHeaders>
元素的子元素 <Claim>
中指定著作權聲明名稱,就會發生這個錯誤。
診斷
找出錯誤訊息中的「Generate JWT」政策名稱。例如,在下列錯誤訊息中,「Generate JWT」政策名稱為
JWT-Generate-HS256
:Error occurred while validation of bean JWT-Generate-HS256.xml. Reason: - Required attribute name is missing in Claim
檢查失敗的 JWT 政策 XML,並確認
<AdditionalClaims>
或<AdditionalHeaders>
元素下的子元素<Claims>
中是否缺少憑證附加資訊。舉例來說,下列「Generate JWT」政策並未在<AdditionalClaims>
下指定憑證附加資訊名稱 元素:<GenerateJWT name="JWT-Generate-HS256"> <DisplayName>JWT Generate HS256</DisplayName> <Algorithm>HS256</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> </GenerateJWT>
由於未在
<AdditionalClaims>
元素下指定<Claim>
名稱,您會收到錯誤訊息:Error occurred while validation of bean JWT-Generate-HS256.xml. Reason: - Required attribute name is missing in Claim
解析度
請務必直接在 <AdditionalClaims>
或 <AdditionalHeaders>
元素的子元素 <Claim>
中指定聲明名稱。
如要修正上述範例 JWT 政策,請指定憑證附加資訊名稱,如下所示:
<GenerateJWT name="JWT-Generate-HS256">
<DisplayName>JWT Generate HS256</DisplayName>
<Algorithm>HS256</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>
</GenerateJWT>
InvalidNameForAdditionalHeader
錯誤訊息
透過 Edge UI 或 Edge Management API 部署 API Proxy 會失敗,並顯示以下錯誤訊息:
Error Saving Revision 2 Invalid name for additional header : policy(policy_name)header(header_name).
錯誤訊息示例
Error Saving Revision 2
Invalid name for additional header: policy(JWT-Generate-HS256) header(alg).
螢幕截圖範例
邊緣 UI 中會顯示錯誤訊息:
原因
如果 <AdditionalHeaders>
元素子項元素 <Claim>
中使用的憑證附加資訊名稱是下列其中一個標準 JWT 標頭,就會發生這個錯誤:
alg
或 typ
舉例來說,如果在 <AdditionalHeaders>
元素下方使用著作權聲明名稱 alg
,就會發生錯誤。
診斷
找出錯誤訊息中的「Generate JWT」政策和標頭名稱。舉例來說,在下列錯誤訊息中,「Generate JWT」政策名稱為
JWT-Generate-HS256
,標頭名稱為alg
:Invalid name for additional header: policy(JWT-Generate-HS256) header(alg).
確認失敗 Generate JWT 政策 XML 中
<AdditionalHeaders>
元素下方,用於子元素<Claim>
的標頭名稱與步驟 1 中錯誤訊息指出的標頭名稱相符。舉例來說,下列政策會將標頭指定為alg
,與錯誤訊息中的內容相符:<GenerateJWT name="JWT-Generate-HS256"> <DisplayName>JWT Generate HS256</DisplayName> <Algorithm>HS256</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> </GenerateJWT>
如果
<AdditionalClaims>
元素的子元素<Claim>
中使用的標頭名稱是下列其中一個標準 JWT 標頭:alg
或typ
這就是發生錯誤的原因
在上述的「產生 JWT 政策」範例中,將
<Claim>
名稱指定為<AdditionalClaims>
元素下的alg
,導致發生錯誤:Invalid name for additional header: policy(JWT-Generate-HS256) header(alg).
解析度
請勿在 <AdditionalHeaders>
元素的子項元素 <Claim>
中使用標準 JWT 標頭 alg
或 typ
。
如要修正上述「產生 JWT 政策」範例,請在 <AdditionalHeaders>
元素的子項元素 <Claim>
中使用名稱 x5c
:
<GenerateJWT name="JWT-Generate-HS256">
<DisplayName>JWT Generate HS256</DisplayName>
<Algorithm>HS256</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>
</GenerateJWT>
InvalidTypeForAdditionalHeader
錯誤訊息
透過 Edge UI 或 Edge Management API 部署 API Proxy 會失敗,並顯示以下錯誤訊息:
Error Saving Revision 2 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-Generate-HS256) claim(claim1) type(integer).
螢幕截圖範例
邊緣 UI 中會顯示錯誤訊息:
原因
如果 GenerateJWT 政策 <AdditionalHeaders>
元素的子元素 <Claim>
使用的聲明類型並非下列其中一種類型,就會發生錯誤:
string
(預設)、number
、boolean
或 map
。
舉例來說,如果在 <AdditionalHeaders>
元素下方使用著作權聲明類型 integer
,就會發生錯誤。
診斷
找出錯誤訊息中「Generate JWT」政策的名稱、憑證附加資訊名稱,以及憑證附加資訊類型。舉例來說,在下列錯誤訊息中,「Generate JWT」政策名稱為
JWT-Generate-HS256
,憑證附加資訊名稱為claim,
,憑證附加資訊類型為integer:
。Invalid type for additional header : policy(JWT-Generate-HS256) claim(claim) type(integer).
確認失敗 JWT 政策 XML 中
<AdditionalClaims>
元素之下所使用的憑證附加資訊名稱和憑證類型,與步驟 1 的錯誤訊息中指出的要求名稱和憑證附加資訊類型相符。舉例來說,下列政策將聲明指定為claim
,聲明類型為integer
,與錯誤訊息的內容相符:<GenerateJWT name="JWT-Generate-HS256"> <DisplayName>JWT Generate HS256</DisplayName> <Algorithm>HS256</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> </GenerateJWT>
如果
<AdditionalHeaders>
元素子項元素<Claim>
中使用的聲明類型並非下列其中一種類型:string
(預設)、number
、boolean
或map
這就是發生錯誤的原因
在上述的「Generate JWT」政策範例中,
<AdditionalHeaders>
元素下的<Claim>
類型指定為integer
。由於integer
不是支援的類型,您會收到以下錯誤訊息:Invalid type for additional header : policy(JWT-Generate-HS256) claim(claim) type(integer).
解析度
確認 <AdditionalHeaders>
元素的子項元素 <Claim>
只能使用支援的資料類型:string
、number
、boolean
或 map
。
如要修正上述範例 JWT 政策,請將憑證附加資訊類型變更為 boolean
:
<GenerateJWT name="JWT-Generate-HS256">
<DisplayName>JWT Generate HS256</DisplayName>
<Algorithm>HS256</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>
</GenerateJWT>
InvalidValueOfArrayAttribute
錯誤訊息
透過 Edge UI 或 Edge Management API 部署 API Proxy 會失敗,並顯示以下錯誤訊息:
Error Saving Revision 2 Invalid value for array attribute: policy(policy_name)claim(claim_name).
錯誤訊息示例
Error Saving Revision 2
Invalid value for array attribute: policy(JWT-Generate-HS256) claim(claim).
螢幕截圖範例
邊緣 UI 中會顯示錯誤訊息:
原因
如果 <AdditionalClaims>
或 <AdditionalHeaders>
元素的子項元素 <Claim>
中的陣列屬性值未設為 true
或 false
,就會發生這個錯誤。
舉例來說,在 <AdditionalClaims>
或 <AdditionalHeaders>
的子項元素 <Claim>
中,將陣列屬性的值設為 yes
會導致錯誤。
診斷
找出「Generate JWT」政策的名稱,以及錯誤訊息中的憑證附加資訊名稱。舉例來說,在下列錯誤訊息中,「Generate JWT」政策名稱為
JWT-Generate-HS256
,憑證附加資訊名稱為claim:
Invalid value for array attribute: policy(JWT-Generate-HS256) claim(claim).
確認失敗 Generate JWT 政策 XML 下,在
<AdditionalHeaders>
元素下的子元素<Claim>
使用的憑證名稱與步驟 1 中錯誤訊息指出的請求名稱相符。舉例來說,下列政策將聲明名稱指定為claim
,即與錯誤訊息顯示的內容相符:<GenerateJWT name="JWT-Generate-HS256"> <DisplayName>JWT Generate HS256</DisplayName> <Algorithm>HS256</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> </GenerateJWT>
如果
<AdditionalClaims>
元素子項元素<Claim>
中的array
屬性值未設為true
或false
,就會是發生錯誤的原因。由於在上例中,
<AdditionalClaims>
元素<Claim>
子元素<Claim>
中的array
屬性已設為yes
,因此您會收到錯誤:Invalid value for array attribute: policy(JWT-Generate-HS256) claim(claim).
解析度
確認 <AdditionalClaims>
或 <AdditionalHeaders>
子項元素 <Claim>
中,陣列屬性的值已設為 true
或 false
。
如要修正上述「產生 JWT 政策」範例,請將陣列屬性值變更為 true
:
<GenerateJWT name="JWT-Generate-HS256">
<DisplayName>JWT Generate HS256</DisplayName>
<Algorithm>HS256</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>
</GenerateJWT>
InvalidConfigurationForActionAndAlgorithm
錯誤訊息
透過 Edge UI 或 Edge Management API 部署 API Proxy 會失敗,並顯示以下錯誤訊息:
Error Saving Revision 2
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 2 Invalid configuration element for this action and algorithm Family: policy(JWT-Generate-HS256) element(PrivateKey) action(Generate) family(HMAC).
螢幕截圖範例
邊緣 UI 中會顯示錯誤訊息:
原因
如果 <PrivateKey>
元素與 HS 家庭演算法搭配使用,且 <SecretKey>
元素與 RSA 系列演算法搭配使用,就會發生這個錯誤。如果符合上述「任一」條件,這個錯誤也會發生。
舉例來說,同時使用 <PrivateKey>
元素和 HS 家庭演算法會產生這個錯誤。
診斷
找出錯誤訊息中「Generate JWT」政策的名稱、元素名稱和演算法系列名稱。舉例來說,在下列錯誤訊息中,「Generate JWT」政策名稱為
JWT-Generate-HS256
,元素名稱為PrivateKey
,演算法系列為HMAC
:Invalid configuration element for this action and algorithm Family: policy(JWT-Generate-HS256) element(PrivateKey) action(Generate) family(HMAC).
確認失敗 JWT 政策 XML 中使用的元素和演算法系列,與步驟 1 中錯誤訊息指出的元素和演算法系列相符。舉例來說,下列政策會將元素指定為
PrivateKey
,演算法系列則指定為HMAC
,與錯誤訊息的內容相符:<GenerateJWT name="JWT-Generate-HS256"> <DisplayName>JWT Generate HS256</DisplayName> <Algorithm>HS256</Algorithm> <IgnoreUnresolvedVariables>false</IgnoreUnresolvedVariables> <PrivateKey> <Password ref="private.privatekey-password"/> </PrivateKey> <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=tuu =/> </AdditionalClaims> </GenerateJWT>
如果
<Algorithm>
元素的值是HS256
,但您使用了<PrivateKey>
,這就是發生錯誤的原因。在上述的「Generate JWT 政策」範例中,即使
<PrivateKey>
已設為家庭演算法HS256
,還是會使用<PrivateKey>
,因而導致錯誤:Invalid configuration element for this action and algorithm Family: policy(JWT-Generate-HS256) element(PrivateKey) action(Generate) family(HMAC).
解析度
確保 <PrivateKey>
元素僅搭配 RSA 系列演算法使用,且 <SecretKey>
元素僅搭配 HS 系列演算法使用。
如要修正上述的 JWT 政策範例,請使用採用 HS256 演算法的 GenerateJWT 政策中的 <SecretKey>
:
<GenerateJWT name="JWT-Generate-HS256">
<DisplayName>JWT Generate HS256</DisplayName>
<Algorithm>HS256</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>
</GenerateJWT>
InvalidValueForElement
錯誤訊息
透過 Edge UI 或 Edge Management API 部署 API Proxy 會失敗,並顯示以下錯誤訊息:
Error Saving Revision 2 Invalid Value for element : policy(policy_name) element(element_name).
錯誤訊息示例
Error Saving Revision 2
Invalid Value for element : policy(JWT-Generate-HS256) element(Algorithm).
螢幕截圖範例
邊緣 UI 中會顯示錯誤訊息:
原因
如果 <Algorithm>
元素中指定的值不是下列其中一個值,就會發生這個錯誤:
HS256
、HS384
、HS512
、RS256
、RS384
、RS512
舉例來說,在 <Algorithm>
元素中將演算法值指定為 RS128
,就會導致這項錯誤。
診斷
找出「Generate JWT」政策的名稱,以及錯誤訊息中的元素名稱。舉例來說,在下列錯誤訊息中,「Generate JWT」政策名稱為
JWT-Generate-HS256
,元素名稱為「Algorithm.
」Invalid Value for element : policy(JWT-Generate-HS256) element(Algorithm).
檢查失敗的 Generate JWT 政策 XML 並檢查
<Algorithm>
元素指定的值。以下是「產生 JWT」政策的範例:
<GenerateJWT name="JWT-Generate-HS256"> <DisplayName>JWT Generate HS256</DisplayName> <Algorithm>HS128</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> </GenerateJWT>
檢查
<Algorithm>
元素中指定的值。如果不是下列任一值:HS256
、HS384
、HS512
、RS256
、RS384
、RS512
這就是發生錯誤的原因
在上述的「Generate JWT」政策範例中,
<Algorithm>
名稱指定為HS128
。因為系統不支援的演算法,所以會收到以下錯誤訊息:Invalid Value for element : policy(JWT-Generate-HS256) element(Algorithm).
解析度
確認 <Algorithm>
元素中指定的值是系統支援的值之一:
HS256
、HS384
、HS512
、RS256
、RS384
、RS512
如要修正上述範例的「產生 JWT 政策」(使用 <SecretKey>
元素),請將 <Algorithm>
的值變更為 HS25
。請注意,使用 <SecretKey>
元素時,您只能使用 HS 家庭演算法。
<GenerateJWT name="JWT-Generate-HS256">
<DisplayName>JWT Generate HS256</DisplayName>
<Algorithm>HS256</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>
</GenerateJWT>
MissingConfigurationElement
錯誤訊息
透過 Edge UI 或 Edge Management API 部署 API Proxy 會失敗,並顯示以下錯誤訊息:
Error Saving Revision 2 Missing configuration element : policy(policy_name) element(element_name).
錯誤訊息示例
Error Saving Revision 2
Missing configuration element : policy(JWT-Generate-HS256) element(SecretKey).
螢幕截圖範例
邊緣 UI 中會顯示錯誤訊息:
原因
如果 <PrivateKey>
元素「未」用於「Generate JWT」政策中的 RSA 系列演算法,就會發生這個錯誤。同樣地,如果在 Generate JWT 政策中<SecretKey>
元素並未搭配使用 HS 系列演算法,也可能會發生錯誤。
舉例來說,如未搭配 RSA 家庭演算法使用 <PrivateKey>
元素,就會發生這項錯誤。
診斷
找出「Generate JWT」政策的名稱,以及錯誤訊息中缺少的元素名稱。舉例來說,在下列錯誤訊息中,「Generate JWT」政策名稱為
JWT-Generate-HS256
,缺少的元素名稱為SecretKey
。Missing configuration element : policy(JWT-Generate-HS256) element(SecretKey).
檢查失敗的 JWT 政策 XML,並確認錯誤訊息中指定的元素不存在。如果缺少這個鍵,就是發生錯誤的原因。
舉例來說,下列政策缺少
SecretKey
,而使用的Algorithm
為HS256
:<GenerateJWT name="JWT-Generate-HS256"> <DisplayName>JWT Generate HS256</DisplayName> <Algorithm>HS256</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> </GenerateJWT>
「產生 JWT 政策」範例使用 HS 家庭演算法,但缺少必要的元素
SecretKey
,因而導致錯誤:Missing configuration element : policy(JWT-Generate-HS256) element(SecretKey).
解析度
確保必要的 <PrivateKey>
元素與 RSA 家庭演算法搭配使用,且必須使用必要的 <SecretKey>
元素與 HS 系列演算法搭配使用。
如要修正上述範例的「產生 JWT 政策」(使用 HS256
演算法),請將 <SecretKey>
元素新增至「Generate JWT」政策:
<GenerateJWT name="JWT-Generate-HS256">
<DisplayName>JWT Generate HS256</DisplayName>
<Algorithm>HS256</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>
</GenerateJWT>
InvalidKeyConfiguration
錯誤訊息
透過 Edge UI 或 Edge Management API 部署 API Proxy 會失敗,並顯示以下錯誤訊息:
Error Saving RevisionInvalid Key configuration : policy(policy_name).
錯誤訊息示例
Error Saving Revision 3
Invalid Key configuration : policy(JWT-Generate-HS256).
螢幕截圖範例
邊緣 UI 中會顯示錯誤訊息:
原因
如果 JWT 政策的 <PrivateKey>
或 <SecretKey>
元素中未定義必要的子元素 <Value>
,就會發生這個錯誤。
診斷
找出錯誤訊息中的「Generate JWT」政策名稱。例如,在下列錯誤訊息中,「Generate JWT」政策名稱為
JWT-Generate-HS256
。Invalid Key configuration : policy(JWT-Generate-HS256).
檢查失敗的 JWT 政策 XML,並確認
<PrivateKey>
或<SecretKey>
元素中是否已定義子元素<Value>
。如果未定義<Value>
,表示發生錯誤。舉例來說,在下列政策中,
<SecretKey>
元素並未定義子元素<Value>
:<GenerateJWT name="JWT-Generate-HS256"> <DisplayName>JWT Generate HS256</DisplayName> <Algorithm>HS256</Algorithm> <IgnoreUnresolvedVariables>false</IgnoreUnresolvedVariables> <ExpiresIn>1h</ExpiresIn> <SecretKey> </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> </GenerateJWT>
由於 Generate JWT 政策的
<SecretKey>
元素並未定義子元素<Value>
,因此您會收到錯誤訊息:Invalid Key configuration : policy(JWT-Generate-HS256).
解析度
確認「Generate JWT」政策的 <PrivateKey>
或 <SecretKey>
元素一律定義了子項元素 <Value>
。
如要修正上述「產生 JWT 政策」範例,請在 <SecretKey>
元素下方定義子元素 <Value>
,如下所示:
<GenerateJWT name="JWT-Generate-HS256">
<DisplayName>JWT Generate HS256</DisplayName>
<Algorithm>HS256</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>
</GenerateJWT>
EmptyElementForKeyConfiguration
錯誤訊息
透過 Edge UI 或 Edge Management API 部署 API Proxy 會失敗,並顯示以下錯誤訊息:
Error Saving Revision 2 Empty Element for Key Configuration : policy(policy_name) element(element_name).
錯誤訊息示例
Error Saving Revision 2
Empty Element for Key Configuration : policy(JWT-Generate-HS256) element(SecretKey/Value).
螢幕截圖範例
邊緣 UI 中會顯示錯誤訊息:
原因
如果 <PrivateKey>
或 <SecretKey>
元素的子項元素 <Value>
中的 ref 屬性未指定或空白,就會發生這個錯誤。
舉例來說,如果 <SecretKey>
元素的子元素 <Value>
為空白,就會發生錯誤。
診斷
找出「Generate JWT」政策的名稱,以及錯誤訊息中的空白元素名稱。例如,在下列錯誤訊息中,「Generate JWT」政策名稱為
JWT-Generate-HS256
,空白元素名稱為SecretKey/Value
。Empty Element for Key Configuration : policy(JWT-Generate-HS256) element(SecretKey/Value).
檢查失敗的 Generate JWT 政策 XML,並確認步驟 1 中指定的元素是否為空白。如果沒有任何內容,就是發生錯誤的原因。
舉例來說,下列政策顯示
<SecretKey>
元素的子元素<Value>
為空白:<GenerateJWT name="JWT-Generate-HS256"> <DisplayName>JWT Generate HS256</DisplayName> <Algorithm>HS256</Algorithm> <IgnoreUnresolvedVariables>false</IgnoreUnresolvedVariables> <ExpiresIn>1h</ExpiresIn> <SecretKey> <Value/> <Id>1918290</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> </GenerateJWT>
由於「Generate JWT」政策中
<SecretKey>
元素的子元素<Value>
沒有任何內容,因此系統會顯示錯誤訊息:Empty Element for Key Configuration : policy(JWT-Generate-HS256) element(SecretKey/Value).
解析度
請務必指定 <PrivateKey>
或 <SecretKey>
子元素 <Value>
子元素中的 ref 屬性,且其前置字串為「private.
」。
如要修正上述的「產生 JWT 政策」範例,請在 <SecretKey>
元素的子項元素 <Value>
中使用資料流變數 private.privatekey
。
<GenerateJWT name="JWT-Generate-HS256">
<DisplayName>JWT Generate HS256</DisplayName>
<Algorithm>HS256</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>
</GenerateJWT>
InvalidVariableNameForSecret
錯誤訊息
透過 Edge UI 或 Edge Management API 部署 API Proxy 會失敗,並顯示以下錯誤訊息:
Error Saving Revision 2 Invalid variable name for secret : policy(policy_name) element(element_name).
錯誤訊息示例
Error Saving Revision 2
Invalid variable name for secret : policy(JWT-Generate-HS256) element(SecretKey/Value).
螢幕截圖範例
邊緣 UI 中會顯示錯誤訊息:
原因
如果 <PrivateKey>
或 <SecretKey>
元素的子項元素 <Value>
的 ref 屬性中指定的流程變數名稱不含私人前置字元 (private.
),就會發生這個錯誤。
For example :
在 <PrivateKey>
元素子項元素 <Value>
的 ref 屬性中,如果流程變數名稱指定為 mykey
,就會發生這個錯誤。
診斷
找出「Generate JWT」政策的名稱,以及錯誤訊息中含無效變數名稱的元素名稱。舉例來說,在下列錯誤訊息中,「Generate JWT」政策名稱為
JWT-Generate-HS256
,元素名稱為SecretKey/Value
。Invalid variable name for secret : policy(JWT-Generate-HS256) element(SecretKey/Value).
檢查失敗的 JWT 政策 XML,並驗證元素中使用的變數名稱 (如步驟 1 所示)。如果變數名稱不含前置字串
private.
,這就是發生錯誤的原因。舉例來說,下列政策顯示
<SecretKey>
元素的子元素<Value>
含有無效的變數名稱mykey
:<GenerateJWT name="JWT-Generate-HS256"> <DisplayName>JWT Generate HS256</DisplayName> <Algorithm>HS256</Algorithm> <IgnoreUnresolvedVariables>false</IgnoreUnresolvedVariables> <ExpiresIn>1h</ExpiresIn> <SecretKey> <Value ref="mykey"/> <Id>1918290</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> </GenerateJWT>
由於 JWT 政策的
<SecretKey>
元素<Value>
子元素<Value>
中指定的變數名稱不含前置字元private.
,因此您會收到錯誤訊息:Invalid variable name for secret : policy(JWT-Generate-HS256) element(SecretKey/Value).
解析度
請確認 <PrivateKey>
或 <SecretKey>
元素子項元素 <Value>
中的 ref 屬性一律指定,且其前置字元為 private.
。
如要修正上述的「產生 JWT 政策」範例,請在 <SecretKey>
元素的子項元素 <Value>
中使用資料流變數 private.privatekey
:
<GenerateJWT name="JWT-Generate-HS256">
<DisplayName>JWT Generate HS256</DisplayName>
<Algorithm>HS256</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>
</GenerateJWT>
InvalidSecretInConfig
錯誤訊息
透過 Edge UI 或 Edge Management API 部署 API Proxy 會失敗,並顯示以下錯誤訊息:
Error Saving Revision 2 Specifying a secret in the configuration is invalid : policy(policy_name) element(element_name).
錯誤訊息示例
Error Saving Revision 2
Specifying a secret in the configuration is invalid : policy(JWT-Generate-HS256) element(SecretKey/Value).
螢幕截圖範例
邊緣 UI 中會顯示錯誤訊息:
原因
如果在下列位置明確指定該值 (秘密),就會發生此錯誤:
<PrivateKey>
元素的<Value>
或<Password>
子元素,或<SecretKey>
元素的子元素<Value>
。
舉例來說,如果在 <SecretKey>
元素的子項元素 <Value>
中將密鑰明確指定為 abc
,就會發生這個錯誤。
診斷
找出「Generate JWT」政策的名稱和元素名稱,其中有錯誤訊息中明確指定的密鑰。舉例來說,在下列錯誤訊息中,「Generate JWT」政策名稱為
JWT-Generate-HS256
,元素名稱為SecretKey/Value
。Specifying a secret in the configuration is invalid : policy(JWT-Generate-HS256) element(SecretKey/Value).
檢查失敗的 JWT 政策 XML,並驗證是否已在步驟 1 識別的元素中明確指定密鑰。如果已明確指定,就會導致錯誤。
舉例來說,下列政策顯示已在
<SecretKey>
元素的子項元素<Value>
中明確指定密鑰:<GenerateJWT name="JWT-Generate-HS256"> <DisplayName>JWT Generate HS256</DisplayName> <Algorithm>HS256</Algorithm> <IgnoreUnresolvedVariables>false</IgnoreUnresolvedVariables> <ExpiresIn>1h</ExpiresIn> <SecretKey> <Value>abc</Value> <Id>1918290</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> </GenerateJWT>
由於密鑰已在 JWT 政策
<SecretKey>
元素<Value>
的子項元素中指定,因此您會收到錯誤訊息:Specifying a secret in the configuration is invalid : policy(JWT-Generate-HS256) element(SecretKey/Value).
解析度
確保一律在 <PrivateKey>
或 <SecretKey>
元素的子項元素 <Value>
中,將該值指定為資料流變數。
如要修正上述「產生 JWT 政策」範例,請在 <SecretKey>
的子項元素 <Value>
的 ref 屬性中使用資料流變數 private.secretkey
:
<GenerateJWT name="JWT-Generate-HS256">
<DisplayName>JWT Generate HS256</DisplayName>
<Algorithm>HS256</Algorithm>
<IgnoreUnresolvedVariables>false</IgnoreUnresolvedVariables>
<ExpiresIn>1h</ExpiresIn>
<SecretKey>
<Value ref="private.secretkey"/>
<Id>1918290</Id>
</SecretKey>
<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>
</GenerateJWT>
InvalidTimeFormat
錯誤訊息
透過 Edge UI 或 Edge Management API 部署 API Proxy 會失敗,並顯示以下錯誤訊息:
Error Saving Revision 2 Invalid Time format: policy(policy_name) element(element_name).
錯誤訊息示例
Error Saving Revision 3
Invalid Time format: policy(JWT-Generate-HS256) element(NotBefore).
螢幕截圖範例
邊緣 UI 中會顯示錯誤訊息:
原因
如果 <NotBefore>
元素中指定的值不是以下支援的格式之一,就會發生這個錯誤:
sortable
、RFC 1123
、RFC 850
、ANCI-C
舉例來說,如果 <NotBefore>
中指定的值是 20-JUN-1990 08:03
但系統不支援的格式,就會發生這個錯誤。
<NotBefore>20-JUN-1990 08:03:00:21-07:00</NotBefore>
診斷
找出「Generate JWT」政策的名稱,以及錯誤訊息中時間格式無效的元素名稱。舉例來說,在下列錯誤訊息中,「Generate JWT」政策名稱為
JWT-Generate-HS256
,元素名稱為NotBefore
。Invalid Time format: policy(JWT-Generate-HS256) element(NotBefore).
檢查失敗的 JWT 政策 XML,並驗證步驟 1 指定元素中使用的時間格式。如果元素未使用任何支援的格式:
sortable
、RFC 1123
、RFC 850
、ANCI-C
這就是發生錯誤的原因
舉例來說,下列政策顯示子元素
<NotBefore>
使用不支援的時間格式:<GenerateJWT name="JWT-Generate-HS256"> <DisplayName>JWT Generate HS256</DisplayName> <Algorithm>HS256</Algorithm> <IgnoreUnresolvedVariables>false</IgnoreUnresolvedVariables> <ExpiresIn>1h</ExpiresIn> <NotBefore>20-JUN-1990 08:03:00:21-07:00</NotBefore> <SecretKey> <Value ref="private.secretkey"/> <Id>1918290</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> </GenerateJWT>
由於「Generate JWT」政策的元素
<NotBefore>
並未使用任何支援的時間格式,因此系統會顯示錯誤訊息:Invalid variable name for secret : policy(JWT-Generate-HS256) element(SecretKey/Value).
解析度
確認 <NotBefore>
元素中指定的值使用其中一種支援的格式:
sortable
、RFC 1123
、RFC 850
、ANCI-C
如要修正「產生 JWT 政策」範例,請修改 <NotBefore>
元素中的日期來使用 sortable
格式,如下所示:
<GenerateJWT name="JWT-Generate-HS256">
<DisplayName>JWT Generate HS256</DisplayName>
<Algorithm>HS256</Algorithm>
<IgnoreUnresolvedVariables>false</IgnoreUnresolvedVariables>
<ExpiresIn>1h</ExpiresIn>
<NotBefore>2018-08-14T11:00:21-07:00</NotBefore>
<SecretKey>
<Value ref="private.secretkey"/>
<Id>1918290</Id>
</SecretKey>
<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>
</GenerateJWT>