ポリシーエラーリファレンス

Access Control ポリシー

このセクションでは、このポリシーによってエラーがトリガーされたときに返される障害コードとエラーメッセージ、Edge によって設定される障害変数について説明します。これは、障害に対処する障害ルールを作成するうえで重要な情報です。詳細については、ポリシーエラーについて知っておくべきことと障害の処理をご覧ください。

ランタイムエラー

このエラーは、ポリシーの実行時に発生することがあります。

障害コード	HTTP ステータス	原因	修正
`accesscontrol.IPDeniedAccess`	403	クライアント IP アドレス、または API リクエストで渡された IP アドレスが、Access Control ポリシーの `<MatchRule>` 要素内の `<SourceAddress>` 要素で指定された IP アドレスと一致し、`<MatchRule>` 要素の `action` 属性が `DENY` に設定されます。

障害変数

ランタイムエラーが発生すると、次の変数が設定されます。詳細については、ポリシーエラーに固有の変数をご覧ください。

変数	説明	例
`fault.name="fault_name"`	`fault_name` は、上記のランタイムエラーの表に記載されている障害の名前です。障害名は、障害コードの最後の部分です。	`fault.name Matches "IPDeniedAccess"`
`acl.policy_name.failed`	`policy_name` は、障害が発生したポリシーのユーザー指定の名前です。	`acl.AC-AllowAccess.failed = true`

障害レスポンスの例

注: ベストプラクティスとして、障害処理では、障害レスポンスの errorcode の部分をトラップすることをおすすめします。faultstring のテキストには依存しないでください。この部分は変更される可能性があります。

{
   "fault":{
     "faultstring":"Access Denied for client ip : 52.211.243.3"
      "detail":{
         "errorcode":"accesscontrol.IPDeniedAccess"
      }
   }
}

障害ルールの例

<FaultRule name="IPDeniedAccess">
    <Step>
        <Name>AM-IPDeniedAccess</Name>
        <Condition>(fault.name Matches "IPDeniedAccess") </Condition>
    </Step>
    <Condition>(acl.failed = true) </Condition>
</FaultRule>

Access Entity ポリシー

関連情報については、ポリシーエラーについて知っておくべきことと障害の処理をご覧ください。

ランタイムエラー

なし。

デプロイエラー

エラー名	障害文字列	HTTP ステータス	発生条件
`InvalidEntityType`	`Invalid type [entity_type] in ACCESSENTITYStepDefinition [policy_name]`	なし	使用するエンティティタイプをサポートされているタイプのいずれかにする必要があります。

Assign Message ポリシー

This section describes the fault codes and error messages that are returned and fault variables that are set by Edge when this policy triggers an error. This information is important to know if you are developing fault rules to handle faults. To learn more, see What you need to know about policy errors and Handling faults.

Runtime errors

These errors can occur when the policy executes.

Fault code HTTP status Cause Fix

steps.assignmessage.SetVariableFailed 500 The policy was not able to set a variable. See the fault string for the name of the unresolved variable.

Fault code	HTTP status	Cause
`steps.assignmessage.SetVariableFailed`	500	The policy was not able to set a variable. See the fault string for the name of the unresolved variable.
`steps.assignmessage.VariableOfNonMsgType`	500	This error occurs if the `source` attribute in the `<Copy>` element is set to a variable which is not of type message. Message type variables represent entire HTTP requests and responses. The built-in Edge flow variables `request`, `response`, and `message` are of type message. To learn more about message variables, see the Variables reference.
`steps.assignmessage.UnresolvedVariable`	500	This error occurs if a variable specified in the Assign Message policy is either: out of scope (not available in the specific flow where the policy is being executed) or can't be resolved (is not defined)

steps.assignmessage.VariableOfNonMsgType

500

This error occurs if the source attribute in the <Copy> element is set to a variable which is not of type message.

Message type variables represent entire HTTP requests and responses. The built-in Edge flow variables request, response, and message are of type message. To learn more about message variables, see the Variables reference.

steps.assignmessage.UnresolvedVariable

500

This error occurs if a variable specified in the Assign Message policy is either:

out of scope (not available in the specific flow where the policy is being executed)
can't be resolved (is not defined)

Deployment errors

These errors can occur when you deploy a proxy containing this policy.

Error name	Cause	Fix
`InvalidIndex`	If the index specified in the `<Copy>` and/or `<Remove>` elements of the Assign Message policy is 0 or a negative number, then deployment of the API Proxy fails.
`InvalidVariableName`	If the child element `<Name>` is empty or not specified in the `<AssignVariable>` element, then the deployment of the API proxy fails because there is no valid variable name to which to assign a value. A valid variable name is required.
`InvalidPayload`	A payload specified in the policy is invalid.

Fault variables

These variables are set when this policy triggers an error at runtime. For more information, see What you need to know about policy errors.

Variables	Where	Example
`fault.name="fault_name"`	`fault_name` is the name of the fault, as listed in the Runtime errors table above. The fault name is the last part of the fault code.	`fault.name Matches "UnresolvedVariable"`
`assignmessage.policy_name.failed`	`policy_name` is the user-specified name of the policy that threw the fault.	`assignmessage.AM-SetResponse.failed = true`

Example error response

Note: For error handling, the best practice is to trap the errorcode part of the error response. Do not rely on the text in the faultstring, because it could change.

{  
   "fault":{  
      "detail":{  
         "errorcode":"steps.assignmessage.VariableOfNonMsgType"
      },
      "faultstring":"AssignMessage[AM-SetResponse]: value of variable is not of type Message"
   }
}

Example fault rule

    <FaultRule name="Assign Message Faults">    <Step>
        <Name>AM-CustomNonMessageTypeErrorResponse</Name>
        <Condition>(fault.name Matches "VariableOfNonMsgType") </Condition>
    </Step>
    <Step>
        <Name>AM-CustomSetVariableErrorResponse</Name>
        <Condition>(fault.name = "SetVariableFailed")</Condition>
    </Step>
    <Condition>(assignmessage.failed = true) </Condition>
</FaultRule>

Basic Authentication ポリシー

This section describes the fault codes and error messages that are returned and fault variables that are set by Edge when this policy triggers an error. This information is important to know if you are developing fault rules to handle errors. To learn more, see What you need to know about policy errors and Handling faults.

Runtime errors

These errors can occur when the policy executes.

Fault code	HTTP status	Cause	Fix
`steps.basicauthentication.InvalidBasicAuthenticationSource`	500	On a decode when the incoming Base64 encoded string does not contain a valid value or the header is malformed (e.g., does not start with "Basic").
`steps.basicauthentication.UnresolvedVariable`	500	The required source variables for the decode or encode are not present. This error can only occur if `IgnoreUnresolvedVariables` is false.

Deployment errors

These errors can occur when you deploy a proxy containing this policy.

Error name	Occurs when	Fix
`UserNameRequired`	The `<User>` element must be present for the named operation.
`PasswordRequired`	The `<Password>` element must be present for the named operation.
`AssignToRequired`	The `<AssignTo>` element must be present for the named operation.
`SourceRequired`	The `<Source>` element must be present for the named operation.

Fault variables

These variables are set when a runtime error occurs. For more information, see What you need to know about policy errors.

Variables	Where	Example
`fault.name="fault_name"`	`fault_name` is the name of the fault, as listed in the Runtime errors table above. The fault name is the last part of the fault code.	`fault.name Matches "UnresolvedVariable"`
`BasicAuthentication.policy_name.failed`	`policy_name` is the user-specified name of the policy that threw the fault.	`BasicAuthentication.BA-Authenticate.failed = true`

Example error response

Note: For error handling, the best practice is to trap the errorcode part of the error response. Do not rely on the text in the faultstring, because it could change.

{  
   "fault":{  
      "detail":{  
         "errorcode":"steps.basicauthentication.UnresolvedVariable"
      },
      "faultstring":"Unresolved variable : request.queryparam.password"
   }
}

Example fault rule

<FaultRule name="Basic Authentication Faults">
    <Step>
        <Name>AM-UnresolvedVariable</Name>
        <Condition>(fault.name Matches "UnresolvedVariable") </Condition>
    </Step>
    <Step>
        <Name>AM-AuthFailedResponse</Name>
        <Condition>(fault.name = "InvalidBasicAuthenticationSource")</Condition>
    </Step>
    <Condition>(BasicAuthentication.BA-Authentication.failed = true) </Condition>
</FaultRule>

Concurrent Rate Limit ポリシー

このセクションでは、このポリシーによってエラーがトリガーされたときに返される障害コードとエラーメッセージ、Edge によって設定される障害変数について説明します。これは、エラーに対処する障害ルールを作成するうえで重要な情報です。詳細については、ポリシーエラーについて知っておくべきことと障害の処理をご覧ください。

ランタイムエラー

このエラーは、ポリシーの実行時に発生することがあります。

障害コード HTTP ステータスエラーが発生する条件

障害コード	HTTP ステータス	エラーが発生する条件
`policies.concurrentratelimit.ConcurrentRatelimtViolation`	503	ConcurrentRatelimit 接続を超過した。接続制限: {0} 注: 左側に示す障害コードは正しいですが、にスペルミス（「limt」）が含まれている。ここに表示されているコードをそのまま使用してくださいエラーをトラップするための障害ルールを作成します。

policies.concurrentratelimit.ConcurrentRatelimtViolation

503

ConcurrentRatelimit 接続を超過した。接続制限: {0}

注: 左側に示す障害コードは正しいですが、にスペルミス（「limt」）が含まれている。ここに表示されているコードをそのまま使用してくださいエラーをトラップするための障害ルールを作成します。

デプロイエラー

エラー名	エラーが発生する条件
`InvalidCountValue`	ConcurrentRatelimit に無効なカウント値が指定されている。
`ConcurrentRatelimitStepAttachment\ NotAllowedAtProxyEndpoint`	プロキシで同時レート制限ポリシー {0} の接続が許可されない障害の 3 つのパスがあります。このポリシーは、Target Endpont に配置する必要があります。
`ConcurrentRatelimitStepAttachment\ MissingAtTargetEndpoint`	同時レート制限ポリシー {0} アタッチメントがターゲットリクエスト/レスポンス/障害にないあります。このポリシーは、Target Request Preflow、Target Response Postflow、DefaultFaultRule に配置する必要があります。
`InvalidTTLForMessageTimeOut`	メッセージのタイムアウトに指定された ConcurrentRatelimit の無効な ttl 値。正の整数を指定する必要があります。

障害変数

このポリシーがエラーをトリガーした場合は、次の変数が設定されます。詳細については、ポリシーエラーについて知っておくべきことをご覧ください。

変数	説明	例
`fault.name="fault_name"`	`fault_name` は、上記のランタイムエラーの表に記載されている障害の名前です。障害コードの最後の部分が障害名になります。	`fault.name Matches "ConcurrentRatelimtViolation"` 注: スペルミス（「limt」）が含まれていますが、この例に表示されているエラーコードは正確です。このエラーをトラップする障害ルールを作成する際には、ここに表示されているコードを正確に使用してください。
`concurrentratelimit.policy_name.failed`	`policy_name` は、障害をスローしたポリシーのユーザー指定の名前です。	`concurrentratelimit.CRL-RateLimitPolicy.failed = true`

エラーレスポンスの例

レート制限を超えると、ポリシーはクライアントに HTTP ステータス 503 のみを返します。

障害ルールの例

<faultrule name="VariableOfNonMsgType"></faultrule><FaultRules>
    <FaultRule name="Quota Errors">
        <Step>
            <Name>JavaScript-1</Name>
            <Condition>(fault.name Matches "ConcurrentRatelimtViolation") </Condition>
        </Step>
        <Condition>concurrentratelimit.CRL-RateLimitPolicy.failed=true</Condition>
    </FaultRule>
</FaultRules>

Decode JWS ポリシー

ランタイムエラー

このエラーは、ポリシーの実行時に発生することがあります。

障害コード	HTTP ステータス	発生条件
`steps.jws.FailedToDecode`	401	ポリシーで JWS をデコードできなかった場合。JWS が破損している可能性があります。
`steps.jws.FailedToResolveVariable`	401	ポリシーの `<Source>` 要素で指定されたフロー変数が存在しない場合に発生します。
`steps.jws.InvalidClaim`	401	クレームが欠落しているか、一致していない場合。または、ヘッダーが欠落しているか、一致していない場合。
`steps.jws.InvalidJsonFormat`	401	無効な JSON が JWS ヘッダーで検出された場合。
`steps.jws.InvalidJws`	401	JWS 署名の検証で不合格だった場合。
`steps.jws.InvalidPayload`	401	JWS ペイロードが無効な場合。
`steps.jws.InvalidSignature`	401	`<DetachedContent>` が省略され、JWS に分離済みのコンテンツペイロードがある場合。
`steps.jws.MissingPayload`	401	JWS ペイロードが欠落している場合。
`steps.jws.NoAlgorithmFoundInHeader`	401	JWS がアルゴリズムヘッダーを省略すると発生します。
`steps.jws.UnknownException`	401	不明な例外が発生した場合。

デプロイエラー

以下のエラーは、このポリシーを含むプロキシをデプロイするときに発生することがあります。

エラー名エラーが発生する条件

InvalidAlgorithm 有効な値は、RS256、RS384、RS512、PS256、PS384、PS512、ES256、ES384、ES512、HS256、HS384、HS512 のみです。

エラー名	エラーが発生する条件
`InvalidAlgorithm`	有効な値は、RS256、RS384、RS512、PS256、PS384、PS512、ES256、ES384、ES512、HS256、HS384、HS512 のみです。
`EmptyElementForKeyConfiguration` `FailedToResolveVariable` `InvalidConfigurationForActionAndAlgorithmFamily` `InvalidConfigurationForVerify` `InvalidEmptyElement` `InvalidFamiliesForAlgorithm` `InvalidKeyConfiguration` `InvalidNameForAdditionalClaim` `InvalidNameForAdditionalHeader` `InvalidPublicKeyId` `InvalidPublicKeyValue` `InvalidSecretInConfig` `InvalidTypeForAdditionalClaim` `InvalidTypeForAdditionalHeader` `InvalidValueForElement` `InvalidValueOfArrayAttribute` `InvalidVariableNameForSecret` `MissingConfigurationElement` `MissingElementForKeyConfiguration` `MissingNameForAdditionalClaim` `MissingNameForAdditionalHeader`	その他の発生の可能性があるデプロイエラー。

EmptyElementForKeyConfiguration

FailedToResolveVariable

InvalidConfigurationForActionAndAlgorithmFamily

InvalidConfigurationForVerify

InvalidEmptyElement

InvalidFamiliesForAlgorithm

InvalidKeyConfiguration

InvalidNameForAdditionalClaim

InvalidNameForAdditionalHeader

InvalidPublicKeyId

InvalidPublicKeyValue

InvalidSecretInConfig

InvalidTypeForAdditionalClaim

InvalidTypeForAdditionalHeader

InvalidValueForElement

InvalidValueOfArrayAttribute

InvalidVariableNameForSecret

MissingConfigurationElement

MissingElementForKeyConfiguration

MissingNameForAdditionalClaim

MissingNameForAdditionalHeader

その他の発生の可能性があるデプロイエラー。

障害変数

ランタイムエラーが発生すると、次の変数が設定されます。詳細については、ポリシーエラーについて知っておくべきことをご覧ください。

変数	説明	例
`fault.name="fault_name"`	`fault_name` は、上記のランタイムエラーの表に記載されている障害の名前です。障害名は、障害コードの最後の部分です。	`fault.name Matches "TokenExpired"`
`JWS.failed`	障害の場合は、すべての JWS ポリシーで同じ変数が設定されます。	`jws.JWS-Policy.failed = true`

エラーレスポンスの例

ベストプラクティスとして、エラー処理でエラーレスポンスの errorcode の部分をトラップすることをおすすめします。faultstring のテキストには依存しないでください。この部分は変更される可能性があります。

障害ルールの例

<FaultRules>
    <FaultRule name="JWS Policy Errors">
        <Step>
            <Name>JavaScript-1</Name>
            <Condition>(fault.name Matches "TokenExpired")</Condition>
        </Step>
        <Condition>JWS.failed=true</Condition>
    </FaultRule>
</FaultRules>

Decode JWT ポリシー

Runtime errors

These errors can occur when the policy executes.

Fault code	HTTP status	Cause
`steps.jwt.FailedToDecode`	401	Occurs when the policy is unable to decode the JWT. The JWT may be malformed, invalid or otherwise not decodable.
`steps.jwt.FailedToResolveVariable`	401	Occurs when the flow variable specified in the `<Source>` element of the policy does not exist.
`steps.jwt.InvalidToken`	401	Occurs when the flow variable specified in the `<Source>` element of the policy is out of scope or can't be resolved.

Deployment errors

These errors can occur when you deploy a proxy containing this policy.

Error name	Cause	Fix
`InvalidEmptyElement`	Occurs when the flow variable containing the JWT to be decoded is not specified in the `<Source>` element of the policy.

Fault variables

These variables are set when a runtime error occurs. For more information, see What you need to know about policy errors.

Variables	Where	Example
`fault.name="fault_name"`	`fault_name` is the name of the fault, as listed in the Runtime errors table above. The fault name is the last part of the fault code.	`fault.name Matches "TokenExpired"`
`JWT.failed`	All JWT policies set the same variable in the case of a failure.	`JWT.failed = true`

Example error response

JWT Policy Fault Codes

For error handling, the best practice is to trap the errorcode part of the error response. Do not rely on the text in the faultstring, because it could change.

Example fault rule

    <FaultRules>
        <FaultRule name="JWT Policy Errors">
            <Step>
                <Name>JavaScript-1</Name>
                <Condition>(fault.name Matches "TokenExpired")</Condition>
            </Step>
            <Condition>JWT.failed=true</Condition>
        </FaultRule>
    </FaultRules>

Extract Variables ポリシー

Runtime errors

These errors can occur when the policy executes.

Fault code	HTTP status	Cause
`steps.extractvariables.ExecutionFailed`	500	This error occurs when: The input payload (JSON, XML) is empty. The input (JSON, XML, etc) passed to the policy is invalid or malformed.
`steps.extractvariables.ImmutableVariable`	500	A variable used in the policy is immutable. The policy was unable to set this variable.
`steps.extractvariables.InvalidJSONPath`	500	This error occurs if an invalid JSON path is used in the `JSONPath` element of the policy. For example, if a JSON payload does not have the object `Name`, but you specify `Name` as the path in the policy, then this error occurs.
`steps.extractvariables.JsonPathParsingFailure`	500	This error occurs when the policy is unable to parse a JSON path and extract data from the flow variable specified in `Source` element. Typically this happens if the flow variable specified in the `Source` element does not exist in the current flow.
`steps.extractvariables.SetVariableFailed`	500	This error occurs if the policy could not set the value to a variable. The error generally happens if you try to assign values to multiple variables whose names start with the same words in a nested dot-separated format.
`steps.extractvariables.SourceMessageNotAvailable`	500	This error occurs if the message variable specified in the `Source` element of the policy is either: Out of scope (not available in the specific flow where the policy is being executed) or Can't be resolved (is not defined)
`steps.extractvariables.UnableToCast`	500	This error occurs if the policy was unable to cast the extracted value to a variable. Typically this happens if you attempt to set the value of one data type to a variable of another data type.

Deployment errors

These errors can occur when you deploy a proxy containing this policy.

Error name	Cause	Fix
`NothingToExtract`	If the policy does not have any of the elements `URIPath`, `QueryParam`, `Header`, `FormParam`, `XMLPayload`, or `JSONPayload`, the deployment of the API Proxy fails, because there's nothing to extract.
`NONEmptyPrefixMappedToEmptyURI`	This error occurs if the policy has a prefix defined in the `Namespace` element under the `XMLPayload` element, but no URI is defined.
`DuplicatePrefix`	This error occurs if the policy has the same prefix defined more than once in the `Namespace` element under the `XMLPayload` element.
`NoXPathsToEvaluate`	If the policy does not have the `XPath` element within the `XMLPayload` element, then the deployment of the API proxy fails with this error. If you want to extract variables from an XML Payload, then an `XPath` child element must be specified.
`EmptyXPathExpression`	If the policy has an empty `XPath` expression within the `XMLPayload` element, then the deployment of the API proxy fails.
`NoJSONPathsToEvaluate`	If the policy does not have the `JSONPath` element within the `JSONPayload` element, then the deployment of the API proxy fails with this error.
`EmptyJSONPathExpression`	If the policy has an empty `XPath` expression within the `XMLPayload` element, then the deployment of the API proxy fails.
`MissingName`	If the policy does not have the `name` attribute in any of the policy elements like `QueryParam`, `Header`, `FormParam` or `Variable`, where it is required, then the deployment of the API proxy fails.
`PatternWithoutVariable`	If the policy does not have a variable specified within the `Pattern` element, then the deployment of the API proxy fails. The `Pattern` element requires the name of the variable in which extracted data will be stored.
`CannotBeConvertedToNodeset`	If the policy has an `XPath` expression where the `Variable` type is defined as nodeset, but the expression cannot be converted to nodeset, then the deployment of the API proxy fails.
`JSONPathCompilationFailed`	The policy could not compile a specified JSON Path.
`InstantiationFailed`	The policy could not be instantiated.
`XPathCompilationFailed`	If the prefix or the value used in the `XPath` element is not part of any of the declared namespaces in the policy, then the deployment of the API proxy fails.
`InvalidPattern`	If the `Pattern` element definition is invalid in any of the elements like `URIPath`, `QueryParam`, `Header`, `FormParam`, `XMLPayload` or `JSONPayload` within the policy, then the deployment of the API proxy fails. The `Pattern` element is considered invalid if it doesn't include a variable. For more information about pattern matching, see About matching and variable creation.

Fault variables

These variables are set when this policy triggers an error at runtime. For more information, see What you need to know about policy errors.

Variables	Where	Example
`fault.name="fault_name"`	`fault_name` is the name of the fault, as listed in the Runtime errors table above. The fault name is the last part of the fault code.	`fault.name = "SourceMessageNotAvailable"`
`extractvariables.policy_name.failed`	`policy_name` is the user-specified name of the policy that threw the fault.	`extractvariables.EV-ParseJsonResponse.failed = true`

Example error response

Note: For error handling, the best practice is to trap the errorcode part of the error response. Do not rely on the text in the faultstring, because it could change.

{
   "fault":{
      "detail":{
         "errorcode":"steps.extractvariables.SourceMessageNotAvailable"
      },
      "faultstring":"request message is not available for ExtractVariable: EV-ParseJsonResponse"
   }
}

Example fault rule

<FaultRule name="Extract Variable Faults">
    <Step>
        <Name>AM-CustomErrorMessage</Name>
        <Condition>(fault.name = "SourceMessageNotAvailable") </Condition>
    </Step>
    <Condition>(extractvariables.EM-ParseJsonResponse.failed = true) </Condition>
</FaultRule>

Generate JWS ポリシー

ランタイムエラー

このエラーは、ポリシーの実行時に発生することがあります。

障害コード	HTTP ステータス	発生条件
`steps.jws.GenerationFailed`	401	ポリシーで JWS を生成できない場合。
`steps.jws.InsufficientKeyLength`	401	HS256 アルゴリズム用の鍵が 32 バイト未満の場合。
`steps.jws.InvalidClaim`	401	クレームが欠落しているか、一致していない場合。または、ヘッダーが欠落しているか、一致していない場合。
`steps.jws.InvalidCurve`	401	鍵で指定された曲線が、楕円曲線アルゴリズムでは無効な場合。
`steps.jws.InvalidJsonFormat`	401	無効な JSON が JWS ヘッダーで検出された場合。
`steps.jws.InvalidPayload`	401	JWS ペイロードが無効な場合。
`steps.jws.InvalidSignature`	401	`<DetachedContent>` が省略され、JWS に分離済みのコンテンツペイロードがある場合。
`steps.jws.KeyIdMissing`	401	Verify ポリシーが JWKS を公開鍵のソースとして使用するが、署名付き JWS にはヘッダーに `kid` プロパティが含まれてない場合。
`steps.jws.KeyParsingFailed`	401	指定された鍵情報で公開鍵を解析できない場合。
`steps.jws.MissingPayload`	401	JWS ペイロードが欠落している場合。
`steps.jws.NoAlgorithmFoundInHeader`	401	JWS がアルゴリズムヘッダーを省略すると発生します。
`steps.jws.SigningFailed`	401	GenerateJWS では、HS384 または HS512 アルゴリズムの最小サイズ未満の鍵の場合。
`steps.jws.UnknownException`	401	不明な例外が発生した場合。
`steps.jws.WrongKeyType`	401	鍵のタイプが正しくない場合。たとえば、楕円曲線アルゴリズムで RSA 鍵を指定した場合や、RSA アルゴリズムで曲線鍵を指定した場合など。

デプロイエラー

以下のエラーは、このポリシーを含むプロキシをデプロイするときに発生することがあります。

エラー名エラーが発生する条件

InvalidAlgorithm 有効な値は、RS256、RS384、RS512、PS256、PS384、PS512、ES256、ES384、ES512、HS256、HS384、HS512 のみです。

エラー名	エラーが発生する条件
`InvalidAlgorithm`	有効な値は、RS256、RS384、RS512、PS256、PS384、PS512、ES256、ES384、ES512、HS256、HS384、HS512 のみです。
`EmptyElementForKeyConfiguration` `FailedToResolveVariable` `InvalidConfigurationForActionAndAlgorithmFamily` `InvalidConfigurationForVerify` `InvalidEmptyElement` `InvalidFamiliesForAlgorithm` `InvalidKeyConfiguration` `InvalidNameForAdditionalClaim` `InvalidNameForAdditionalHeader` `InvalidPublicKeyId` `InvalidPublicKeyValue` `InvalidSecretInConfig` `InvalidTypeForAdditionalClaim` `InvalidTypeForAdditionalHeader` `InvalidValueForElement` `InvalidValueOfArrayAttribute` `InvalidVariableNameForSecret` `MissingConfigurationElement` `MissingElementForKeyConfiguration` `MissingNameForAdditionalClaim` `MissingNameForAdditionalHeader`	その他の発生の可能性があるデプロイエラー。

EmptyElementForKeyConfiguration

FailedToResolveVariable

InvalidConfigurationForActionAndAlgorithmFamily

InvalidConfigurationForVerify

InvalidEmptyElement

InvalidFamiliesForAlgorithm

InvalidKeyConfiguration

InvalidNameForAdditionalClaim

InvalidNameForAdditionalHeader

InvalidPublicKeyId

InvalidPublicKeyValue

InvalidSecretInConfig

InvalidTypeForAdditionalClaim

InvalidTypeForAdditionalHeader

InvalidValueForElement

InvalidValueOfArrayAttribute

InvalidVariableNameForSecret

MissingConfigurationElement

MissingElementForKeyConfiguration

MissingNameForAdditionalClaim

MissingNameForAdditionalHeader

その他の発生の可能性があるデプロイエラー。

障害変数

ランタイムエラーが発生すると、次の変数が設定されます。詳細については、ポリシーエラーについて知っておくべきことをご覧ください。

変数	説明	例
`fault.name="fault_name"`	`fault_name` は、上記のランタイムエラーの表に記載されている障害の名前です。障害名は、障害コードの最後の部分です。	`fault.name Matches "TokenExpired"`
`JWS.failed`	障害の場合は、すべての JWS ポリシーで同じ変数が設定されます。	`jws.JWS-Policy.failed = true`

エラーレスポンスの例

障害ルールの例

<FaultRules>
    <FaultRule name="JWS Policy Errors">
        <Step>
            <Name>JavaScript-1</Name>
            <Condition>(fault.name Matches "TokenExpired")</Condition>
        </Step>
        <Condition>JWS.failed=true</Condition>
    </FaultRule>
</FaultRules>

Generate JWT ポリシー

ランタイムエラー

このエラーは、ポリシーの実行時に発生することがあります。

障害コード	HTTP ステータス	発生条件
`steps.jwt.AlgorithmInTokenNotPresentInConfiguration`	401	検証ポリシーに複数のアルゴリズムがある場合。
`steps.jwt.AlgorithmMismatch`	401	Generate ポリシーで指定されたアルゴリズムが、Verify ポリシーで想定されているアルゴリズムと一致しない場合。指定されたアルゴリズムが一致している必要があります。
`steps.jwt.FailedToDecode`	401	ポリシーで JWT をデコードできなかった場合。JWT が破損している可能性があります。
`steps.jwt.GenerationFailed`	401	ポリシーで JWT を生成できなかった場合。
`steps.jwt.InsufficientKeyLength`	401	HS256 アルゴリズムで鍵が 32 バイト未満の場合、HS386 アルゴリズムで鍵が 48 バイト未満の場合、HS512 アルゴリズムで鍵が 64 バイト未満の場合。
`steps.jwt.InvalidClaim`	401	クレームが欠落しているか、一致していない場合。または、ヘッダーが欠落しているか、一致していない場合。
`steps.jwt.InvalidCurve`	401	鍵で指定された曲線が、楕円曲線アルゴリズムでは無効な場合。
`steps.jwt.InvalidJsonFormat`	401	ヘッダーまたはペイロードで無効な JSON が検出された場合。
`steps.jwt.InvalidToken`	401	JWT 署名の検証で不合格だった場合。
`steps.jwt.JwtAudienceMismatch`	401	トークンの検証でオーディエンスクレームが不合格だった場合。
`steps.jwt.JwtIssuerMismatch`	401	トークンの検証で発行元クレームが不合格だった場合。
`steps.jwt.JwtSubjectMismatch`	401	トークンの検証でサブジェクトクレームが不合格だった場合。
`steps.jwt.KeyIdMissing`	401	Verify ポリシーが公開鍵のソースとして JWKS を使用しているが、署名付き JWT のヘッダーに `kid` プロパティが含まれてない場合。
`steps.jwt.KeyParsingFailed`	401	指定された鍵情報で公開鍵を解析できない場合。
`steps.jwt.NoAlgorithmFoundInHeader`	401	JWT にアルゴリズムヘッダーが含まれていない場合。
`steps.jwt.NoMatchingPublicKey`	401	Verify ポリシーが JWKS を公開鍵のソースとして使用するが、署名付き JWT の `kid` が JWKS にリストされていない場合。
`steps.jwt.SigningFailed`	401	GenerateJWT で、HS384 または HS512 アルゴリズムの鍵が最小サイズより小さい場合。
`steps.jwt.TokenExpired`	401	ポリシーが期限切れのトークンを検証しようとしている場合。
`steps.jwt.TokenNotYetValid`	401	トークンがまだ有効になっていない場合。
`steps.jwt.UnhandledCriticalHeader`	401	`crit` ヘッダーの Verify JWT ポリシーで見つかったヘッダーが `KnownHeaders` にリストされていない場合。
`steps.jwt.UnknownException`	401	不明な例外が発生した場合。
`steps.jwt.WrongKeyType`	401	鍵のタイプが正しくない場合。たとえば、楕円曲線アルゴリズムで RSA 鍵を指定した場合や、RSA アルゴリズムで曲線鍵を指定した場合など。

デプロイエラー

以下のエラーは、このポリシーを含むプロキシをデプロイするときに発生することがあります。

エラー名	原因	修正
`InvalidNameForAdditionalClaim`	`<AdditionalClaims>` 要素の子要素 `<Claim>` で使用されているクレームの型が登録済みの名前（`kid`、`iss`、`sub`、`aud`、`iat`、`exp`、`nbf`、`jti`）のいずれかである場合、デプロイが失敗します。
`InvalidTypeForAdditionalClaim`	`<AdditionalClaims>` 要素の子要素 `<Claim>` で使用されているクレームが `string`、`number`、`boolean`、`map` 型でない場合、デプロイが失敗します。
`MissingNameForAdditionalClaim`	`<AdditionalClaims>` 要素の子要素 `<Claim>` でクレームの名前が指定されていない場合、デプロイが失敗します。
`InvalidNameForAdditionalHeader`	このエラーは、`<AdditionalClaims>` 要素の子要素 `<Claim>` で使用されているクレームの名前が `alg` または `typ` の場合に発生します。
`InvalidTypeForAdditionalHeader`	`<AdditionalClaims>` 要素の子要素 `<Claim>` で使用されているクレームの型が `string`、`number`、`boolean`、`map` 型でない場合、デプロイが失敗します。
`InvalidValueOfArrayAttribute`	このエラーは、`<AdditionalClaims>` 要素の子要素 `<Claim>` 内の配列属性の値が `true` または `false` に設定されていない場合に発生します。
`InvalidConfigurationForActionAndAlgorithm`	`<PrivateKey>` 要素が HS ファミリーアルゴリズムで使用されている場合、または `<SecretKey>` 要素が RSA ファミリーアルゴリズムで使用されている場合、デプロイが失敗します。
`InvalidValueForElement`	`<Algorithm>` 要素に指定された値がサポートされていない場合、デプロイが失敗します。
`MissingConfigurationElement`	このエラーは、`<PrivateKey>` 要素が RSA ファミリーアルゴリズムで使用されていない場合や、`<SecretKey>` 要素が HS ファミリーアルゴリズムで使用されていない場合に発生します。
`InvalidKeyConfiguration`	子要素 `<Value>` が `<PrivateKey>` 要素または `<SecretKey>` 要素で定義されていない場合、デプロイが失敗します。
`EmptyElementForKeyConfiguration`	`<PrivateKey>` 要素または `<SecretKey>` 要素の子要素 `<Value>` の ref 属性が空か、指定されていない場合、デプロイが失敗します。
`InvalidVariableNameForSecret`	このエラーは、`<PrivateKey>` 要素や `<SecretKey>` 要素の子要素 `<Value>` の ref 属性で指定されたフロー変数名に、非公開の接頭辞 `(private.)` が含まれていない場合に発生します。
`InvalidSecretInConfig`	このエラーは、`<PrivateKey>` 要素または `<SecretKey>` 要素の子要素 `<Value>` に非公開の接頭辞 `(private.)` が含まれていない場合に発生します。
`InvalidTimeFormat`	`<NotBefore>` 要素に指定された値がサポートされている形式でない場合、デプロイは失敗します。

Fault variables

These variables are set when a runtime error occurs. For more information, see What you need to know about policy errors.

Variables	Where	Example
`fault.name="fault_name"`	`fault_name` is the name of the fault, as listed in the Runtime errors table above. The fault name is the last part of the fault code.	`fault.name Matches "TokenExpired"`
`JWT.failed`	All JWT policies set the same variable in the case of a failure.	`JWT.failed = true`

Example error response

JWT Policy Fault Codes

For error handling, the best practice is to trap the errorcode part of the error response. Do not rely on the text in the faultstring, because it could change.

Example fault rule

    <FaultRules>
        <FaultRule name="JWT Policy Errors">
            <Step>
                <Name>JavaScript-1</Name>
                <Condition>(fault.name Matches "TokenExpired")</Condition>
            </Step>
            <Condition>JWT.failed=true</Condition>
        </FaultRule>
    </FaultRules>

Java Callout ポリシー

ランタイムエラー

このエラーは、ポリシーの実行時に発生することがあります。

障害コード	HTTP ステータス	原因	修正
`steps.javacallout.ExecutionError`	500	JavaCallout ポリシーの実行中に Java コードが例外を出力する、または null を返す場合に発生します。

デプロイエラー

これらのエラーは、ポリシーを含むプロキシがデプロイされているときに発生することがあります。

エラー名	障害文字列	HTTP ステータス	発生条件
`ResourceDoesNotExist`	`Resource with name [name] and type [type] does not exist`	なし	`<ResourceURL>` 要素で指定されたファイルが存在しません。
`JavaCalloutInstantiationFailed`	`Failed to instantiate the JavaCallout Class [classname]`	なし	`<ClassName>` 要素で指定されたクラスファイルが jar 内にありません。
`IncompatibleJavaVersion`	`Failed to load java class [classname] definition due to - [reason]`	該当なし	障害文字列をご覧ください。サポートされているソフトウェアとサポート対象バージョン。
`JavaClassNotFoundInJavaResource`	`Failed to find the ClassName in java resource [jar_name] - [class_name]`	なし	障害文字列をご覧ください。
`JavaClassDefinitionNotFound`	`Failed to load java class [class_name] definition due to - [reason]`	なし	障害文字列をご覧ください。
`NoAppropriateConstructor`	`No appropriate constructor found in JavaCallout class [class_name]`	なし	障害文字列をご覧ください。
`NoResourceForURL`	`Could not locate a resource with URL [string]`	なし	障害文字列をご覧ください。

障害変数

変数	説明	例
`fault.name="fault_name"`	`fault_name` は、上記のランタイムエラーの表に記載されている障害の名前です。障害名は、障害コードの最後の部分です。	`fault.name Matches "ExecutionError"`
`javacallout.policy_name.failed`	`policy_name` は、障害が発生したポリシーのユーザー指定の名前です。	`javacallout.JC-GetUserData.failed = true`

エラーレスポンスの例

{  
   "fault":{  
      "faultstring":"Failed to execute JavaCallout. [policy_name]",
      "detail":{  
         "errorcode":"javacallout.ExecutionError"
      }
   }
}

障害ルールの例

<FaultRule name="JavaCalloutFailed">
    <Step>
        <Name>AM-JavaCalloutError</Name>
    </Step>
    <Condition>(fault.name Matches "ExecutionError") </Condition>
</FaultRule>

JavaScript ポリシー

Runtime errors

These errors can occur when the policy executes.

Fault code	HTTP status	Cause	Fix
`steps.javascript.ScriptExecutionFailed`	500	The JavaScript policy can throw many different types of ScriptExecutionFailed errors. Commonly seen types of errors include RangeError, ReferenceError, SyntaxError, TypeError, and URIError.
`steps.javascript.ScriptExecutionFailedLineNumber`	500	An error occurred in the JavaScript code. See the fault string for details.	N/A
`steps.javascript.ScriptSecurityError`	500	A security error occurred when the JavaScript executed. See the fault string for details.	N/A

Deployment errors

These errors can occur when you deploy a proxy containing this policy.

Error name	Cause	Fix
`InvalidResourceUrlFormat`	If the format of the resource URL specified within the `<ResourceURL>` or the `<IncludeURL>` element of the JavaScript policy is invalid, then the deployment of the API proxy fails.
`InvalidResourceUrlReference`	If the `<ResourceURL>` or the `<IncludeURL>` elements refer to a JavaScript file that does not exist, then the deployment of the API proxy fails. The referenced source file must exist either the API proxy, environment, or organization level.
`WrongResourceType`	This error occurs during deployment if the `<ResourceURL>` or the `<IncludeURL>` elements of the JavaScript policy refer to any resource type other than jsc (JavaScript file).
`NoResourceURLOrSource`	The deployment of the JavaScript policy can fail with this error if the `<ResourceURL>` element is not declared or if the resource URL is not defined within this element. `<ResourceURL>` element is a mandatory element. Or, The `<IncludeURL>` element is declared but the resource URL is not defined within this element. The `<IncludeURL>` element is optional but if declared, the resource URL must be specified within the `<IncludeURL>` element.

Fault variables

These variables are set when this policy triggers an error at runtime. For more information, see What you need to know about policy errors.

Variables	Where	Example
`fault.name="fault_name"`	`fault_name` is the name of the fault, as listed in the Runtime errors table above. The fault name is the last part of the fault code.	`fault.name Matches "ScriptExecutionFailed"`
`javascript.policy_name.failed`	`policy_name` is the user-specified name of the policy that threw the fault.	`javascript.JavaScript-1.failed = true`

Example error response

Note: For error handling, the best practice is to trap the errorcode part of the error response. Do not rely on the text in the faultstring, because it could change.

{
  "fault": {
    "faultstring": "Execution of SetResponse failed with error: Javascript runtime error: "ReferenceError: "status" is not defined. (setresponse.js:6)\"",
    "detail": {
      "errorcode": "steps.javascript.ScriptExecutionFailed"
    }
  }
}

Example fault rule

<FaultRule name="JavaScript Policy Faults">
    <Step>
        <Name>AM-CustomErrorResponse</Name>
        <Condition>(fault.name Matches "ScriptExecutionFailed") </Condition>
    </Step>
    <Condition>(javascript.JavaScript-1.failed = true) </Condition>
</FaultRule>

JSON Threat Protection ポリシー

ランタイムエラー

このエラーは、ポリシーの実行時に発生することがあります。

障害コード	HTTP ステータス	原因
`steps.jsonthreatprotection.ExecutionFailed`	500	JSONThreatProtection ポリシーでは、さまざまな種類の ExecutionFailed エラーをスローできます。エラーのほとんどは、ポリシーで設定された特定のしきい値を超えた場合に発生します。これらのタイプのエラーには、オブジェクトエントリ名の長さ、オブジェクトエントリ数、配列要素数、コンテナの深さ、文字列値の長さなどがあります。このエラーは、ペイロードに無効な JSON オブジェクトが含まれている場合にも発生します。
`steps.jsonthreatprotection.SourceUnavailable`	500	このエラーは、`<Source>` 要素で指定されたメッセージ変数が次のいずれかである場合に発生します。範囲外（ポリシーが実行されている特定のフローで使用できない）有効な値 `request`、`response`、`message` のいずれでもない
`steps.jsonthreatprotection.NonMessageVariable`	500	このエラーは、`<Source>` 要素がメッセージ型以外の変数に設定されている場合に発生します。

デプロイエラー

なし。

障害変数

変数	説明	例
`fault.name="fault_name"`	`fault_name` は、上記のランタイムエラーの表に記載されている障害の名前です。障害名は、障害コードの最後の部分です。	`fault.name Matches "SourceUnavailable"`
`jsonattack.policy_name.failed`	`policy_name` は、障害が発生したポリシーのユーザー指定の名前です。	`jsonattack.JTP-SecureRequest.failed = true`

エラーレスポンスの例

{
  "fault": {
    "faultstring": "JSONThreatProtection[JPT-SecureRequest]: Execution failed. reason: JSONThreatProtection[JTP-SecureRequest]: Exceeded object entry name length at line 2",
    "detail": {
      "errorcode": "steps.jsonthreatprotection.ExecutionFailed"
    }
  }
}

障害ルールの例

<FaultRule name="JSONThreatProtection Policy Faults">
    <Step>
        <Name>AM-CustomErrorResponse</Name>
        <Condition>(fault.name Matches "ExecutionFailed") </Condition>
    </Step>
    <Condition>(jsonattack.JPT-SecureRequest.failed = true) </Condition>
</FaultRule>

JSONThreatProtection ポリシータイプでは、次のエラーコードを定義します。

JSON to XML ポリシー

ランタイムエラー

このエラーは、ポリシーの実行時に発生することがあります。

障害コード	HTTP ステータス	原因
`steps.jsontoxml.ExecutionFailed`	500	入力ペイロード（JSON）が空か、JSON to XML ポリシーに渡された入力（JSON）が無効または不正です。
`steps.jsontoxml.InCompatibleTypes`	500	このエラーは、`<Source>` 要素で定義された変数の型と、`<OutputVariable>` 要素で定義された変数の型が異なる場合に発生します。`<Source>` 要素に含まれる変数の型と `<OutputVariable>` 要素に含まれる変数の型は一致している必要があります。有効な型は `message` と `string` です。
`steps.jsontoxml.InvalidSourceType`	500	このエラーは、`<Source>` 要素の定義に使用される変数の型が無効な場合に発生します。有効な変数の型は `message` と `string` です。
`steps.jsontoxml.OutputVariableIsNotAvailable`	500	このエラーは、JSON to XML ポリシーの `<Source>` 要素で指定された変数が String 型であり、`<OutputVariable>` 要素が定義されていない場合に発生します。`<Source>` 要素で定義された変数が String 型の場合、`<OutputVariable>` 要素は必須です。
`steps.jsontoxml.SourceUnavailable`	500	このエラーは、JSON to XML ポリシーの `<Source>` 要素で指定された message 変数が、次のいずれかである場合に発生します。範囲外（ポリシーが実行されている特定のフローで使用できない）または解決できない（定義されていない）

デプロイエラー

なし。

障害変数

ランタイムエラーが発生すると、次の変数が設定されます。詳細については、ポリシーエラーについて知っておくべきことをご覧ください。

変数	説明	例
`fault.name="fault_name"`	`fault_name` は、上記のランタイムエラーの表に記載されている障害の名前です。障害名は、障害コードの最後の部分です。	`fault.name Matches "SourceUnavailable"`
`jsontoxml.policy_name.failed`	`policy_name` は、障害が発生したポリシーのユーザー指定の名前です。	`jsontoxml.JSON-to-XML-1.failed = true`

エラーレスポンスの例

注: ベストプラクティスとして、エラー処理でエラーレスポンスの errorcode の部分をトラップすることをおすすめします。faultstring のテキストは変更される可能性があるため、依存しないでください。

{
  "fault": {
    "faultstring": "JSONToXML[JSON-to-XML-1]: Source xyz is not available",
    "detail": {
      "errorcode": "steps.json2xml.SourceUnavailable"
    }
  }
}

障害ルールの例

<FaultRule name="JSON To XML Faults">
    <Step>
        <Name>AM-SourceUnavailableMessage</Name>
        <Condition>(fault.name Matches "SourceUnavailable") </Condition>
    </Step>
    <Step>
        <Name>AM-BadJSON</Name>
        <Condition>(fault.name = "ExecutionFailed")</Condition>
    </Step>
    <Condition>(jsontoxml.JSON-to-XML-1.failed = true) </Condition>
</FaultRule>

Key Value Map Operations ポリシー

ランタイムエラー

このエラーは、ポリシーの実行時に発生することがあります。

障害コード	HTTP ステータス	原因	解決方法
`steps.keyvaluemapoperations.SetVariableFailed`	500	このエラーは、暗号化された Key-Value マップから値を取得し、名前に接頭辞 `private` がない変数に値を設定しようとすると発生します。デバッグ時の基本的なセキュリティのために必須なこの接頭辞により、API プロキシ Trace およびデバッグセッションで、暗号化された値は表示されません。
`steps.keyvaluemapoperations.UnsupportedOperationException`	500	このエラーは、`mapIdentifier` 属性が Key Value Map Operations ポリシーで空の文字列に設定されている場合に発生します。

デプロイエラー

以下のエラーは、このポリシーを含むプロキシをデプロイするときに発生することがあります。

エラー名	原因	解決方法
`InvalidIndex`	Key Value Map Operations ポリシーの `<Get>` 要素に指定された `index` 属性がゼロまたは負の数である場合、API プロキシのデプロイは失敗します。インデックスは `1` から始まるため、ゼロまたは負の整数のインデックスは無効と見なされます。
`KeyIsMissing`	このエラーは、`<Key>` 要素が完全に欠落しているか、Key Value Map Operations ポリシーの `<InitialEntries>` 要素の `<Entry>` の下の `<Key>` 要素に `<Parameter>` 要素がない場合に発生します。
`ValueIsMissing`	このエラーは、Key Value Map Operations ポリシーの `<InitialEntries>` 要素の `<Entry>` 要素の下に `<Value>` 要素がない場合に発生します。

LDAP ポリシー

このポリシーでは、次のエラーコードを使用します。

エラーコード	メッセージ
`InvalidAttributeName`	`Invalid attribute name {0}.`
`InvalidSearchBase`	`Search base can not be empty.`
`InvalidValueForPassword`	`Invalid value for password field. It can not be empty.`
`InvalidSearchScope`	`Invalid scope {0}. Allowed scopes are {1}.`
`InvalidUserCredentials`	`Invalid user credentials.`
`InvalidExternalLdapReference`	`Invalid external ldap reference {0}.`
`LdapResourceNotFound`	`Ldap resource {0} not found.`
`BaseDNRequired`	`Base DN required.`
`OnlyReferenceOrValueIsAllowed`	`Only value or reference is allowed for {0}.`
`AttributesRequired`	`At least one attribute required for search action.`
`UserNameIsNull`	`User name is null.`
`SearchQueryAndUserNameCannotBePresent`	`Both search query and username can not be present in the authentication action. Please specify either one of them.`

Message Logging ポリシー

Runtime errors

These errors can occur when the policy executes.

Fault code	HTTP status	Cause
`steps.messagelogging.StepDefinitionExecutionFailed`	500	See fault string.

Deployment errors

These errors can occur when you deploy a proxy containing this policy.

Error name	Cause	Fix
`InvalidProtocol`	The deployment of the MessageLogging policy can fail with this error if the protocol specified within the `<Protocol>` element is not valid. The valid protocols are TCP and UDP. For sending syslog messages over TLS/SSL, only TCP is supported.
`InvalidPort`	The deployment of the MessageLogging policy can fail with this error if the port number is not specified within the `<Port>` element or if it is not valid. The port number must be an integer greater than zero.

Fault variables

These variables are set when a runtime error occurs. For more information, see What you need to know about policy errors.

Variables	Where	Example
`fault.name="fault_name"`	`fault_name` is the name of the fault, as listed in the Runtime errors table above. The fault name is the last part of the fault code.	`fault.name Matches "StepDefinitionExecutionFailed"`
`messagelogging.policy_name.failed`	`policy_name` is the user-specified name of the policy that threw the fault.	`messagelogging.ML-LogMessages.failed = true`

Example error response

Note: For error handling, the best practice is to trap the errorcode part of the error response. Do not rely on the text in the faultstring, because it could change.

{  
   "fault":{  
      "detail":{  
         "errorcode":"steps.messagelogging.StepDefinitionExecutionFailed"
      },
      "faultstring":"Execution failed"
   }
}

Example fault rule

<FaultRule name="MessageLogging">
    <Step>
        <Name>ML-LogMessages</Name>
        <Condition>(fault.name Matches "StepDefinitionExecutionFailed") </Condition>
    </Step>
    <Condition>(messagelogging.ML-LogMessages.failed = true) </Condition>
</FaultRule>

OASValidation ポリシー

ランタイムエラー

このエラーは、ポリシーの実行時に発生することがあります。

障害コード	HTTP ステータス	原因
`steps.oasvalidation.Failed`	500	リクエストメッセージの本文が、指定された OpenAPI 仕様に対して検証できない。
`steps.oasvalidation.SourceMessageNotAvailable`	500	ポリシーの `<Source>` 要素で指定された変数が範囲外であるか、解決できない。
`steps.oasvalidation.NotMessageVariable`	500	`<Source>` 要素が、message 型以外の変数に設定されています。

デプロイエラー

以下のエラーは、このポリシーを含むプロキシをデプロイするときに発生することがあります。

エラー名	原因
`ResourceDoesNotExist`	`<OASResource>` 要素で参照されている OpenAPI 仕様が存在しません。
`ResourceCompileFailed`	デプロイに含まれている OpenAPI 仕様に、コンパイルを妨げるエラーが存在します。これは通常、仕様が正しい形式の OpenAPI 仕様 3.0 ではないことを示しています。
`BadResourceURL`	`<OASResource>` 要素で参照されている OpenAPI 仕様が処理できません。これは、ファイルが JSON または YAML ファイルでない場合、またはファイルの URL が正しく指定されていない場合に発生することがあります。

障害変数

次の変数は、このポリシーでランタイムエラーが発生したときに設定されます。詳細については、ポリシーエラーについて知っておくべきことをご覧ください。

変数	説明	例
`fault.name="fault_name"`	`fault_name` は、上記のランタイムエラーの表に記載されている障害の名前です。障害名は、障害コードの最後の部分です。	`fault.name Matches "ResourceDoesNotExist"`
`oasvalidation.policy_name.failed`	`policy_name` は、障害をスローしたポリシーのユーザー指定の名前です。	`oasvalidation.myoaspolicy.failed = true`

Populate Cache ポリシー

Runtime errors

These errors can occur when the policy executes.

Fault code	HTTP Status	Occurs when
`policies.populatecache.EntryCannotBeCached`	500	An entry cannot be cached. The message object being cached is not an instance of a class that is Serializable.

Deployment errors

These errors can occur when you deploy a proxy containing this policy.

Error name	Cause	Fix
`InvalidCacheResourceReference`	This error occurs if the `<CacheResource>` element in the PopulateCache policy is set to a name that does not exist in the environment where the API proxy is being deployed.
`CacheNotFound`	The cache specified in the `<CacheResource>` element does not exist.

Fault variables

These variables are set when this policy triggers an error. For more information, see What you need to know about policy errors.

Variables	Where	Example
`fault.name="fault_name"`	`fault_name` is the name of the fault, as listed in the Runtime errors table above. The fault name is the last part of the fault code.	`fault.name = "EntryCannotBeCached"`
`populatecache.policy_name.failed`	`policy_name` is the user-specified name of the policy that threw the fault.	`populatecache.POP-CACHE-1.failed = true`

Example error response

{
  "fault": {
    "faultstring": "[entry] can not be cached. Only serializable entries are cached.",
    "detail": {
      "errorcode": "steps.populatecache.EntryCannotBeCached"
    }
  }
}

Example fault rule

<FaultRule name="Populate Cache Fault">
    <Step>
        <Name>AM-EntryCannotBeCached</Name>
        <Condition>(fault.name Matches "EntryCannotBeCached") </Condition>
    </Step>
    <Condition>(populatecache.POP-CACHE-1.failed = true) </Condition>
</FaultRule>

Lookup Cache ポリシー

このセクションでは、このポリシーがエラーをトリガーしたときに設定されるエラーメッセージとフロー変数について説明します。これは、プロキシの障害ルールを作成するうえで重要な情報です。詳細については、ポリシーエラーについて知っておくべきことと障害の処理をご覧ください。

エラーコードの接頭辞

なし

ランタイムエラー

このポリシーはランタイムエラーをスローしません。

デプロイエラー

以下のエラーは、このポリシーを含むプロキシをデプロイするときに発生することがあります。

エラー名	原因	解決方法
`InvalidCacheResourceReference`	このエラーは、API プロキシがデプロイされている環境に存在しない名前が `<CacheResource>` 要素に設定されている場合に発生します。
`InvalidTimeout`	`<CacheLookupTimeoutInSeconds>` 要素が負の数に設定されている場合、API プロキシのデプロイは失敗します。
`CacheNotFound`	このエラーは、エラーメッセージに記述されているキャッシュが、特定の Message Processor コンポーネント上に作成されていない場合に発生します。

障害変数

なし

エラーレスポンスの例

なし

Invalidate Cache ポリシー

エラーコードの接頭辞

なし

ランタイムエラー

このポリシーはランタイムエラーをスローしません。

デプロイエラー

以下のエラーは、このポリシーを含むプロキシをデプロイするときに発生することがあります。

エラー名	原因	修正
`InvalidCacheResourceReference`	このエラーは、API プロキシがデプロイされている環境に存在しない名前が InvalidateCache ポリシーの `<CacheResource>` 要素に設定されている場合に発生します。
`CacheNotFound`	このエラーは、エラーメッセージに記述されているキャッシュが、特定の Message Processor コンポーネント上に作成されていない場合に発生します。

障害変数

なし

エラーレスポンスの例

なし

Response Cache ポリシー

エラーコードの接頭辞

なし

ランタイムエラー

このポリシーはランタイムエラーをスローしません。

デプロイエラー

以下のエラーは、このポリシーを含むプロキシをデプロイするときに発生することがあります。

エラー名	原因	解決方法
`InvalidTimeout`	ResponseCache ポリシーの `<CacheLookupTimeoutInSeconds>` 要素が負の数に設定されている場合、API プロキシのデプロイは失敗します。
`InvalidCacheResourceReference`	このエラーは、ResponseCache ポリシーの `<CacheResource>` 要素が、API プロキシのデプロイ先の環境には存在しない名前に設定される場合に発生します。
`ResponseCacheStepAttachmentNotAllowedReq`	このエラーは、同じ ResponseCache ポリシーが API プロキシの任意のフロー内の複数のリクエストパスに接続されている場合に発生します。
`ResponseCacheStepAttachmentNotAllowedResp`	このエラーは、同じ ResponseCache ポリシーが API プロキシの任意のフロー内の複数のレスポンスパスに接続されている場合に発生します。
`InvalidMessagePatternForErrorCode`	このエラーは、ResponseCache ポリシーの `<SkipCacheLookup>` 要素または `<SkipCachePopulation>` 要素に無効な条件が含まれている場合に発生します。
`CacheNotFound`	このエラーは、エラーメッセージに記述されているキャッシュが、特定の Message Processor コンポーネント上に作成されていない場合に発生します。

障害変数

なし

エラーレスポンスの例

なし

OAuthV2 ポリシー

このセクションでは、このポリシーでエラーが発生したときに返される障害コードとエラーメッセージ、Edge によって設定される障害変数について説明します。これは、障害に対処する障害ルールを作成するうえで重要な情報です。詳細については、ポリシーエラーについて知っておくべきことと障害の処理をご覧ください。

ランタイムエラー

このエラーは、ポリシーの実行時に発生することがあります。

障害コード	HTTP ステータス	原因	オペレーションによるスロー
`steps.oauth.v2.access_token_expired`	401	アクセストークンの期限が切れています。	VerifyAccessToken InvalidateToken
`steps.oauth.v2.access_token_not_approved`	401	アクセストークンは取り消されています。	VerifyAccessToken
`steps.oauth.v2.apiresource_doesnot_exist`	401	リクエストされたリソースが、アクセストークンに関連付けられた API プロダクトに存在していません。	VerifyAccessToken
`steps.oauth.v2.FailedToResolveAccessToken`	500	ポリシーは、`<AccessToken>` 要素で指定された変数内でアクセストークンを見つけることを想定しましたが、この変数は解決できませんでした。	GenerateAccessToken
`steps.oauth.v2.FailedToResolveAuthorizationCode`	500	ポリシーは、`<Code>` 要素で指定された変数内で認証コードを見つけることを想定しましたが、この変数は解決できませんでした。	GenerateAuthorizationCode
`steps.oauth.v2.FailedToResolveClientId`	500	ポリシーは、`<ClientId>` 要素で指定された変数内でクライアント ID を見つけることを想定しましたが、この変数は解決できませんでした。	GenerateAccessToken GenerateAuthorizationCode GenerateAccessTokenImplicitGrant RefreshAccessToken
`steps.oauth.v2.FailedToResolveRefreshToken`	500	ポリシーは、`<RefreshToken>` 要素で指定された変数内で更新トークンを見つけることを想定しましたが、この変数は解決できませんでした。	RefreshAccessToken
`steps.oauth.v2.FailedToResolveToken`	500	ポリシーは、`<Tokens>` 要素で指定された変数内でトークンを見つけることを想定しましたが、この変数は解決できませんでした。	ValidateToken InvalidateToken
`steps.oauth.v2.InsufficientScope`	403	リクエストで提供されたアクセストークンのスコープが、アクセストークン検証ポリシーに指定されているスコープと一致しません。スコープの詳細については、OAuth2 スコープの操作をご覧ください。	VerifyAccessToken
`steps.oauth.v2.invalid_access_token`	401	クライアントから送信されたアクセストークンが無効です。	VerifyAccessToken
`steps.oauth.v2.invalid_client`	401	このエラー名は、ポリシーの `<GenerateResponse>` プロパティが true に設定され、リクエストで送信されたクライアント ID が無効な場合に返されます。使用しているプロキシに関連付けられたデベロッパーアプリに正しいクライアントキーとシークレットの値を使用していることを確認してください。通常、これらの値は Base64 エンコードの Basic Authorization ヘッダーとして送信されます。注: 既存の障害ルールの条件を変更し、`invalid_client` と `InvalidClientIdentifier` の両方の名前を取得することをおすすめします。詳細と例については、16.09.21 リリースノートをご覧ください。	GenerateAccessToken RefreshAccessToken
`steps.oauth.v2.InvalidRequest`	400	このエラー名は、複数の異なる種類のエラーに使用されます。通常は、リクエストで送信されたパラメータが欠落しているか、正しくない場合に使用されます。`<GenerateResponse>` が `false` に設定されている場合、後述する障害変数を使用してエラーの詳細（障害名、原因など）を取得します。	GenerateAccessToken GenerateAuthorizationCode GenerateAccessTokenImplicitGrant RefreshAccessToken
`steps.oauth.v2.InvalidAccessToken`	401	認証ヘッダーに、必須の単語「Bearer」がありません。例: `Authorization: Bearer your_access_token`	VerifyAccessToken
`steps.oauth.v2.InvalidAPICallAsNoApiProductMatchFound`	401	アクセストークンに関連付けられたプロダクトに、API プロキシがありません。ヒント: アクセストークンに関連付けられたプロダクトが適切に構成されていることを確認してください。たとえば、リソースパスでワイルドカードを使用する場合は、ワイルドカードが正確に使用されていることを確認します。詳細については、API プロダクトを作成するをご覧ください。このエラーの原因について詳しくは、こちらの Apigee コミュニティの投稿をご覧ください。	VerifyAccessToken
`steps.oauth.v2.InvalidClientIdentifier`	500	このエラー名は、ポリシーの `<GenerateResponse>` プロパティが false に設定され、リクエストで送信されたクライアント ID が無効な場合に返されます。使用しているプロキシに関連付けられたデベロッパーアプリに正しいクライアントキーとシークレットの値を使用していることを確認してください。通常、これらの値は Base64 エンコードの Basic Authorization ヘッダーとして送信されます。注: この状況では、このエラーは以前 `invalid_client` と呼ばれていました。既存の障害ルールの条件を変更し、`invalid_client` と `InvalidClientIdentifier` の両方の名前を取得することをおすすめします。詳細と例については、16.09.21 リリースノートをご覧ください。	GenerateAccessToken RefreshAccessToken
`steps.oauth.v2.InvalidParameter`	500	ポリシーでは、アクセストークンまたは認証コードのいずれかを指定する必要がありますが、両方は指定できません。	GenerateAuthorizationCode GenerateAccessTokenImplicitGrant
`steps.oauth.v2.InvalidTokenType`	500	`<Tokens>/<Token>` 要素でトークンタイプ（たとえば `refreshtoken`）を指定する必要があります。クライアントが誤ったタイプを渡すと、このエラーがスローされます。	ValidateToken InvalidateToken
`steps.oauth.v2.MissingParameter`	500	レスポンスタイプが `token` ですが、権限付与タイプが指定されていません。	GenerateAuthorizationCode GenerateAccessTokenImplicitGrant
`steps.oauth.v2.UnSupportedGrantType`	500	クライアントで指定された権限付与タイプが、ポリシーでサポートされていません（<SupportedGrantTypes> 要素のリストにありません）。注: 現在、サポートされていない権限付与タイプのエラーが正しくスローされないバグがあります。サポートされていない権限付与タイプのエラーが発生した場合、プロキシはエラーフローを想定どおりに入力しません。	GenerateAccessToken GenerateAuthorizationCode GenerateAccessTokenImplicitGrant RefreshAccessToken

デプロイエラー

以下のエラーは、このポリシーを含むプロキシをデプロイするときに発生することがあります。

エラー名	原因
`InvalidValueForExpiresIn`	`<ExpiresIn>` 要素の場合、有効な値は正の整数と `-1` です。
`InvalidValueForRefreshTokenExpiresIn`	`<RefreshTokenExpiresIn>` 要素の場合、有効な値は正の整数と `-1` です。
`InvalidGrantType`	`<SupportedGrantTypes>` 要素に無効な権限付与タイプが指定されています。有効な付与タイプのリストについては、ポリシーリファレンスをご覧ください。
`ExpiresInNotApplicableForOperation`	<Operations> 要素に指定されたオペレーションで有効期限がサポートされていることを確認してください。たとえば、VerifyToken オペレーションではサポートされていません。
`RefreshTokenExpiresInNotApplicableForOperation`	<Operations> 要素に指定されたオペレーションで、更新トークンの有効期限がサポートされていることを確認してください。たとえば、VerifyToken オペレーションではサポートされていません。
`GrantTypesNotApplicableForOperation`	<SupportedGrantTypes> に指定された付与タイプが、指定したオペレーションでサポートされていることを確認してください。
`OperationRequired`	`<Operation>` 要素を使用して、このポリシーのオペレーションを指定する必要があります。注: `<Operation>` 要素がない場合、UI はスキーマ検証エラーをスローします。
`InvalidOperation`	`<Operation>` 要素を使用して、このポリシーで有効なオペレーションを指定する必要があります。注: `<Operation>` 要素が無効な場合、UI はスキーマ検証エラーをスローします。
`TokenValueRequired`	`<Tokens>` 要素にトークン `<Token>` 値を指定する必要があります。

障害変数

次の変数は、このポリシーでランタイムエラーが発生したときに設定されます。

注: これらの変数を使用して障害ルール条件を作成できます。これらの変数は、<GenerateResponse> が false に設定されている場合にエラーが発生すると、入力されます。<GenerateResponse> が true の場合、エラーが発生すると、ポリシーはすぐにクライアントにレスポンスを返します。エラーフローはスキップされ、これらの変数は入力されません。詳細については、ポリシーエラーについて知っておくべきことをご覧ください。

変数	説明	例
`fault.name="fault_name"`	`fault_name` は、上記のランタイムエラーの表に記載されている障害の名前です。障害名は、障害コードの最後の部分です。	`fault.name = "InvalidRequest"`
`oauthV2.policy_name.failed`	`policy_name` は、障害が発生したポリシーのユーザー指定の名前です。	`oauthV2.GenerateAccesstoken.failed = true`
`oauthV2.policy_name.fault.name`	`policy_name` は、障害をスローしたポリシーのユーザー指定の名前です。	`oauthV2.GenerateAccesstoken.fault.name = InvalidRequest` 注: VerifyAccessToken オペレーションでは、障害名に次の接尾辞が含まれます: `keymanagement.service` 例: `keymanagement.service.invalid_access_token`
`oauthV2.policy_name.fault.cause`	`policy_name` は、障害をスローしたポリシーのユーザー指定の名前です。	`oauthV2.GenerateAccesstoken.cause = Required param : grant_type`

エラーレスポンスの例

<GenerateResponse> 要素が true の場合、これらのレスポンスがクライアントに返されます。

<GenerateResponse> が true の場合、ポリシーはトークンとコードを生成するオペレーションに対して、次の形式のエラーを返します。一覧については、OAuth HTTP エラーレスポンスリファレンスをご覧ください。

{"ErrorCode" : "invalid_client", "Error" :"ClientId is Invalid"}

<GenerateResponse> が true の場合、ポリシーは検証および検証オペレーションに対して、次の形式のエラーを返します。一覧については、OAuth HTTP エラーレスポンスリファレンスをご覧ください。

{  
   {  
      "fault":{  
         "faultstring":"Invalid Access Token",
         "detail":{  
            "errorcode":"keymanagement.service.invalid_access_token"
         }
      }
   }

障害ルールの例

<FaultRule name=OAuthV2 Faults">
    <Step>
        <Name>AM-InvalidClientResponse</Name>
        <Condition>(fault.name = "invalid_client") OR (fault.name = "InvalidClientIdentifier")</Condition>
    </Step>
    <Step>
        <Name>AM-InvalidTokenResponse</Name>
        <Condition>(fault.name = "invalid_access_token")</Condition>
    </Step>
    <Condition>(oauthV2.failed = true) </Condition>
</FaultRule>

Get OAuthV2 Info ポリシー

ランタイムエラー

このエラーは、ポリシーの実行時に発生することがあります。以下のエラー名は、エラーが発生したときに fault.name 変数に割り当てられる文字列です。詳細については、以下の障害変数のセクションをご覧ください。

障害コード	HTTP ステータス	原因
`steps.oauth.v2.access_token_expired`	500	ポリシーに送信されたアクセストークンは、期限が切れています。
`steps.oauth.v2.authorization_code_expired`	500	ポリシーに送信された認証コードは、期限が切れています。
`steps.oauth.v2.invalid_access_token`	500	ポリシーに送信されたアクセストークンが無効です。
`steps.oauth.v2.invalid_client-invalid_client_id`	500	ポリシーに送信されたクライアント ID が無効です。
`steps.oauth.v2.invalid_refresh_token`	500	ポリシーに送信された更新トークンは無効です。
`steps.oauth.v2.invalid_request-authorization_code_invalid`	500	ポリシーに送信された認証コードは無効です。
`steps.oauth.v2.InvalidAPICallAsNoApiProductMatchFound`	401	このエラーのトラブルシューティングについては、こちらの Apigee コミュニティの投稿をご覧ください。
`steps.oauth.v2.refresh_token_expired`	500	ポリシーに送信されたリフレッシュトークンは、期限が切れています。

デプロイエラー

デプロイエラーについては、UI で報告されるメッセージを参照してください。

障害変数

次の変数は、このポリシーでランタイムエラーが発生したときに設定されます。

変数	説明	例
`fault.name="fault_name"`	`fault_name` は、上記のランタイムエラーの表に記載されている障害の名前です。障害名は、障害コードの最後の部分です。	`fault.name Matches "IPDeniedAccess"`
`oauthV2.policy_name.failed`	`policy_name` は、障害が発生したポリシーのユーザー指定の名前です。	`oauthV2.GetTokenInfo.failed = true`
`oauthV2.policy_name.fault.name`	`policy_name` は、障害が発生したポリシーのユーザー指定の名前です。	`oauthV2.GetToKenInfo.fault.name = invalid_client-invalid_client_id`
`oauthV2.policy_name.fault.cause`	`policy_name` は、障害が発生したポリシーのユーザー指定の名前です。	`oauthV2.GetTokenInfo.cause = ClientID is Invalid`

エラーレスポンスの例

{  
   "fault":{  
      "faultstring":"ClientId is Invalid",
      "detail":{  
         "errorcode":"keymanagement.service.invalid_client-invalid_client_id"
      }
   }
}

障害ルールの例

<FaultRule name="OAuthV2 Faults">
    <Step>
        <Name>AM-InvalidClientIdResponse</Name>
    </Step>
    <Condition>(fault.name = "invalid_client-invalid_client_id")</Condition>
</FaultRule>

Set OAuthV2 Info ポリシー

ランタイムエラー

このエラーは、ポリシーの実行時に発生することがあります。

障害コード	HTTP ステータス	原因
`steps.oauth.v2.access_token_expired`	500	ポリシーに送信されたアクセストークンは、期限が切れています。
`steps.oauth.v2.invalid_access_token`	500	ポリシーに送信されたアクセストークンが無効です。
`steps.oauth.v2.InvalidAPICallAsNoApiProductMatchFound`	401	このエラーのトラブルシューティングについては、こちらの Apigee コミュニティの投稿をご覧ください。

デプロイエラー

デプロイエラーについては、UI で報告されるメッセージを参照してください。

障害変数

次の変数は、このポリシーでランタイムエラーが発生したときに設定されます。

変数	説明	例
`fault.name="fault_name"`	`fault_name` は、上記のランタイムエラーの表に記載されている障害の名前です。障害名は、障害コードの最後の部分です。	`fault.name = "invalid_access_token"`
`oauthV2.policy_name.failed`	`policy_name` は、障害が発生したポリシーのユーザー指定の名前です。	`oauthV2.SetTokenInfo.failed = true`
`oauthV2.policy_name.fault.name`	`policy_name` は、障害が発生したポリシーのユーザー指定の名前です。	`oauthV2.SetTokenInfo.fault.name = invalid_access_token`
`oauthv2.policy_name.fault.cause`	`policy_name` は、障害が発生したポリシーのユーザー指定の名前です。	`oauthV2.SetTokenInfo.cause = Invalid Access Token`

エラーレスポンスの例

{
  "fault": {
    "faultstring": "Invalid Access Token",
    "detail": {
      "errorcode": "keymanagement.service.invalid_access_token"
    }
  }
}

障害ルールの例

<FaultRule name=SetOAuthV2Info Faults">
    <Step>
        <Name>AM-InvalidTokenResponse</Name>
        <Condition>(fault.name = "invalid_access_token")</Condition>
    </Step>
    <Condition>(oauthV2.failed = true) </Condition>
</FaultRule>

Delete OAuthV2 Info ポリシー

ランタイムエラー

このエラーは、ポリシーの実行時に発生することがあります。

障害コード	HTTP ステータス	原因
`steps.oauth.v2.invalid_access_token`	401	ポリシーに送信されたアクセストークンが無効です。
`steps.oauth.v2.invalid_request-authorization_code_invalid`	401	ポリシーに送信された認証コードが無効です。
`steps.oauth.v2.InvalidAPICallAsNoApiProductMatchFound`	401	このエラーのトラブルシューティングについては、こちらの Apigee コミュニティの投稿をご覧ください。

デプロイエラー

デプロイエラーについては、UI で報告されるメッセージを参照してください。

障害変数

次の変数は、このポリシーでランタイムエラーが発生したときに設定されます。

変数	説明	例
`fault.name="fault_name"`	`fault_name` は、上記のランタイムエラーの表に記載されている障害の名前です。障害名は、障害コードの最後の部分です。	`fault.name = "invalid_access_token"`
`oauthV2.policy_name.failed`	`policy_name` は、障害が発生したポリシーのユーザー指定の名前です。	`oauthV2.DeleteTokenInfo.failed = true`
`oauthV2.policy_name.fault.name`	`policy_name` は、障害が発生したポリシーのユーザー指定の名前です。	`oauthV2.DeleteTokenInfo.fault.name = invalid_access_token`
`oauthv2.policy_name.fault.cause`	`policy_name` は、障害が発生したポリシーのユーザー指定の名前です。	`oauthV2.DeleteTokenInfo.cause = Invalid Access Token`

エラーレスポンスの例

{
  "fault": {
    "faultstring": "Invalid Access Token",
    "detail": {
      "errorcode": "keymanagement.service.invalid_access_token"
    }
  }
}

障害ルールの例

<faultrule name="VariableOfNonMsgType"></faultrule><FaultRule name="DeleteOAuthV2Info_Faults">
    <Step>
        <Name>AM-InvalidTokenResponse</Name>
    </Step>
    <Condition>(fault.name = "invalid_access_token")</Condition>
</FaultRule>

OAuth v1.0a ポリシー

OAuthV1 ポリシータイプは、次のエラーコードを定義します。

OAuth 関連の HTTP エラーコードについては、OAuth HTTP エラーレスポンスリファレンスをご覧ください。

エラーコード	メッセージ

`AppKeyNotResolved`	`Could not resolve the app key with variable {0}`
`ConsumerKeyNotResolved`	`Could not resolve the consumer key with variable {0}`
`RequestTokenNotResolved`	`Could not resolve the request token with the variable {0}`
`AccessTokenNotResolved`	`Could not resolve the access token with the variable {0}`
`ResponseGenerationError`	`Error while generating response : {0}`
`UnableToDetermineOperation`	`Unable to determine an operation for stepDefinition {0}`
`UnableToResolveOAuthConfig`	`Unable to resolve the OAuth configuration for {0}`
`AtLeastOneParamRequired`	`At least one of AccessToken, RequestToken or ConsumerKey must be specified in stepDefinition {0}`
`SpecifyValueOrRefReqToken`	`Specify Request Token as value or ref in stepDefinition {0}`
`SpecifyValueOrRefAccToken`	`Specify Access Token as value or ref in stepDefinition {0}`
`SpecifyValueOrRefConKey`	`Specify Consumer Key as value or ref in stepDefinition {0}`
`SpecifyValueOrRefAppKey`	`Specify App Key as value or ref in stepDefinition {0}`
`ExpiresInNotApplicableForOperation`	`ExpiresIn element is not valid for operation {0}`
`InvalidValueForExpiresIn`	`Invalid value for ExpiresIn element for operation {0}`
`FailedToFetchApiProduct`	`Failed to fetch api product for key {0}`
`InvalidTokenType`	`Valid token types : {0}, Invalid toke type {1} in stepDefinition {2}`
`TokenValueRequired`	`Token value is required in stepDefinition {0}`
`FailedToResolveRealm`	`Failed to resolve realm {0}`

Get OAuthV1 Info ポリシー

No error codes are specified for the Get OAuth v1.0a Info policy.

Delete OAuthV1 Info ポリシー

成功すると、ポリシーは 200 ステータスを返します。

失敗すると、ポリシーは 404 と次のような出力を返します（（アクセストークン、リクエストトークン、ベリファイアを削除する場合）:

HTTP/1.1 404 Not Found
Content-Type: application/json
Content-Length: 144
Connection: keep-alive

{"fault":{"faultstring":"Invalid Access Token","detail":{"errorcode":"keymanagement.service.invalid_request-access_token_invalid"}}}

Python Script ポリシー

Runtime errors

These errors can occur when the policy executes.

Fault code	HTTP status	Cause	Fix
`steps.script.ScriptEvaluationFailed`	500	The PythonScript policy can throw several different types of ScriptExecutionFailed errors. Commonly seen types of errors include NameError and ZeroDivisionError.

Deployment errors

These errors can occur when you deploy a proxy containing this policy.

Error name	Cause	Fix
`InvalidResourceUrlFormat`	If the format of the resource URL specified within the `<ResourceURL>` or the `<IncludeURL>` element of the PythonScript policy is invalid, then the deployment of the API proxy fails.
`InvalidResourceUrlReference`	If the `<ResourceURL>` or the `<IncludeURL>` elements refer to a PythonScript file that does not exist, then the deployment of the API proxy fails. The referenced source file must exist either the API proxy, environment, or organization level.

Fault variables

These variables are set when this policy triggers an error at runtime. For more information, see What you need to know about policy errors.

Variables	Where	Example
`fault.name="fault_name"`	`fault_name` is the name of the fault, as listed in the Runtime errors table above. The fault name is the last part of the fault code.	`fault.name Matches "ScriptExecutionFailed"`
`pythonscript.policy_name.failed`	`policy_name` is the user-specified name of the policy that threw the fault.	`pythonscript.PythonScript-1.failed = true`

Example error response

Note: For error handling, the best practice is to trap the errorcode part of the error response. Do not rely on the text in the faultstring, because it could change.

{
  "fault": {
    "faultstring": "Execution of SetResponse failed with error: Pythonscript runtime error: "ReferenceError: "status" is not defined.\"",
    "detail": {
      "errorcode": "steps.script.ScriptExecutionFailed"
    }
  }
}

Example fault rule

<FaultRule name="PythonScript Policy Faults">
    <Step>
        <Name>AM-CustomErrorResponse</Name>
        <Condition>(fault.name Matches "ScriptExecutionFailed") </Condition>
    </Step>
    <Condition>(pythonscript.PythonScript-1.failed = true) </Condition>
</FaultRule>

Quota ポリシー

ランタイムエラー

このエラーは、ポリシーの実行時に発生することがあります。

障害コード	HTTP ステータス	原因	修正
`policies.ratelimit.FailedToResolveQuotaIntervalReference`	500	Quota ポリシーで `<Interval>` 要素が定義されていない場合に発生します。この要素は必須であり、割り当てに適用できる期間を指定するために使用されます。期間は、`<TimeUnit>` 要素で定義された分、時間、日、週、月で指定できます。
`policies.ratelimit.FailedToResolveQuotaIntervalTimeUnitReference`	500	Quota ポリシーで `<TimeUnit>` 要素が定義されていない場合に発生します。この要素は必須であり、割り当てに適用できる時間単位を指定するために使用されます。期間は、分、時間、日、週、月で指定できます。
`policies.ratelimit.InvalidMessageWeight`	500	フロー変数で `<MessageWeight>` 要素に無効な値（整数以外の値）が指定された場合に発生します。
`policies.ratelimit.QuotaViolation`	500	割り当て上限を超えました。	なし

デプロイエラー

エラー名	原因	修正
`InvalidQuotaInterval`	`<Interval>` 要素に指定された割り当て間隔が整数でない場合、API プロキシのデプロイが失敗します。たとえば、`<Interval>` 要素で指定された割り当て間隔が 0.1 の場合、API プロキシのデプロイが失敗します。
`InvalidQuotaTimeUnit`	`<TimeUnit>` 要素で指定された時間単位がサポートされていない場合、API プロキシのデプロイは失敗します。サポートされている時間単位は `minute`、`hour`、`day`、`week`、`month` です。
`InvalidQuotaType`	`<Quota>` 要素の `type` 属性で指定された割り当てのタイプが無効な場合、API プロキシのデプロイは失敗します。サポートされている割り当てのタイプは、`default`、`calendar`、`flexi`、`rollingwindow` です。
`InvalidStartTime`	`<StartTime>` 要素で指定された時刻の形式が無効な場合、API プロキシのデプロイは失敗します。有効な形式は `yyyy-MM-dd HH:mm:ss` です。これは ISO 8601 の日付と時刻の形式です。たとえば、`<StartTime>` 要素で指定された時間が `7-16-2017 12:00:00` の場合、API プロキシのデプロイは失敗します。
`StartTimeNotSupported`	割り当てのタイプが `calendar` タイプ以外の `<StartTime>` 要素が指定されている場合、API プロキシのデプロイは失敗します。`<StartTime>` 要素は、`calendar` 割り当てタイプでのみサポートされています。たとえば、`<Quota>` 要素の `type` 属性が `flexi` または `rolling window` に設定されている場合、API プロキシのデプロイは失敗します。
`InvalidTimeUnitForDistributedQuota`	`<Distributed>` 要素が `true` に設定され、`<TimeUnit>` 要素が `second` に設定されている場合、API プロキシのデプロイが失敗します。分散割り当てで時間単位 `second` は無効です。
`InvalidSynchronizeIntervalForAsyncConfiguration`	`<SyncIntervalInSeconds>` 要素に指定された値が Quota ポリシーの `<AsynchronousConfiguration>` 要素が 0 未満の場合、 API プロキシのデプロイに失敗します。
`InvalidAsynchronizeConfigurationForSynchronousQuota`	Quota ポリシーで `<AsynchronousConfiguration>` 要素の値が `true` に設定されていて、`<AsynchronousConfiguration>` 要素を使用して非同期構成が定義されている場合、API プロキシのデプロイは失敗します。

障害変数

変数	説明	例
`fault.name="fault_name"`	`fault_name` は、上記のランタイムエラーの表に記載されている障害の名前です。障害名は、障害コードの最後の部分です。	`fault.name Matches "QuotaViolation"`
`ratelimit.policy_name.failed`	`policy_name` は、障害が発生したポリシーのユーザー指定の名前です。	`ratelimit.QT-QuotaPolicy.failed = true`

エラーレスポンスの例

{  
   "fault":{  
      "detail":{  
         "errorcode":"policies.ratelimit.QuotaViolation"
      },
      "faultstring":"Rate limit quota violation. Quota limit  exceeded. Identifier : _default"
   }
}

障害ルールの例

<FaultRules>
    <FaultRule name="Quota Errors">
        <Step>
            <Name>JavaScript-1</Name>
            <Condition>(fault.name Matches "QuotaViolation") </Condition>
        </Step>
        <Condition>ratelimit.Quota-1.failed=true</Condition>
    </FaultRule>
</FaultRules>

Reset Quota ポリシー

Runtime errors

These errors can occur when the policy executes.

Fault code	HTTP status	Cause
`policies.resetquota.InvalidRLPolicy`	500	The Quota policy specified in the `<Quota>` element of the Reset Quota policy is not defined in the API proxy and thus is not available during the flow. The `<Quota>` element is mandatory and identifies the target Quota policy whose counter should be updated through the Reset Quota policy.
`policies.resetquota.FailedToResolveAllowCountRef`	N/A	The reference to the variable containing the allow count in the `<Allow>` element of the policy cannot be resolved to a value. This element is mandatory and specifies the amount to decrease the quota counter.
`policies.resetquota.FailedToResolveRLPolicy`	500	The variable referenced by the `ref` attribute in the `<Quota>` element cannot be resolved.

Deployment errors

These errors can occur when you deploy a proxy containing this policy.

Error name	Cause	Fix
`InvalidCount`	If the count value specified in the `<Allow>` element of the Reset Quota Policy is not an integer, then the deployment of the API proxy fails.

Raise Fault ポリシー

このセクションでは、障害コードとエラーメッセージ、障害変数について説明します。このポリシーでエラーがトリガーされたときに Edge によって設定されます。これは、障害に対処する障害ルールを作成するうえで重要な情報です。詳細については、ポリシーエラーについて知っておくべきことと障害の処理をご覧ください。

ランタイムエラー

このエラーは、ポリシーの実行時に発生することがあります。

障害コード	HTTP ステータス	原因
`steps.raisefault.RaiseFault`	500	障害文字列をご覧ください。

デプロイエラー

なし。

障害変数

ランタイムエラーが発生すると、次の変数が設定されます。詳細については、ポリシーエラーについて知っておくべきことをご覧ください。

変数	説明	例
`fault.name="fault_name"`	`fault_name` は、上記のランタイムエラーの表に記載されている障害の名前です。障害名は、障害コードの最後の部分です。	`fault.name = "RaiseFault"`
`raisefault.policy_name.failed`	`policy_name` は、ユーザー指定のポリシー名です。エラーをスローします。	`raisefault.RF-ThrowError.failed = true`

エラーレスポンスの例

{
   "fault":{
      "detail":{
         "errorcode":"steps.raisefault.RaiseFault"
      },
      "faultstring":"Raising fault. Fault name: [name]"
   }
}

Regular Expression Protection ポリシー

このセクションでは、このポリシーによってエラーがトリガーされたときに返されるエラーコードとメッセージ、Edge によって設定される障害変数について説明します。これは、障害に対処する障害ルールを作成するうえで重要な情報です。エラーをキャプチャして独自のカスタムエラーを発生させる場合は、ポリシールート要素で continueOnError="true" 属性を設定します。詳細については、ポリシーエラーについて知っておくべきことと障害の処理をご覧ください。

Edge ポリシーから返されるエラーは、エラーコードリファレンスで説明されている一貫した形式に従います。

ランタイムエラー

このエラーは、ポリシーの実行時に発生することがあります。

エラーコード	メッセージ

ExecutionFailed	RegularExpressionProtection StepDefinition {0} を実行できませんでした。理由: {1}
InstantiationFailed	RegularExpressionProtection StepDefinition {0} をインスタンス化できませんでした
NonMessageVariable	変数 {0} がメッセージに解決されません
SourceMessageNotAvailable	{0} メッセージは RegularExpressionProtection StepDefinition {1} に使用できません
ThreatDetected	{0} で検出された正規表現の脅威: regex: {1} 入力: {2}
VariableResolutionFailed	変数 {0} を解決できませんでした

デプロイエラー

エラーコード	メッセージ	解決方法

CannotBeConvertedToNodeset	RegularExpressionProtection {0}: xpath {1} の結果を nodeset に変換できません。コンテキスト {2}
DuplicatePrefix	RegularExpressionProtection {0}: 重複接頭辞 {1}
EmptyJSONPathExpression	RegularExpressionProtection {0}: 空の JSONPath 式
EmptyXPathExpression	RegularExpressionProtection {0}: 空の XPath 式
InvalidRegularExpression	RegularExpressionProtection {0}: 無効な正規表現 {1}、コンテキスト {2}
JSONPathCompilationFailed	RegularExpressionProtection {0}: jsonpath {1} をコンパイルできませんでした。コンテキスト {2}
NONEmptyPrefixMappedToEmptyURI	RegularExpressionProtection {0}: 空でない接頭辞 {1} を空の URI にマッピングできません。
NoPatternsToEnforce	RegularExpressionProtection {0}: {1} に適用するパターンはありません
NothingToEnforce	RegularExpressionProtection {0}: URIPath、QueryParam、Header、FormParam、XMLPayload、JSONPayload の少なくとも 1 つが必須です
XPathCompilationFailed	RegularExpressionProtection {0}: xpath {1} をコンパイルできませんでした。コンテキスト {2}

障害変数

変数	説明	例
`fault.name="fault_name"`	`fault_name` は、上記の表に示されている障害の名前です。	`fault.name Matches "ThreatDetected"`
`regularexpressionprotection.policy_name.failed`	`policy_name` は、障害が発生したポリシーのユーザー指定の名前です。	`regularexpressionprotection.Regular-Expressions-Protection-1.failed = true`

SOAP Message Validation ポリシー

ランタイムエラー

このエラーは、ポリシーの実行時に発生することがあります。

障害コード HTTP ステータス原因解決方法

steps.messagevalidation.SourceMessageNotAvailable

500

このエラーは、ポリシーの <Source> 要素で指定された変数が次のいずれかである場合に発生します。

範囲外（ポリシーが実行されている特定のフローで使用できない）
解決不能（未定義）

steps.messagevalidation.NonMessageVariable

500

このエラーは、SOAPMessageValidation ポリシーの <Source> 要素がメッセージ型以外の変数に設定されている場合に発生します。

メッセージ型の変数は HTTP リクエストとレスポンス全体を表します。組み込みの Edge フロー変数 request、response、message はメッセージ型です。メッセージ変数の詳細については、変数リファレンスをご覧ください。

steps.messagevalidation.Failed 500 このエラーは、SOAPMessageValidation ポリシーが、XSD スキーマまたは WSDL 定義に対する入力メッセージペイロードを検証できなかった場合に発生します。また、ペイロードメッセージ内の JSON または XML の形式が正しくない場合にも発生します。

デプロイエラー

以下のエラーは、このポリシーを含むプロキシをデプロイするときに発生することがあります。

エラー名	原因	解決方法
`InvalidResourceType`	SOAPMessageValidation ポリシーの `<ResourceURL>` 要素が、ポリシーでサポートされていないリソースタイプに設定されています。
`ResourceCompileFailed`	SOAPMessageValidation ポリシーの `<ResourceURL>` 要素で参照されているリソーススクリプトに、コンパイルを妨げるエラーが含まれています。
`RootElementNameUnspecified`	SOAPMessageValidation ポリシーの `<Element>` 要素にルート要素の名前が含まれていません。
`InvalidRootElementName`	SOAPMessageValidation ポリシーの `<Element>` 要素に、有効な要素の命名に関する XML ルールに準拠していないルート要素名が含まれています。

SAML Assertion ポリシー

このセクションでは、障害コードとエラーメッセージについて説明します。このポリシーでエラーがトリガーされたときに Edge によって設定される障害変数。これは、障害に対処する障害ルールを作成するうえで重要な情報です。詳細については、ポリシーエラーについて知っておくべきことと障害の処理をご覧ください。

デプロイエラー

以下のエラーは、このポリシーを含むプロキシをデプロイするときに発生することがあります。

エラー名	原因	修正
`SourceNotConfigured`	Validate SAML Assertion ポリシーの `<Source>`、`<XPath>`、`<Namespaces>`、`<Namespace>` の要素のうち 1 つ以上が定義されていないか、空である。
`TrustStoreNotConfigured`	`<TrustStore>` 要素が空である、または ValidateSAMLAssertion ポリシーで指定されていない場合、API プロキシのデプロイは失敗します。有効なトラストストアが必要です。
`NullKeyStoreAlias`	子要素 `<Alias>` が空である、または Generate SAML Assertion ポリシーの `<Keystore>` 要素で指定されていない場合、API プロキシのデプロイは失敗します。有効なキーストアエイリアスが必要です。
`NullKeyStore`	子要素 `<Name>` が空であるか、`<Keystore>` で指定されていない場合 GenerateSAMLAssertion ポリシーの要素、API のデプロイ、失敗します。有効なキーストア名が必要です。
`NullIssuer`	`<Issuer>` 要素が空である、または Generate SAML Assertion ポリシーで指定されていない場合、API プロキシのデプロイは失敗します。有効な `<Issuer>` の値が必要です。

障害変数

ランタイムエラーが発生すると、次の変数が設定されます。詳細については、ポリシーエラーについて知っておくべきことをご覧ください。

変数	説明	例
`fault.name="fault_name"`	`fault_name` は障害の名前です。障害名は、障害コードの最後の部分です。	`fault.name = "InvalidMediaTpe"`
`GenerateSAMLAssertion.failed`	検証 SAML assertion ポリシー構成の場合、エラーの接頭辞は `ValidateSAMLAssertion` になります。	`GenerateSAMLAssertion.failed = true`

エラーレスポンスの例

{
  "fault": {
    "faultstring": "GenerateSAMLAssertion[GenSAMLAssert]: Invalid media type",
    "detail": {
      "errorcode": "steps.saml.generate.InvalidMediaTpe"
    }
  }
}

障害ルールの例

<FaultRules>
    <FaultRule name="invalid_saml_rule">
        <Step>
            <Name>invalid-saml</Name>
        </Step>
        <Condition>(GenerateSAMLAssertion.failed = "true")</Condition>
    </FaultRule>
</FaultRules>

Service Callout ポリシー

Runtime errors

These errors can occur when the policy executes.

Fault code HTTP status Cause Fix

steps.servicecallout.ExecutionFailed

500

This error can occur when:

the policy is asked to handle input that is malformed or otherwise invalid.
the backend target service returns an error status (by default, 4xx or 5xx).

steps.servicecallout.RequestVariableNotMessageType 500 The Request variable specified in the policy is not of type Message. For example, if it's a string or other non-message type, you'll see this error.

steps.servicecallout.RequestVariableNotRequestMessageType 500 The Request variable specified in the policy is not of type Request Message. For example, if it's a Response type, you'll see this error.

Deployment errors

These errors can occur when you deploy a proxy containing this policy.

Error name	Cause	Fix
`URLMissing`	The `<URL>` element inside `<HTTPTargetConnection>` is missing or empty.
`ConnectionInfoMissing`	This error happens if the policy does not have an `<HTTPTargetConnection>` or `<LocalTargetConnection>` element.
`InvalidTimeoutValue`	This error happens if the `<Timeout>` value is negative or zero.

Fault variables

These variables are set when a runtime error occurs. For more information, see What you need to know about policy errors.

Variables	Where	Example
`fault.name="fault_name"`	`fault_name` is the name of the fault, as listed in the Runtime errors table above. The fault name is the last part of the fault code.	`fault.name = "RequestVariableNotMessageType"`
`servicecallout.policy_name.failed`	`policy_name` is the user-specified name of the policy that threw the fault.	`servicecallout.SC-GetUserData.failed = true`

Example error response

Note: For error handling, the best practice is to trap the errorcode part of the error response. Do not rely on the text in the faultstring, because it could change.

{  
   "fault":{  
      "detail":{  
         "errorcode":"steps.servicecallout.RequestVariableNotMessageType"
      },
      "faultstring":"ServiceCallout[ServiceCalloutGetMockResponse]: 
            request variable data_str value is not of type Message"
   }
}

Example fault rule

<faultrule name="VariableOfNonMsgType"></faultrule><FaultRule name="RequestVariableNotMessageType">
    <Step>
        <Name>AM-RequestVariableNotMessageType</Name>
    </Step>
    <Condition>(fault.name = "RequestVariableNotMessageType")</Condition>
</FaultRule>

Spike Arrest ポリシー

Runtime errors

These errors can occur when the policy executes.

Fault code	HTTP status	Cause
`policies.ratelimit.FailedToResolveSpikeArrestRate`	`500`	This error occurs if the reference to the variable containing the rate setting within the `<Rate>` element cannot be resolved to a value within the Spike Arrest policy. This element is mandatory and used to specify the spike arrest rate in the form of `intpm` or `intps`.
`policies.ratelimit.InvalidMessageWeight`	`500`	This error occurs if the value specified for the `<MessageWeight>` element through a flow variable is invalid (a non-integer value).
`policies.ratelimit.SpikeArrestViolation`	`429`	The rate limit was exceeded. Note: For Private Cloud, the default HTTP status code returned is `500`. To change the status code returned to `429`, set this property with the API call described in Example fault rule

Deployment errors

These errors can occur when you deploy a proxy containing this policy.

Error name	Cause	Fix
`InvalidAllowedRate`	If the spike arrest rate specified in the `<Rate>` element of the Spike Arrest Policy is not an integer or if the rate does not have `ps` or `pm` as a suffix, then the deployment of the API proxy fails.

Fault variables

These variables are set when a runtime error occurs. For more information, see What you need to know about policy errors.

Variables	Where	Example
`fault.name="fault_name"`	`fault_name` is the name of the fault, as listed in the Runtime errors table above. The fault name is the last part of the fault code.	`fault.name Matches "SpikeArrestViolation"`
`ratelimit.policy_name.failed`	`policy_name` is the user-specified name of the policy that threw the fault.	`ratelimit.SA-SpikeArrestPolicy.failed = true`

Example error response

Shown below is an example error response:

Note: For error handling, the best practice is to trap the errorcode part of the error response. Do not rely on the text in the faultstring, because it could change.

{  
   "fault":{  
      "detail":{  
         "errorcode":"policies.ratelimit.SpikeArrestViolation"
      },
      "faultstring":"Spike arrest violation. Allowed rate : 10ps"
   }
}

Example fault rule

Shown below is an example fault rule to handle a SpikeArrestViolation fault:

<FaultRules>
    <FaultRule name="Spike Arrest Errors">
        <Step>
            <Name>JavaScript-1</Name>
            <Condition>(fault.name Matches "SpikeArrestViolation") </Condition>
        </Step>
        <Condition>ratelimit.Spike-Arrest-1.failed=true</Condition>
    </FaultRule>
</FaultRules>

Statistics Collector ポリシー

このセクションでは、このポリシーによってエラーがトリガーされたときに設定されるエラーメッセージとフロー変数について説明します。これは、プロキシの障害ルールを作成するうえで重要な情報です。詳細については、ポリシーエラーについて知っておくべきことと障害の処理をご覧ください。

ランタイムエラー

なし。

デプロイエラー

エラー名	原因	修正
`UnsupportedDatatype`	Statistics Collector ポリシーの `<Statistic>` 要素の ref 属性で指定された変数の型がサポートされていない場合、API プロキシのデプロイに失敗します。サポートされているデータ型は、`string`、`integer`、`float`、`long`、`double`、`boolean` です。
`InvalidName`	Statistics Collector ポリシーの `<Statistic>` 要素に定義されている変数のデータを参照するために使用する名前がシステム定義の変数と競合する場合、API プロキシのデプロイに失敗します。既知のシステム定義の変数としては、`organization`、`environment` などがあります。
`DatatypeMissing`	Statistics Collector ポリシーの `<Statistic>` 要素の `ref` 属性で指定された変数の型が見つからない場合、API プロキシのデプロイに失敗します。

障害変数

なし。

Verify API Key ポリシー

ランタイムエラー

このエラーは、ポリシーの実行時に発生することがあります。

障害コード	HTTP ステータス	原因
`keymanagement.service.CompanyStatusNotActive`	401	デベロッパーアプリに関連付けられ、使用する API キーを所有している会社がアクティブな状態ではありません。会社のステータスを非アクティブに設定すると、この会社に関連するデベロッパーやアプリにアクセスできなくなります。組織管理者は、管理 API を使用して会社のステータスを変更できます。会社のステータスを設定するをご覧ください。
`keymanagement.service.DeveloperStatusNotActive`	401	お客様が使用している API キーを持つデベロッパーアプリを作成したデベロッパーが非アクティブなステータスです。アプリデベロッパーのステータスが非アクティブに設定されると、このデベロッパーが作成したすべてのデベロッパーアプリも無効になります。適切な権限のある管理ユーザー（組織管理者など）は、次の方法でデベロッパーのステータスを変更できます。 Management API: デベロッパーのステータスを設定する管理 UI: アプリデベロッパーを登録するで、デベロッパーを無効（または有効）にする手順を確認してください。
`keymanagement.service.invalid_client-app_not_approved`	401	API キーに関連付けられたデベロッパーアプリが取り消されています。取り消されたアプリは API プロダクトにアクセスできず、Apigee Edge が管理する API を呼び出すこともできません。組織管理者は、管理 API を使用してデベロッパーアプリのステータスを変更できます。デベロッパーアプリの承認と取り消しをご覧ください。
`oauth.v2.FailedToResolveAPIKey`	401	ポリシーは、ポリシーの <APIKey> 要素で指定された変数の中で API キーを見つけることを想定しています。このエラーは、想定した変数が存在しない（解決できない）ときに発生します。
`oauth.v2.InvalidApiKey`	401	Edge が受信した API キーが無効です。Edge は、データベースでキーを検索するときに、リクエストで送信されたキーと完全に一致するキーを検索します。以前に機能していた API の場合は、キーが再生成されていないことを確認してください。キーが再生成されている場合に古いキーを使用しようとすると、このエラーが表示されます。詳細については、アプリを登録して API キーを管理するをご覧ください。
`oauth.v2.InvalidApiKeyForGivenResource`	401	Edge が有効な API キーを受信しましたが、プロダクトで API プロキシと関連付けられているデベロッパーアプリの承認キーと一致しません。

注: 現在、Edge は ApiKeyNotApproved エラーを正確に報告しません。代わりに、キーが承認されていない場合（ステータスが「revoked」または「pending」に設定されている場合）、FailedToResolveAPIKey エラーが発生します。詳細情報と考えられる回避策については、Apigee コミュニティのこちらの投稿をご覧ください。

デプロイエラー

以下のエラーは、このポリシーを含むプロキシをデプロイするときに発生することがあります。

エラー名	原因
`SpecifyValueOrRefApiKey`	`<APIKey>` 要素に値とキーが指定されていません。

障害変数

ランタイムエラーが発生すると、次の変数が設定されます。詳細については、ポリシーエラーについて知っておくべきことをご覧ください。

変数	説明	例
`fault.name="fault_name"`	`fault_name` は、上記のランタイムエラーの表に記載されている障害の名前です。障害名は、障害コードの最後の部分です。	`fault.name Matches "FailedToResolveAPIKey"`
`oauthV2.policy_name.failed`	`policy_name` は、障害が発生したポリシーのユーザー指定の名前です。	`oauthV2.VK-VerifyAPIKey.failed = true`

エラーレスポンスの例

注: ベストプラクティスとして、エラー処理でエラーレスポンスの errorcode の部分をトラップすることをおすすめします。faultstring のテキストには依存しないでください。この部分は変更される可能性があります。

{
   "fault":{
      "faultstring":"Invalid ApiKey",
      "detail":{
         "errorcode":"oauth.v2.InvalidApiKey"
      }
   }
}

{
   "fault":{
      "detail":{
         "errorcode":"keymanagement.service.DeveloperStatusNotActive"
      },
      "faultstring":"Developer Status is not Active"
   }
}

障害ルールの例

<FaultRule name="FailedToResolveAPIKey">
    <Step>
        <Name>AM-FailedToResolveAPIKey</Name>
    </Step>
    <Condition>(fault.name Matches "FailedToResolveAPIKey") </Condition>
</FaultRule>

Verify JWS ポリシー

ランタイムエラー

このエラーは、ポリシーの実行時に発生することがあります。

障害コード	HTTP ステータス	発生条件
`steps.jws.AlgorithmInTokenNotPresentInConfiguration`	401	検証ポリシーに複数のアルゴリズムがある場合。
`steps.jws.AlgorithmMismatch`	401	Generate ポリシーでヘッダーに指定されたアルゴリズムが、Verify ポリシーで想定されたアルゴリズムと一致しない場合。指定されたアルゴリズムは一致する必要があります。
`steps.jws.ContentIsNotDetached`	401	JWS に分離済みコンテンツペイロードが含まれているのに `<DetachedContent>` が指定されている場合。
`steps.jws.FailedToDecode`	401	ポリシーで JWS をデコードできなかった場合。JWS が破損している可能性があります。
`steps.jws.InsufficientKeyLength`	401	HS256 アルゴリズム用の鍵が 32 バイト未満の場合。
`steps.jws.InvalidClaim`	401	クレームが欠落しているか、一致していない場合。または、ヘッダーが欠落しているか、一致していない場合。
`steps.jws.InvalidCurve`	401	鍵で指定された曲線が、楕円曲線アルゴリズムでは無効な場合。
`steps.jws.InvalidJsonFormat`	401	無効な JSON が JWS ヘッダーで検出された場合。
`steps.jws.InvalidJws`	401	JWS 署名の検証で不合格だった場合。
`steps.jws.InvalidPayload`	401	JWS ペイロードが無効な場合。
`steps.jws.InvalidSignature`	401	`<DetachedContent>` が省略され、JWS に分離済みのコンテンツペイロードがある場合。
`steps.jws.KeyIdMissing`	401	Verify ポリシーが JWKS を公開鍵のソースとして使用するが、署名付き JWS にはヘッダーに `kid` プロパティが含まれてない場合。
`steps.jws.KeyParsingFailed`	401	指定された鍵情報で公開鍵を解析できない場合。
`steps.jws.MissingPayload`	401	JWS ペイロードが欠落している場合。
`steps.jws.NoAlgorithmFoundInHeader`	401	JWS がアルゴリズムヘッダーを省略すると発生します。
`steps.jws.NoMatchingPublicKey`	401	Verify ポリシーが JWKS を公開鍵のソースとして使用するが、署名付き JWS の `kid` は JWKS にリストされない場合。
`steps.jws.UnhandledCriticalHeader`	401	`crit` ヘッダーの Verify JWS ポリシーで見つかったヘッダーが `KnownHeaders` にリストされていない場合。
`steps.jws.UnknownException`	401	不明な例外が発生した場合。
`steps.jws.WrongKeyType`	401	鍵のタイプが正しくない場合。たとえば、楕円曲線アルゴリズムで RSA 鍵を指定した場合や、RSA アルゴリズムで曲線鍵を指定した場合など。

デプロイエラー

以下のエラーは、このポリシーを含むプロキシをデプロイするときに発生することがあります。

エラー名エラーが発生する条件

InvalidAlgorithm 有効な値は、RS256、RS384、RS512、PS256、PS384、PS512、ES256、ES384、ES512、HS256、HS384、HS512 のみです。

EmptyElementForKeyConfiguration

FailedToResolveVariable

InvalidConfigurationForActionAndAlgorithmFamily

InvalidConfigurationForVerify

InvalidEmptyElement

InvalidFamiliesForAlgorithm

InvalidKeyConfiguration

InvalidNameForAdditionalClaim

InvalidNameForAdditionalHeader

InvalidPublicKeyId

InvalidPublicKeyValue

InvalidSecretInConfig

InvalidTypeForAdditionalClaim

InvalidTypeForAdditionalHeader

InvalidValueForElement

InvalidValueOfArrayAttribute

InvalidVariableNameForSecret

MissingConfigurationElement

MissingElementForKeyConfiguration

MissingNameForAdditionalClaim

MissingNameForAdditionalHeader

その他の発生の可能性があるデプロイエラー。

障害変数

ランタイムエラーが発生すると、次の変数が設定されます。詳細については、ポリシーエラーについて知っておくべきことをご覧ください。

変数	説明	例
`fault.name="fault_name"`	`fault_name` は、上記のランタイムエラーの表に記載されている障害の名前です。障害名は、障害コードの最後の部分です。	`fault.name Matches "TokenExpired"`
`JWS.failed`	障害の場合は、すべての JWS ポリシーで同じ変数が設定されます。	`jws.JWS-Policy.failed = true`

エラーレスポンスの例

障害ルールの例

<FaultRules>
    <FaultRule name="JWS Policy Errors">
        <Step>
            <Name>JavaScript-1</Name>
            <Condition>(fault.name Matches "TokenExpired")</Condition>
        </Step>
        <Condition>JWS.failed=true</Condition>
    </FaultRule>
</FaultRules>

Verify JWT ポリシー

ランタイムエラー

このエラーは、ポリシーの実行時に発生することがあります。

障害コード	HTTP ステータス	発生条件
`steps.jwt.AlgorithmInTokenNotPresentInConfiguration`	401	検証ポリシーに複数のアルゴリズムがある場合。
`steps.jwt.AlgorithmMismatch`	401	Generate ポリシーで指定されたアルゴリズムが、Verify ポリシーで想定されているアルゴリズムと一致しない場合。指定されたアルゴリズムが一致している必要があります。
`steps.jwt.FailedToDecode`	401	ポリシーで JWT をデコードできなかった場合。JWT が破損している可能性があります。
`steps.jwt.GenerationFailed`	401	ポリシーで JWT を生成できなかった場合。
`steps.jwt.InsufficientKeyLength`	401	HS256 アルゴリズムで鍵が 32 バイト未満の場合、HS386 アルゴリズムで鍵が 48 バイト未満の場合、HS512 アルゴリズムで鍵が 64 バイト未満の場合。
`steps.jwt.InvalidClaim`	401	クレームが欠落しているか、一致していない場合。または、ヘッダーが欠落しているか、一致していない場合。
`steps.jwt.InvalidCurve`	401	鍵で指定された曲線が、楕円曲線アルゴリズムでは無効な場合。
`steps.jwt.InvalidJsonFormat`	401	ヘッダーまたはペイロードで無効な JSON が検出された場合。
`steps.jwt.InvalidToken`	401	JWT 署名の検証で不合格だった場合。
`steps.jwt.JwtAudienceMismatch`	401	トークンの検証でオーディエンスクレームが不合格だった場合。
`steps.jwt.JwtIssuerMismatch`	401	トークンの検証で発行元クレームが不合格だった場合。
`steps.jwt.JwtSubjectMismatch`	401	トークンの検証でサブジェクトクレームが不合格だった場合。
`steps.jwt.KeyIdMissing`	401	Verify ポリシーが公開鍵のソースとして JWKS を使用しているが、署名付き JWT のヘッダーに `kid` プロパティが含まれてない場合。
`steps.jwt.KeyParsingFailed`	401	指定された鍵情報で公開鍵を解析できない場合。
`steps.jwt.NoAlgorithmFoundInHeader`	401	JWT にアルゴリズムヘッダーが含まれていない場合。
`steps.jwt.NoMatchingPublicKey`	401	Verify ポリシーが JWKS を公開鍵のソースとして使用するが、署名付き JWT の `kid` が JWKS にリストされていない場合。
`steps.jwt.SigningFailed`	401	GenerateJWT で、HS384 または HS512 アルゴリズムの鍵が最小サイズより小さい場合。
`steps.jwt.TokenExpired`	401	ポリシーが期限切れのトークンを検証しようとしている場合。
`steps.jwt.TokenNotYetValid`	401	トークンがまだ有効になっていない場合。
`steps.jwt.UnhandledCriticalHeader`	401	`crit` ヘッダーの Verify JWT ポリシーで見つかったヘッダーが `KnownHeaders` にリストされていない場合。
`steps.jwt.UnknownException`	401	不明な例外が発生した場合。
`steps.jwt.WrongKeyType`	401	鍵のタイプが正しくない場合。たとえば、楕円曲線アルゴリズムで RSA 鍵を指定した場合や、RSA アルゴリズムで曲線鍵を指定した場合など。

デプロイエラー

以下のエラーは、このポリシーを含むプロキシをデプロイするときに発生することがあります。

エラー名	原因	修正
`InvalidNameForAdditionalClaim`	`<AdditionalClaims>` 要素の子要素 `<Claim>` で使用されているクレームの型が登録済みの名前（`kid`、`iss`、`sub`、`aud`、`iat`、`exp`、`nbf`、`jti`）のいずれかである場合、デプロイが失敗します。
`InvalidTypeForAdditionalClaim`	`<AdditionalClaims>` 要素の子要素 `<Claim>` で使用されているクレームが `string`、`number`、`boolean`、`map` 型でない場合、デプロイが失敗します。
`MissingNameForAdditionalClaim`	`<AdditionalClaims>` 要素の子要素 `<Claim>` でクレームの名前が指定されていない場合、デプロイが失敗します。
`InvalidNameForAdditionalHeader`	このエラーは、`<AdditionalClaims>` 要素の子要素 `<Claim>` で使用されているクレームの名前が `alg` または `typ` の場合に発生します。
`InvalidTypeForAdditionalHeader`	`<AdditionalClaims>` 要素の子要素 `<Claim>` で使用されているクレームの型が `string`、`number`、`boolean`、`map` 型でない場合、デプロイが失敗します。
`InvalidValueOfArrayAttribute`	このエラーは、`<AdditionalClaims>` 要素の子要素 `<Claim>` 内の配列属性の値が `true` または `false` に設定されていない場合に発生します。
`InvalidValueForElement`	`<Algorithm>` 要素に指定された値がサポートされていない場合、デプロイが失敗します。
`MissingConfigurationElement`	このエラーは、`<PrivateKey>` 要素が RSA ファミリーアルゴリズムで使用されていない場合や、`<SecretKey>` 要素が HS ファミリーアルゴリズムで使用されていない場合に発生します。
`InvalidKeyConfiguration`	子要素 `<Value>` が `<PrivateKey>` 要素または `<SecretKey>` 要素で定義されていない場合、デプロイが失敗します。
`EmptyElementForKeyConfiguration`	`<PrivateKey>` 要素または `<SecretKey>` 要素の子要素 `<Value>` の ref 属性が空か、指定されていない場合、デプロイが失敗します。
`InvalidConfigurationForVerify`	このエラーは、`<Id>` 要素が `<SecretKey>` 要素内で定義されている場合に発生します。
`InvalidEmptyElement`	このエラーは、Verify JWT ポリシーの `<Source>` 要素が空の場合に発生します。存在する場合、Edge フロー変数名で定義する必要があります。
`InvalidPublicKeyValue`	`<PublicKey>` 要素の子要素 `<JWKS>` で使用されている値が、RFC 7517 で指定されている有効な形式になっていない場合、デプロイが失敗します。
`InvalidConfigurationForActionAndAlgorithm`	`<PrivateKey>` 要素が HS ファミリーアルゴリズムで使用されている場合、または `<SecretKey>` 要素が RSA ファミリーアルゴリズムで使用されている場合、デプロイが失敗します。

Fault variables

These variables are set when a runtime error occurs. For more information, see What you need to know about policy errors.

Variables	Where	Example
`fault.name="fault_name"`	`fault_name` is the name of the fault, as listed in the Runtime errors table above. The fault name is the last part of the fault code.	`fault.name Matches "TokenExpired"`
`JWT.failed`	All JWT policies set the same variable in the case of a failure.	`JWT.failed = true`

Example error response

JWT Policy Fault Codes

For error handling, the best practice is to trap the errorcode part of the error response. Do not rely on the text in the faultstring, because it could change.

Example fault rule

    <FaultRules>
        <FaultRule name="JWT Policy Errors">
            <Step>
                <Name>JavaScript-1</Name>
                <Condition>(fault.name Matches "TokenExpired")</Condition>
            </Step>
            <Condition>JWT.failed=true</Condition>
        </FaultRule>
    </FaultRules>

XML Threat Protection ポリシー

ランタイムエラー

このエラーは、ポリシーの実行時に発生することがあります。

障害コード	HTTP ステータス	原因
`steps.xmlthreatprotection.ExecutionFailed`	500	XMLThreatProtection ポリシーでは、さまざまな種類の ExecutionFailed エラーをスローできます。エラーのほとんどは、ポリシーで設定された特定のしきい値を超えた場合に発生します。これらのエラーには次のようなものがあります。要素名の長さ子数、ノード深度、属性数、属性名の長さその他多数詳細なリストについては、XMLThreatProtection ポリシーのランタイムエラーのトラブルシューティングをご覧ください。
`steps.xmlthreatprotection.InvalidXMLPayload`	500	このエラーは、XMLThreatProtection ポリシーの `<Source>` 要素で指定された入力メッセージペイロードが有効な XML ドキュメントでない場合に発生します。
`steps.xmlthreatprotection.SourceUnavailable`	500	このエラーは、`<Source>` 要素で指定されたメッセージ変数が次のいずれかである場合に発生します。範囲外（ポリシーが実行されている特定のフローで使用できない）有効な値 `request`、`response`、`message` のいずれでもない
`steps.xmlthreatprotection.NonMessageVariable`	500	このエラーは、`<Source>` 要素がメッセージ型以外の変数に設定されている場合に発生します。

注:

エラー名 ExecutionFailed は、デフォルトのエラー名であり、検出されたエラーの種類このデフォルトは、優先度を設定することによって組織レベルのプロパティです。このプロパティを設定すると、エラー名に実際のエラーが発生します。例: TextExceeded値に「AttrValueExceeded」があります。詳しくは、使用上の注意をご覧ください。
500 HTTP ステータスがデフォルトですが、組織レベルのプロパティを設定すると、リクエストフローエラーの HTTP ステータスを 400 に変更できます。詳しくは、使用上の注意をご覧ください。

デプロイエラー

なし。

障害変数

ランタイムエラーが発生すると、次の変数が設定されます。詳細については、ポリシーエラーについて知っておくべきことをご覧ください。

変数	説明	例
`fault.name="fault_name"`	`fault_name` は、上記のランタイムエラーの表に記載されている障害の名前です。障害名は、障害コードの最後の部分です。	`fault.name Matches "SourceUnavailable"`
`xmlattack.policy_name.failed`	`policy_name` は、障害が発生したポリシーのユーザー指定の名前です。	`xmlattack.XPT-SecureRequest.failed = true`

エラーレスポンスの例

{
  "fault": {
    "faultstring": "XMLThreatProtection[XPT-SecureRequest]: Execution failed. reason: XMLThreatProtection[XTP-SecureRequest]: Exceeded object entry name length at line 2",
    "detail": {
      "errorcode": "steps.xmlthreatprotection.ExecutionFailed"
    }
  }
}

障害ルールの例

<FaultRule name="XML Threat Protection Policy Faults">
    <Step>
        <Name>AM-CustomErrorResponse</Name>
        <Condition>(fault.name Matches "ExecutionFailed") </Condition>
    </Step>
    <Condition>(xmlattack.XPT-SecureRequest.failed = true) </Condition>
</FaultRule>

XML to JSON ポリシー

Runtime errors

These errors can occur when the policy executes.

Fault code	HTTP status	Cause
`steps.xmltojson.ExecutionFailed`	500	This error occurs when the input payload (XML) is empty or the input XML is invalid or malformed.
`steps.xmltojson.InCompatibleType`	500	This error occurs if the type of the variable defined in the `<Source>` element and the `<OutputVariable>` element are not the same. It is mandatory that the type of the variables contained within the `<Source>` element and the `<OutputVariable>` element matches.
`steps.xmltojson.InvalidSourceType`	500	This error occurs if the type of the variable used to define the `<Source>` element is invalid.The valid types of variable are message and string.
`steps.xmltojson.OutputVariableIsNotAvailable`	500	This error occurs if the variable specified in the `<Source>` element of the XML to JSON policy is of type string and the `<OutputVariable>` element is not defined. The `<OutputVariable>` element is mandatory when the variable defined in the `<Source>` element is of type string.
`steps.xmltojson.SourceUnavailable`	500	This error occurs if the message variable specified in the `<Source>` element of the XML to JSON policy is either: out of scope (not available in the specific flow where the policy is being executed) or can't be resolved (is not defined)

Deployment errors

These errors can occur when you deploy a proxy containing this policy.

Error name	Cause	Fix
`EitherOptionOrFormat`	If one of the elements `<Options>` or `<Format>` is not declared in the XML to JSON Policy, then the deployment of the API proxy fails.
`UnknownFormat`	If the `<Format>` element within the XML to JSON policy has an unknown format defined, then the deployment of the API proxy fails. Predefined formats include: `xml.com`, `yahoo`, `google`, and `badgerFish`.

Fault variables

These variables are set when a runtime error occurs. For more information, see What you need to know about policy errors.

Variables	Where	Example
`fault.name="fault_name"`	`fault_name` is the name of the fault, as listed in the Runtime errors table above. The fault name is the last part of the fault code.	`fault.name = "SourceUnavailable"`
`xmltojson.policy_name.failed`	`policy_name` is the user-specified name of the policy that threw the fault.	`xmltojson.XMLtoJSON-1.failed = true`

Example error response

Note: For error handling, the best practice is to trap the errorcode part of the error response. Do not rely on the text in the faultstring, because it could change.

{
  "fault": {
    "faultstring": "XMLToJSON[XMLtoJSON-1]: Source xyz is not available",
    "detail": {
      "errorcode": "steps.xml2json.SourceUnavailable"
    }
  }
}

Example fault rule

<faultrule name="VariableOfNonMsgType"></faultrule><FaultRule name="XML to JSON Faults">
    <Step>
        <Name>AM-SourceUnavailableMessage</Name>
        <Condition>(fault.name Matches "SourceUnavailable") </Condition>
    </Step>
    <Step>
        <Name>AM-BadXML</Name>
        <Condition>(fault.name = "ExecutionFailed")</Condition>
    </Step>
    <Condition>(xmltojson.XMLtoJSON-1.failed = true) </Condition>
</FaultRule>

XSL Transform ポリシー

ランタイムエラー

このエラーは、ポリシーの実行時に発生することがあります。

障害コード	HTTP ステータス	原因	解決方法
`steps.xsl.XSLSourceMessageNotAvailable`	500	このエラーは、XSL Transform ポリシーの `<Source>` 要素で指定されたメッセージまたは文字列変数がスコープ外である（ポリシーが実行されている特定のフローで使用できない）か、解決できない（定義されていない）場合に発生します。
`steps.xsl.XSLEvaluationFailed`	500	このエラーは、入力 XML ペイロードが使用できない、または不正な形式の場合、または XSLTransform ポリシーが XSL ファイルに指定された変換ルールに基づいた入力 XML ファイルの変換に失敗する、または変換できない場合に発生します。XSLTransform ポリシーは、さまざまな原因で失敗します。エラーメッセージに含まれている失敗の理由から、原因についてより詳しい情報を得ることができます。

デプロイエラー

以下のエラーは、このポリシーを含むプロキシをデプロイするときに発生することがあります。

エラー名	原因	解決方法
`XSLEmptyResourceUrl`	XSL Transform ポリシーの `<ResourceURL>` 要素が空の場合、API プロキシのデプロイは失敗します。
`XSLInvalidResourceType`	XSL Transform ポリシーの `<ResourceURL>` 要素に指定されたリソースタイプが `xsl` でない場合、API プロキシのデプロイは失敗します。

ポリシーエラー リファレンス

Access Control ポリシー

ランタイム エラー

障害変数

障害レスポンスの例

障害ルールの例

Access Entity ポリシー

ランタイム エラー

デプロイエラー

Assign Message ポリシー

Runtime errors

Deployment errors

Fault variables

Example error response

Example fault rule

Basic Authentication ポリシー

Runtime errors

Deployment errors

Fault variables

Example error response

Example fault rule

Concurrent Rate Limit ポリシー

ランタイム エラー

デプロイエラー

障害変数

エラー レスポンスの例

障害ルールの例

Decode JWS ポリシー

ランタイム エラー

デプロイエラー

障害変数

エラー レスポンスの例

障害ルールの例

Decode JWT ポリシー

Runtime errors

Deployment errors

Fault variables

Example error response

Example fault rule

Extract Variables ポリシー

Runtime errors

Deployment errors

Fault variables

Example error response

Example fault rule

Generate JWS ポリシー

ランタイム エラー

デプロイエラー

障害変数

エラー レスポンスの例

障害ルールの例

Generate JWT ポリシー

ランタイム エラー

デプロイエラー

Fault variables

Example error response

Example fault rule

Java Callout ポリシー

ランタイム エラー

デプロイエラー

障害変数

エラー レスポンスの例

障害ルールの例

JavaScript ポリシー

Runtime errors

Deployment errors

Fault variables

Example error response

Example fault rule

JSON Threat Protection ポリシー

ランタイム エラー

デプロイエラー

障害変数

エラー レスポンスの例

障害ルールの例

JSON to XML ポリシー

ランタイム エラー

デプロイエラー

障害変数

エラー レスポンスの例

ポリシーエラーリファレンス

ランタイムエラー

ランタイムエラー

ランタイムエラー

エラーレスポンスの例

ランタイムエラー

エラーレスポンスの例

ランタイムエラー

エラーレスポンスの例

ランタイムエラー

ランタイムエラー

エラーレスポンスの例

ランタイムエラー

エラーレスポンスの例

ランタイムエラー

エラーレスポンスの例

ランタイムエラー

ランタイムエラー

ランタイムエラー

エラーレスポンスの例

ランタイムエラー

エラーレスポンスの例

ランタイムエラー

エラーレスポンスの例

ランタイムエラー

エラーレスポンスの例

ランタイムエラー

エラーレスポンスの例

ランタイムエラー

エラーレスポンスの例

ランタイムエラー

エラーレスポンスの例