SetOAuth v2-Informationsrichtlinie

<ph type="x-smartling-placeholder"></ph> Sie sehen die Dokumentation zu Apigee Edge.
Gehen Sie zur Apigee X-Dokumentation. Weitere Informationen

Was

Ermöglicht das Hinzufügen oder Aktualisieren von benutzerdefinierten Attributen, die mit einem Zugriffstoken verknüpft sind. Benutzerdefinierte Attribute können beispielsweise den Namen einer Abteilung, eine Kundennummer oder eine Sitzungs-ID enthalten. Siehe 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.

Beispiele

<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">

In der folgenden Tabelle werden Attribute beschrieben, die für alle übergeordneten Richtlinienelemente gelten:

<DisplayName>-Element

Wird zusätzlich zum Attribut name verwendet, um die Richtlinie im Proxy-Editor der Verwaltungs-UI mit einem anderen Namen in einer natürlichen Sprache zu versehen.

<DisplayName>Policy Display Name</DisplayName>

<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>

Attribute

<Attributes>-Element

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

<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>

Attribute

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 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.

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.

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

• OAuthV2-Richtlinie
• OAuth-Startseite
• Tokens und Autorisierungscodes anpassen