Uzyskiwanie zasady OAuthOAuth22Info

Przeglądasz dokumentację Apigee Edge.
Przejdź do Dokumentacja Apigee X. informacje.

Co

Pobiera atrybuty tokenów dostępu, tokeny odświeżania, kody autoryzacji i aplikację klienta i wypełnia zmienne wartościami tych atrybutów.

Ta zasada jest przydatna, gdy trzeba skonfigurować dynamiczne, warunkowe zachowanie na podstawie wartości w tokenie lub kodzie autoryzacji. Przy każdym sprawdzeniu poprawności tokena zmienne są uzupełniane automatycznie. wartościami atrybutów tokena. Jeżeli jednak token nie został sprawdzony, może używać tej funkcji, aby jawnie wypełniać zmienne wartościami atrybutów tokena. Zobacz też Dostosowywanie tokenów Authorization Codes (Kody autoryzacji).

Token dostępu, który przekazujesz do tej zasady, musi być prawidłowy. W przeciwnym razie zasada wygeneruje invalid_access_token błąd.

Przykłady

W poniższych przykładach użyto zasady Get OAuth V2 Info do pobierania informacji o różnych w obrębie przepływu pracy OAuth2, a następnie uzyskując dostęp do tych informacji w kodzie.

<GetOAuthV2Info name="MyTokenAttrsPolicy">
  <AccessToken ref="request.queryparam.access_token"></AccessToken>
</GetOAuthV2Info>

var scope = context.getVariable('oauthv2accesstoken.MyTokenAttrsPolicy.scope');

<GetOAuthV2Info name="MyAuthCodeAttrsPolicy">
  <AuthorizationCode ref="request.formparam.code"></AuthorizationCode>
</GetOAuthV2Info>

var attr = context.getVariable(‘oauthv2authcode.MyAuthCodeAttrsPolicy.custom_attribute_name’);

<GetOAuthV2Info name="MyRefreshTokenAttrsPolicy">
  <RefreshToken ref="request.queryparam.refresh_token"/>
</GetOAuthV2Info>

var attr = context.getVariable(‘oauthv2refreshtoken.MyRefreshTokenAttrsPolicy.accesstoken.custom_attribute_name’);

<GetOAuthV2Info name="GetTokenAttributes">
  <AccessToken>shTUmeI1geSKin0TODcGLXBNe9vp</AccessToken>
</GetOAuthV2Info>

<GetOAuthV2Info name="GetClientAttributes">
  <ClientId ref="request.queryparam.client_id"></ClientId>
</GetOAuthV2Info>

context.getVariable("oauthv2client.GetClientAttributes.developer.email");
context.getVariable("oauthv2client.GetClientAttributes.developer.app.name");

Odniesienie do elementu

Dokumentacja elementu opisuje elementy i atrybuty zasady GetOAuthV2Info.

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<GetOAuthV2Info async="false" continueOnError="false" enabled="true" name="GetOAuthV2Info-1"
    <DisplayName>Get OAuth v2.0 Info 1</DisplayName>
    <AccessToken ref="variable"></AccessToken>
    <AuthorizationCode ref="variable"></AuthorizationCode>
    <ClientId ref="variable"></ClientId>
    <RefreshToken ref="variable"></RefreshToken>
</GetOAuthV2Info>

<GetOAuthV2Info> atrybuty

<GetOAuthV2Info async="false" continueOnError="false" enabled="true" name="Get-OAuth-v20-Info-1">

W tej tabeli opisano atrybuty wspólne dla wszystkich elementów nadrzędnych zasad:

&lt;DisplayName&gt; element

Używaj oprócz atrybutu name do oznaczania zasady w edytor proxy interfejsu zarządzania z inną nazwą w języku naturalnym.

<DisplayName>Policy Display Name</DisplayName>

&lt;AccessToken&gt; element

Pobiera profil dla tokena dostępu. Przekazujesz zmienną, która zawiera ciąg tokena dostępu lub ciąg tokenu literału (rzadkie litery). W tym przykładzie token dostępu to pobranych z parametru zapytania przekazanego w żądaniu. Używaj parametru <ignoreAccessTokenStatus> jeśli chcesz zwrócić informacje o unieważnionym lub wygasłym tokenie.

<AccessToken ref="request.queryparam.access_token"></AccessToken>

&lt;AuthorizationCode&gt; element

Pobiera profil kodu autoryzacji. Podaj zmienną, która zawiera ciąg kodu uwierzytelniania lub ciąg znaków tokena literału (rzadkie litery). W tym przykładzie kod autoryzacji to pobranych z parametru zapytania przekazanego w żądaniu. Aby uzyskać listę zmiennych wypełnianych przez ten argument Więcej dowiesz się z artykułu „Zmienne przepływu”.

<AuthorizationCode ref="request.queryparam.authorization_code"></AuthorizationCode>

&lt;ClientId&gt; element

Pobiera informacje związane z identyfikatorem klienta. W tym przykładzie pobierany jest identyfikator klienta. z parametru zapytania przekazanego w żądaniu. Aby zobaczyć listę zmiennych wypełnianych przez tę operację, Więcej informacji: „Zmienne przepływu”.

<ClientId ref="request.queryparam.client_id"></ClientId>

&lt;IgnoreAccessTokenStatus&gt; element

Zwraca informacje o tokenie, nawet jeśli token wygasł lub został unieważniony. Ten element może mieć tylko używane z tokenami dostępu. Informacje dotyczące innych jednostek, takich jak tokeny odświeżania i autoryzacja są domyślnie zwracane bez względu na ich stan.

<IgnoreAccessTokenStatus>true</IgnoreAccessTokenStatus>

&lt;RefreshToken&gt; element

Pobiera profil dla tokena odświeżania. Przekazujesz zmienną, która zawiera odśwież ciąg tokena lub literału tokena (rzadkie litery). W tym przykładzie token odświeżania to pobranych z parametru zapytania przekazanego w żądaniu. Aby uzyskać listę zmiennych wypełnianych przez ten argument Więcej dowiesz się z artykułu „Zmienne przepływu”.

<RefreshToken ref="request.queryparam.refresh_token"></RefreshToken>

Zmienne przepływu

Te zmienne wypełnia zasada GetOAuthV2Info i jest zwykle używana w przypadkach, gdy nie potrzebują danych profilu, ale nie mają jeszcze zatwierdzenia ani weryfikacji. .

Zmienne identyfikatora klienta

Te zmienne są wypełniane po ustawieniu elementu ClientId:

oauthv2client.{policy_name}.client_id
oauthv2client.{policy_name}.client_secret
oauthv2client.{policy_name}.redirection_uris // Note the spelling -- 'redirection_uris'
oauthv2client.{policy_name}.developer.email
oauthv2client.{policy_name}.developer.app.name
oauthv2client.{policy_name}.developer.id
oauthv2client.{policy_name}.{developer_app_custom_attribute_name}

Zmienne tokena dostępu

Te zmienne są zapełniane po ustawieniu elementu AccessToken:

oauthv2accesstoken.{policy_name}.developer.id
oauthv2accesstoken.{policy_name}.developer.app.name
oauthv2accesstoken.{policy_name}.developer.app.id
oauthv2accesstoken.{policy_name}.developer.email

oauthv2accesstoken.{policy_name}.organization_name
oauthv2accesstoken.{policy_name}.api_product_list

oauthv2accesstoken.{policy_name}.access_token
oauthv2accesstoken.{policy_name}.scope
oauthv2accesstoken.{policy_name}.expires_in //in seconds
oauthv2accesstoken.{policy_name}.status
oauthv2accesstoken.{policy_name}.client_id
oauthv2accesstoken.{policy_name}.accesstoken.{custom_attribute_name}

oauthv2accesstoken.{policy_name}.refresh_token
oauthv2accesstoken.{policy_name}.refresh_token_status
oauthv2accesstoken.{policy_name}.refresh_token_expires_in //in seconds

oauthv2accesstoken.{policy_name}.refresh_count
oauthv2accesstoken.{policy_name}.refresh_token_issued_at
oauthv2accesstoken.{policy_name}.revoke_reason //Apigee hybrid only with value of REVOKED_BY_APP, REVOKED_BY_ENDUSER, REVOKED_BY_APP_ENDUSER, or TOKEN_REVOKED

Zmienne kodu autoryzacji

Te zmienne są zapełniane po ustawieniu elementu AuthorizationCode:

oauthv2authcode.{policy_name}.code
oauthv2authcode.{policy_name}.scope       
oauthv2authcode.{policy_name}.redirect_uri 
oauthv2authcode.{policy_name}.client_id
oauthv2authcode.{policy_name}.{auth_code_custom_attribute_name}

Odśwież zmienne tokena

Te zmienne są zapełniane po ustawieniu elementu RefreshToken:

oauthv2refreshtoken.{policy_name}.developer.id
oauthv2refreshtoken.{policy_name}.developer.app.name
oauthv2refreshtoken.{policy_name}.developer.app.id
oauthv2refreshtoken.{policy_name}.developer.email
oauthv2refreshtoken.{policy_name}.organization_name
oauthv2refreshtoken.{policy_name}.api_product_list

oauthv2refreshtoken.{policy_name}.access_token
oauthv2refreshtoken.{policy_name}.scope
oauthv2refreshtoken.{policy_name}.expires_in //in seconds

oauthv2refreshtoken.{policy_name}.status
oauthv2refreshtoken.{policy_name}.client_id
oauthv2refreshtoken.{policy_name}.accesstoken.{custom_attribute_name}

oauthv2refreshtoken.{policy_name}.refresh_token
oauthv2refreshtoken.{policy_name}.refresh_token_status
oauthv2refreshtoken.{policy_name}.refresh_token_expires_in //in seconds

oauthv2refreshtoken.{policy_name}.refresh_count
oauthv2refreshtoken.{policy_name}.refresh_token_issued_at
oauthv2refreshtoken.{policy_name}.revoke_reason //Apigee hybrid only with value of REVOKED_BY_APP, REVOKED_BY_ENDUSER, REVOKED_BY_APP_ENDUSER, or TOKEN_REVOKED

Schemat

Każdy typ zasad jest definiowany przez schemat XML (.xsd). Schematy zasad są dostępne na GitHubie.

Informacje o błędzie

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. The error names shown below are the strings that are assigned to the fault.name variable when an error occurs. See the Fault variables section below for more details.

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":"ClientId is Invalid",
      "detail":{  
         "errorcode":"keymanagement.service.invalid_client-invalid_client_id"
      }
   }
}

Example fault rule

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

Powiązane artykuły

• Zasady OAuthV2
• Strona główna OAuth
• Dostosowywanie tokenów i kody autoryzacji