Uzyskiwanie zasady OAuthOAuth22Info

Wyświetlasz dokumentację Apigee Edge.
Przejdź do dokumentacji Apigee X. info

Co

Pobiera atrybuty tokenów dostępu, tokenów odświeżania, kodów autoryzacji i atrybutów aplikacji klienckiej oraz wypełnia zmienne wartościami tych atrybutów.

Ta zasada jest przydatna, gdy trzeba skonfigurować dynamiczne, warunkowe działanie na podstawie wartości w tokenie lub kodzie autoryzacji. Za każdym razem, gdy następuje weryfikacja tokena, zmienne są automatycznie wypełniane wartościami atrybutów tokena. Jeśli jednak weryfikacja tokena nie nastąpiła, możesz użyć tej funkcji, aby jawnie wypełnić zmienne wartościami atrybutów tokena. Zobacz też Dostosowywanie tokenów i kodów autoryzacji.

Token dostępu przekazywany do tej zasady musi być ważny. W przeciwnym razie zasada zwróci błąd invalid_access_token .

Przykłady

W tych przykładach używamy zasady Get OAuth V2 Info (Pobierz informacje o OAuth V2), aby pobrać informacje o różnych komponentach procesu OAuth2, a następnie uzyskać 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

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

Atrybuty <GetOAuthV2Info>

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

Element <AccessToken>

Pobiera profil tokena dostępu. Przekazujesz zmienną zawierającą ciąg tokena dostępu lub literał tokena (rzadki przypadek). W tym przykładzie token dostępu jest pobierany z parametru zapytania przekazanego w żądaniu. Jeśli chcesz zwrócić informacje o unieważnionym lub wygasłym tokenie, użyj elementu <IgnoreAccessTokenStatus> .

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

Element <AuthorizationCode>

Pobiera profil kodu autoryzacji. Przekazujesz zmienną zawierającą ciąg kodu autoryzacji lub literał tokena (rzadki przypadek). W tym przykładzie kod autoryzacji jest pobierany z parametru zapytania przekazanego w żądaniu. Listę zmiennych wypełnianych przez tę operację znajdziesz w sekcji "Zmienne przepływu".

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

Element <ClientId>

Pobiera informacje związane z identyfikatorem klienta. W tym przykładzie identyfikator klienta jest pobierany z parametru zapytania przekazanego w żądaniu. Listę zmiennych wypełnianych przez tę operację, znajdziesz w sekcji "Zmienne przepływu".

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

Element <IgnoreAccessTokenStatus>

Zwraca informacje o tokenie, nawet jeśli token wygasł lub został unieważniony. Ten element może być używany tylko z tokenami dostępu. Informacje o innych elementach, takich jak tokeny odświeżania i kody autoryzacji , są domyślnie zwracane niezależnie od ich stanu.

<IgnoreAccessTokenStatus>true</IgnoreAccessTokenStatus>

Element <RefreshToken>

Pobiera profil tokena odświeżania. Przekazujesz zmienną zawierającą ciąg tokena odświeżania lub literał tokena (rzadki przypadek). W tym przykładzie token odświeżania jest pobierany z parametru zapytania przekazanego w żądaniu. Listę zmiennych wypełnianych przez tę operację znajdziesz w sekcji "Zmienne przepływu".

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

Zmienne przepływu

Zasada GetOAuthV2Info wypełnia te zmienne i jest zwykle używana w przypadkach, gdy potrzebujesz danych profilu, ale nie doszło jeszcze do przyznania dostępu ani weryfikacji. .

Zmienne identyfikatora klienta

Te zmienne są wypełniane, gdy ustawiony jest element 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ą wypełniane, gdy ustawiony jest element 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ą wypełniane, gdy ustawiony jest element 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}

Zmienne tokena odświeżania

Te zmienne są wypełniane, gdy ustawiony jest element 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 zasady jest zdefiniowany przez schemat XML (.xsd). Schematy zasad są dostępne na GitHubie.

Odniesienie do błędu

W tej sekcji opisano kody błędów i komunikaty o błędach, które są zwracane, oraz zmienne błędów ustawiane przez Edge, gdy ta zasada wyzwala błąd. Warto o tym wiedzieć, jeśli rozwijasz reguły błędów, aby obsługi błędów. Więcej informacji znajdziesz w artykule Co musisz wiedzieć o błędach związanych z zasadami i postępowaniu z błędami

Błędy w czasie wykonywania

Te błędy mogą wystąpić podczas wykonywania zasady. Nazwy błędów widoczne poniżej to ciągi tekstowe przypisane do zmiennej fault.name w przypadku wystąpienia błędu. Zobacz błąd zmiennych.

Błędy wdrażania

Więcej informacji o błędach wdrażania znajdziesz w komunikacie zgłoszonym w interfejsie.

Zmienne błędów

Te zmienne są ustawiane, gdy ta zasada wywołuje błąd w czasie działania.

Przykładowa odpowiedź na błąd

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

Przykładowa reguła błędu

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

Powiązane artykuły

• Zasada OAuthV2
• OAuth – strona główna
• Dostosowywanie tokenów i kodów autoryzacji