SetOAuth v2-Informationsrichtlinie

Diese Seite gilt für Apigee und Apigee Hybrid.

Apigee Edge-Dokumentation aufrufen

Mit der SetOAuthV2Info-Richtlinie können Sie benutzerdefinierte Attribute hinzufügen oder aktualisieren, die mit einem Zugriffstoken verknüpft sind. Benutzerdefinierte Attribute können beispielsweise den Namen einer Abteilung, eine Kundennummer oder eine Sitzungs-ID enthalten. Siehe auch Token und Autorisierungscodes anpassen.

Sie können benutzerdefinierte Attribute nur hinzufügen oder ändern. Sie können diese Richtlinie nicht verwenden, um Felder wie "Scope", "status", "expires_in", "developer_email", "client_id", "org_name" oder "refresh_count" zu ändern. Wenn ein Attribut bereits vorhanden ist, wird es durch diese Richtlinie aktualisiert. Wenn sie nicht vorhanden ist, wird sie von der Richtlinie hinzugefügt. Das referenzierte Zugriffstoken muss gültig sein und den Status "Genehmigt" haben.

Diese Richtlinie ist eine erweiterbare Richtlinie, deren Verwendung je nach Apigee-Lizenz Auswirkungen auf die Kosten oder die Nutzung haben kann. Informationen zu Richtlinientypen und Auswirkungen auf die Nutzung finden Sie unter Richtlinientypen.

Beispiele

Einfaches Beispiel

Im Folgenden finden Sie eine Beispielrichtlinie, die zum Aktualisieren eines OAuth 2.0-Zugriffstokens verwendet wird. Im folgenden Beispiel wird das Zugriffstoken für die Anfragenachricht über den Suchparameter access_token gesucht. Wenn ein Zugriffstoken von einer Client-App bereitgestellt wird, sucht die Richtlinie unten das Zugriffstoken im Suchparameter. Anschließend wird das Profil des Zugriffstokens aktualisiert. Dem Profil wird eine benutzerdefinierte Eigenschaft namens department.id hinzugefügt. 

<SetOAuthV2Info name="SetOAuthV2Info">
  <AccessToken ref="request.queryparam.access_token"></AccessToken>
  <Attributes>
    <Attribute name="department.id" ref="request.queryparam.department_id"></Attribute>
  </Attributes>
</SetOAuthV2Info>

Elementreferenz

Die Elementreferenz beschreibt die Elemente und Attribute der SetOAuthV2-Richtlinie.

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<SetOAuthV2Info async="false" continueOnError="false" enabled="true" name="SetOAuthV2Info-1">
    <DisplayName>Set OAuth v2.0 Info 1</DisplayName>
    <AccessToken ref={some-variable}></AccessToken>
    <Attributes/>
</SetOAuthV2Info>
</xml>

<SetOAuthV2Info>-Attribute

<SetOAuthV2Info async="false" continueOnError="false" enabled="true" name="Set-OAuth-v20-Info-1">

The following table describes attributes that are common to all policy parent elements:

Attribute Description Default Presence
name

The internal name of the policy. The value of the name attribute can contain letters, numbers, spaces, hyphens, underscores, and periods. This value cannot exceed 255 characters.

Optionally, use the <DisplayName> element to label the policy in the management UI proxy editor with a different, natural-language name.

 N/A Required
continueOnError

Set to false to return an error when a policy fails. This is expected behavior for most policies.

Set to true to have flow execution continue even after a policy fails. See also:

 false Optional
enabled

Set to true to enforce the policy.

Set to false to turn off the policy. The policy will not be enforced even if it remains attached to a flow.

 true Optional
async

This attribute is deprecated.

 false Deprecated

<DisplayName> element

Use in addition to the name attribute to label the policy in the management UI proxy editor with a different, natural-language name.

<DisplayName>Policy Display Name</DisplayName>
Default

N/A

If you omit this element, the value of the policy's name attribute is used.
Presence Optional
Type String

<AccessToken>-Element

Gibt die Variable an, in der sich das Zugriffstoken befindet. Wenn beispielsweise das Zugriffstoken an die Anfragenachricht als Suchparameter angehängt ist, geben Sie request.queryparam.access_token an. Sie können jede gültige Variable verwenden, die auf das Token verweist. Alternativ könnte der literalen Tokenstring verwendet werden (selten).

 <AccessToken ref="request.queryparam.access_token"></AccessToken>
Standard: –
Präsenz: Erforderlich
Typ: String

Attribute

Attribut Beschreibung Standard Präsenz
ref

Eine Variable für das Zugriffstoken. Wird normalerweise aus einer Ablaufvariablen abgerufen.

 – Optional

<Attributes>-Element

Eine Reihe von Attributen im Zugriffstokenprofil, die geändert oder erweitert werden.

Standard: –
Präsenz: Erforderlich
Typ: –

<Attributes>/<Attribute>-Element

Ein einzelnes zu aktualisierendes Attribut.

Das Namensattribut gibt die benutzerdefinierte Eigenschaft des Zugriffstokens an, das aktualisiert werden soll. In diesem Beispiel wird gezeigt, wie ein referenzierter Variablenwert und ein statischer Wert verwendet werden. 

  <Attributes>
    <Attribute name="department.id" ref="request.queryparam.department_id"></Attribute>
    <Attribute name="foo">bar</Attribute>
  </Attributes>
Standard: –
Präsenz: Optional
Typ: –

Attribute

Attribut Beschreibung Standard Präsenz
Name Der Name des Profilattributs, das Sie hinzufügen oder ändern möchten. –
Ref

Der Wert, der dem Profilattribut zugewiesen werden soll.

 – Optional

Ablaufvariablen

Bei Erfolg werden die folgenden Ablaufvariablen festgelegt:

  • oauthv2accesstoken.{policyName}.access_token
  • oauthv2accesstoken.{policyName}.client_id
  • oauthv2accesstoken.{policyName}.refresh_count
  • oauthv2accesstoken.{policyName}.organization_name
  • oauthv2accesstoken.{policyName}.expires_in //--in seconds
  • oauthv2accesstoken.{policyName}.refresh_token_expires_in //--in seconds
  • oauthv2accesstoken.{policyName}.issued_at
  • oauthv2accesstoken.{policyName}.status
  • oauthv2accesstoken.{policyName}.api_product_list
  • oauthv2accesstoken.{policyName}.token_type
  • oauthv2accesstoken.{policyName}.{custom_attribute_name}

Schema

Jeder Richtlinientyp wird durch ein XML-Schema (.xsd) definiert. Zu Referenzzwecken sind Richtlinienschemas auf GitHub verfügbar.

Fehlerreferenz

This section describes the fault codes and error messages that are returned and fault variables that are set by Apigee 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
steps.oauth.v2.access_token_expired 500 The access token sent to the policy is expired.
steps.oauth.v2.invalid_access_token 500 The access token sent to the policy is invalid.
steps.oauth.v2.InvalidAPICallAsNoApiProductMatchFound 401 Please see Oauth2.0 Access Token Verification throws "Invalid API call as no apiproduct match found" error for information about troubleshooting this error.

Deployment errors

Refer to the message reported in the UI for information about deployment errors.

Fault variables

These variables are set when this policy triggers an error at runtime.

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 = "invalid_access_token"
oauthV2.policy_name.failed policy_name is the user-specified name of the policy that threw the fault. oauthV2.SetTokenInfo.failed = true
oauthV2.policy_name.fault.name policy_name is the user-specified name of the policy that threw the fault. oauthV2.SetTokenInfo.fault.name = invalid_access_token
oauthv2.policy_name.fault.cause policy_name is the user-specified name of the policy that threw the fault. oauthV2.SetTokenInfo.cause = Invalid Access Token

Example error response

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

Example fault rule

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

Weitere Informationen