Variabili di flusso OAuth

Stai visualizzando la documentazione di Apigee Edge.
Vai alla sezione Documentazione di Apigee X. Informazioni

Apigee Edge incapsula le funzionalità OAuth 1.0a e OAuth 2 in un insieme di criteri. La vita e la gestione del ciclo di token e secret, comprese generazione, convalida e archiviazione, da Apigee Edge per conto dei tuoi servizi di backend.

Questo documento specifica le variabili di flusso definite dai criteri OAuth. Le variabili possono essere utilizzati per implementare un comportamento personalizzato per i flussi OAuth. Per l'utilizzo di OAuth, vedi OAuth.

Variabili di flusso OAuth 2.0

Le variabili di flusso definite in questa tabella vengono compilate quando i rispettivi criteri OAuth vengono e, di conseguenza, sono disponibili per altri criteri o applicazioni in esecuzione nel proxy API flusso di lavoro.

Verifica il criterio del token di accesso
  • organization_name
  • organization_name
  • developer.id
  • developer.app.name
  • client_id
  • grant_type
  • token_type
  • access_token
  • accesstoken.{custom_attribute}
  • issued_at
  • expires_in
  • status
  • scope
  • apiproduct.name*
  • apiproduct.<custom_attribute_name>*

* Variabili di prodotto API

Esempio di criterio:

<OAuthV2 name="VerifyAccessToken">
    <Operation>VerifyAccessToken</Operation>
    <Scope>space-separated-scopes</Scope>*
    <AccessToken>flow.variable</AccessToken>*        
    <AccessTokenPrefix>Bearer</AccessTokenPrefix>*
</OAuthV2>

Sono supportati solo i token di connessione. I token MAC non sono supportati.

Per impostazione predefinita, il token di accesso deve essere passato nella richiesta HTTP di autorizzazione intestazione.

Ad esempio:

"Authorization: Bearer {PlainText_AccessToken}"

Qualsiasi flow.variable può essere passato come:

  • HTTP Header: request.header.{variable_name}
  • Query parameter: request.queryparam.{variable_name}
  • Form parameter: request.formparam.{variable_name}

Se i campi facoltativi non sono specificati, i valori vengono estratti in base al protocollo OAuth 2.0 e la specifica del prodotto.
Genera criterio per il codice di autorizzazione
Variabili impostate dopo l'esito positivo:
  • oauthv2authcode.{policy_name}.code
  • oauthv2authcode.{policy_name}.redirect_uri
  • oauthv2authcode.{policy_name}.scope
  • oauthv2authcode.{policy_name}.client_id

Esempio di criterio:

<OAuthV2 name="GetAuthCode">
  <Operation>GenerateAuthorizationCode</Operation>
  <ExpiresIn>1000<ExpiresIn>
  <ResponseType>flow.variable</ResponseType>*
  <ClientId>flow.variable</ClientId>*
  <RedirectUri>flow.variable</RedirectUri>*
  <Scope>flow.variable</Scope>*
  <State>flow.variable</State>*
  <Attributes>*   
    <Attribute name=”1” ref=”flow.variable”>value1</Attribute>
    <Attribute name=”2” ref=”flow.variable”>value2</Attribute>
  </Attributes>
</OAuthV2>

* Facoltativo

Qualsiasi flow.variable può essere passato come:

  • HTTP Header: request.header.{variable_name}
  • Query parameter: request.queryparam.{variable_name}
  • Form parameter: request.formparam.{variable_name}

Se i campi facoltativi non sono specificati, i valori vengono estratti in base al protocollo OAuth 2.0 e la specifica del prodotto.

I valori degli attributi vengono derivati in modo dinamico dalla variabile di flusso specificata oppure utilizzando in modo statico un valore predefinito nel criterio.

Se sono specificati entrambi, la variabile di flusso ha la precedenza.
Genera criteri token di accesso per tipi di concessioni, codice di autorizzazione, credenziali utente e credenziali client
Variabili impostate dopo l'esito positivo:
  • oauthv2accesstoken.{policy_name}.access_token
  • oauthv2accesstoken.{policy_name}.token_type
  • oauthv2accesstoken.{policy_name}.expires_in
  • oauthv2accesstoken.{policy_name}.refresh_token

Esempio di criterio:

<OAuthV2 name="GenerateAccessToken">
  <Operation>GenerateAccessToken</Operation>
  <ExpiresIn>1000<ExpiresIn>
  <SupportedGrantTypes>*
    <GrantType>authorization_code</GrantType>
    <GrantType>password</GrantType>
   <GrantType>client_credentials</GrantType>
  </SupportedGrantTypes>
  <GrantType>flow.variable</GrantType>* 
  <ClientId>flow.variable</ClientId>* 
  <RedirectUri>flow.variable</RedirectUri>* 
  <Scope>flow.variable</Scope>* 
  <AppEndUser>flow.variable</AppEndUser>* 
  <Code>flow.variable</Code>* 
  <UserName>flow.variable</UserName>* 
  <PassWord>flow.variable</PassWord>*
  <Attributes>*
    <Attribute name=”1” ref=”flow.variable”>value1</Attribute> 
    <Attribute name=”2” ref=”flow.variable”>value2</Attribute>  
  </Attributes>
</OAuthV2>

* Facoltativo

Qualsiasi flow.variable può essere passato come:

  • HTTP Header: request.header.{variable_name}
  • Query parameter: request.queryparam.{variable_name}
  • Form parameter: request.formparam.{variable_name}

Se i campi facoltativi non sono specificati, i valori vengono estratti in base al protocollo OAuth 2.0 e la specifica del prodotto.

I valori degli attributi vengono derivati in modo dinamico dalla variabile di flusso specificata oppure utilizzando in modo statico un valore predefinito nel criterio.

Se sono specificati entrambi, la variabile di flusso ha la precedenza.
Genera criterio del token di accesso per il tipo di concessione implicita
Variabili impostate dopo l'esito positivo:
  • oauthv2accesstoken.{policy_name}.access_token
  • oauthv2accesstoken.{policy_name}.token_type
  • oauthv2accesstoken.{policy_name}.expires_in
  • oauthv2accesstoken.{policy_name}.refresh_token

Esempio di criterio:

<OAuthV2 name="GenerateAccessToken">
  <Operation>GenerateAccessTokenImplicitGrant</Operation>
  <ExpiresIn>1000<ExpiresIn>
  <ResponseType>flow.variable></ResponseType>*
  <ClientId>flow.variable></ClientId>*
  <RedirectUri>flow.variable></RedirectUri>*
  <Scope>flow.variable></Scope>*
  <State>flow.variable></State>*
  <AppEndUser>flow.variable</AppEndUser>*                                   
  <Attributes>*
    <Attribute name=”1” ref=”flow.variable”>value1</Attribute>
    <Attribute name=”2” ref=”flow.variable”>value2</Attribute>
  </Attributes>
</OAuthV2>

* Facoltativo

Qualsiasi flow.variable può essere passato come:

  • HTTP Header: request.header.{variable_name}
  • Query parameter: request.queryparam.{variable_name}
  • Form parameter: request.formparam.{variable_name}

Se i campi facoltativi non sono specificati, i valori vengono estratti in base al protocollo OAuth 2.0 e la specifica del prodotto.

I valori degli attributi vengono derivati in modo dinamico dalla variabile di flusso specificata oppure utilizzando in modo statico un valore predefinito nel criterio.

Se sono specificati entrambi, la variabile di flusso ha la precedenza.
Aggiorna criterio del token di accesso
Variabili impostate dopo l'esito positivo:
  • oauthv2accesstoken.{policy_name}.access_token
  • oauthv2accesstoken.{policy_name}.token_type
  • oauthv2accesstoken.{policy_name}.expires_in
  • oauthv2accesstoken.{policy_name}.refresh_token

Esempio di criterio:

<OAuthV2 name="RefreshAccessToken">
  <Operation>RefreshAccessToken</Operation>
  <ExpiresIn>1000<ExpiresIn>
  <GrantType>flow.variable</GrantType>*
  <RefreshToken>flow.variable</RefreshToken>*
</OAuthV2>

* Facoltativo

Qualsiasi flow.variable può essere passato come:

  • HTTP Header: request.header.{variable_name}
  • Query parameter: request.queryparam.{variable_name}
  • Form parameter: request.formparam.{variable_name}

Se i campi facoltativi non sono specificati, i valori vengono estratti in base al protocollo OAuth 2.0 e la specifica del prodotto.
Ottieni criterio per gli attributi del client

Esempio di criterio:

<GetOAuthV2Info name="GetClientAttributes">
<ClientId ref="{variable_name}"/>
</GetOAuthV2Info>

Esempio di criterio:

<GetOAuthV2Info name="GetClientAttributes">
  <ClientId>{client_id}</ClientId>
</GetOAuthV2Info>
Ottieni criterio sugli attributi del token di accesso
Variabili impostate dopo l'esito positivo:
  • oauthv2accesstoken.{policy_name}.access_token
  • oauthv2accesstoken.{policy_name}.scope
  • oauthv2accesstoken.{policy_name}.refresh_token
  • oauthv2accesstoken.{policy_name}.accesstoken.{custom_attribute_name}
  • oauthv2accesstoken.{policy_name}.developer.id
  • oauthv2accesstoken.{policy_name}.developer.app.name
  • oauthv2accesstoken.{policy_name}.expires_in
  • oauthv2accesstoken.{policy_name}.status

Esempio di criterio:

<GetOAuthV2Info name="GetTokenAttributes">
  <AccessToken ref="{variable_name}"/>
</GetOAuthV2Info>

Esempio di criterio:

<GetOAuthV2Info name="GetTokenAttributes">
<AccessToken>{access_token}</AccessToken>
</GetOAuthV2Info>
Ottieni criterio per gli attributi del codice di autorizzazione

Esempio di criterio:

<GetOAuthV2Info name="GetAuthCodeAttributes">
 <AuthorizationCode ref="{variable_name}"/>
</GetOAuthV2Info>

Esempio di criterio:

<GetOAuthV2Info name="GetAuthCodeAttributes">
    <AuthorizationCode>{authorization_code}</AuthorizationCode>
</GetOAuthV2Info>
Ottieni criterio sugli attributi del token di aggiornamento

Esempio di criterio:

<GetOAuthV2Info name="GetTokenAttributes">
  <RefreshToken ref="{variable_name}"/>
</GetOAuthV2Info>

Esempio di criterio:

<GetOAuthV2Info name="GetTokenAttributes">
    <RefreshToken>{refresh_token}</RefreshToken>
</GetOAuthV2Info>

Variabili di flusso OAuth 1.0a

Le variabili di flusso definite in questa tabella vengono compilate quando i rispettivi criteri OAuth vengono e, di conseguenza, sono disponibili per altri criteri o applicazioni in esecuzione nel proxy API flusso di lavoro.

Genera criterio token di richiesta

Esempio di criterio:

<OAuthV1 name="GenerateRequestToken">
  <Operation>GenerateRequestToken</Operation>
</OAuthV1>

Variabili impostate dopo l'esito positivo:

  • oauth_token
  • oauth_token_secret
  • oauth_callback_confirmed
  • oauth_response
  • oauth_consumer_key
  • oauth_consumer_secret

Genera criterio per il token di accesso

Esempio di criterio:

<OAuthV1 name="GenerateAccessToken">
  <Operation>GenerateAccessToken</Operation>
</OAuthV1>

Variabili impostate dopo l'esito positivo:

  • oauth_token
  • oauth_token_secret
  • oauth_response
  • oauth_consumer_key
  • oauth_consumer_secret

Verifica dei token di accesso norme

Esempio di criterio:

<OAuthV1 name="VerifyAccessToken">
  <Operation>VerifyAccessToken</Operation>
</OAuthV1>

Variabili impostate dopo l'esito positivo:

  • oauth_token
  • oauth_token_secret
  • oauth_response
  • oauth_consumer_key
  • oauth_consumer_secret

Verifica criterio chiave API

Esempio di criterio:

<GetOAuthV1Info name="VerifyApiKey">
  <OAuthConfig>{config_name}</OAuthConfig>*
  <APIKey ref="{variable_name}" />
</GetOAuthV1Info>

* Facoltativo

Variabili impostate dopo l'esito positivo:

  • oauth_consumer_key
  • oauth_consumer_secret

Verifica i criteri relativi ai consumatori

Esempio di criterio:

<GetOAuthV1Info name="VerifyConsumer">
  <OAuthConfig>{config_name}</OAuthConfig>*
  <ConsumerKey ref="{variable_name}" />
</GetOAuthV1Info>

* Facoltativo

Variabili impostate dopo l'esito positivo:

  • oauth_consumer_key
  • oauth_consumer_secret

Verifica criterio token

Esempio di criterio:

<GetOAuthV1Info name="VerifyToken">
  <OAuthConfig>{config_name}</OAuthConfig>*
  <RequestToken ref="{variable_name}" />
</GetOAuthV1Info>

* Facoltativo

Variabili impostate dopo l'esito positivo:

  • oauth_token
  • oauth_token_secret