Política do OAuthV2

Você está vendo a documentação da Apigee X.
Veja a documentação da Apigee Edge.

Ícone da política

Conteúdo

OAuthV2 é uma política multifacetada para executar operações do tipo de concessão OAuth 2.0. Essa é a política principal usada para configurar endpoints OAuth 2.0 na Apigee.

Dica: se você quer saber mais sobre o OAuth na Apigee, consulte a página inicial do OAuth. Ela fornece links para recursos, amostras, vídeos e muito mais.

Amostras

VerifyAccessToken

VerifyAccessToken

Essa configuração de política OAuthV2 (com a operação VerifyAccessToken) verifica se um token de acesso enviado à Apigee é válido. Quando essa operação de política é acionada, a Apigee procura um token de acesso válido na solicitação. Se o token de acesso for válido, a solicitação poderá continuar. Se inválido, todos os processamentos serão interrompidos e um erro será retornado na resposta. 

<OAuthV2 async="false" continueOnError="false" enabled="true" name="OAuth-v20-2">
    <DisplayName>OAuth v2.0 2</DisplayName>
    <Operation>VerifyAccessToken</Operation>
    <AccessTokenPrefix>Bearer</AccessTokenPrefix> <!-- Optional, default is Bearer -->
</OAuthV2>

OBSERVAÇÃO: só os tokens do portador do OAuth 2.0 são compatíveis. Tokens de código de autenticação de mensagens (MAC, na sigla em inglês) não são compatíveis.

Exemplo:

$ curl https://your_host_alias/weather/forecastrss?w=12797282 \
  -H "Authorization: Bearer ylSkZIjbdWybfsUQe9BqP0LH5Z"

Em que your_host_alias é um domínio aberto ao público usado para acessar suas APIs, conforme configurado na propriedade virtualhosts.hostAliases do arquivo de modificações. Consulte Especificar substituições de configuração.

Por padrão, a Apigee aceita tokens de acesso no cabeçalho Authorization com o prefixo Bearer. É possível alterar esse padrão com o elemento <AccessToken>.

GenerateAccessToken

Como gerar tokens de acesso

Para ver exemplos de como solicitar tokens de acesso para cada um dos tipos de concessão compatíveis, consulte Como solicitar tokens de acesso e códigos de autorização. O tópico inclui exemplos dessas operações:

GenerateAuthorizationCode

Gerar código de autorização

Para ver exemplos de como solicitar códigos de autorização, consulte Como solicitar um código de autorização.

RefreshAccessToken

Atualizar um token de acesso

Para exemplos de como solicitar tokens de acesso usando um token de atualização, consulte Como atualizar um token de acesso.

Token de fluxo de resposta

Gerar um token de acesso no fluxo de resposta

Às vezes, pode ser necessário gerar um token de acesso no fluxo de resposta. Por exemplo, é possível fazer isso em resposta a uma validação personalizada feita em um serviço de back-end. Neste exemplo, o caso de uso requer um token de acesso e um token de atualização, considerando o tipo de concessão implícito. Nesse caso, usaremos o tipo de concessão de senha para gerar o token. Como você verá, o truque para fazer isso funcionar é passar um cabeçalho de solicitação de autorização com uma política JavaScript.

Primeiro, vamos analisar a política de exemplo:

<OAuthV2 enabled="true" continueOnError="false" async="false" name="generateAccessToken">
    <Operation>GenerateAccessToken</Operation>
    <AppEndUser>Doe</AppEndUser>
    <UserName>jdoe</UserName>
    <PassWord>jdoe</PassWord>
    <GrantType>grant_type</GrantType>
    <ClientId>a_valid_client_id</ClientId>
    <SupportedGrantTypes>
        <GrantType>password</GrantType>
    </SupportedGrantTypes>
</OAuthV2>

Se você colocar essa política no fluxo de resposta, ela falhará com um erro 401 UnAuthorized, mesmo que os parâmetros de login corretos sejam especificados na política. Para resolver esse problema, é preciso definir um cabeçalho de solicitação de autorização.

O cabeçalho de autorização precisa conter um esquema de acesso básico com o client_id codificado em Base64:client_secret.

É possível adicionar esse cabeçalho com uma política JavaScript colocada antes da política OAuthV2, como esta. As variáveis de contexto "local_clientid" e "local_secret" precisam ser definidas e disponíveis anteriormente no fluxo:

var clientId = context.getVariable("local_clientid");
var clientSecret = context.getVariable("local_secret");
context.setVariable("request.header.Authorization","Basic "+ CryptoJS.enc.Base64.stringify(CryptoJS.enc.Latin1
                                      .parse(clientId + ':' + clientSecret)));

Veja também Como codificar credenciais básicas de autenticação.

Referência de elemento

A referência de política descreve os elementos e atributos da política OAuthV2.

A política de amostra mostrada abaixo é uma das configurações possíveis. Este exemplo mostra uma política do OAuthV2 configurada para a operação GenerateAccessToken. Ele inclui elementos obrigatórios e opcionais. Consulte as descrições dos elementos nesta seção para mais detalhes.

<OAuthV2 name="GenerateAccessToken">
  <!-- This policy generates an OAuth 2.0 access token using the client_credentials grant type -->
  <Operation>GenerateAccessToken</Operation>
  <!-- This is in millseconds, so expire in an hour -->
  <ExpiresIn>3600000</ExpiresIn>
  <SupportedGrantTypes>
    <GrantType>client_credentials</GrantType>
  </SupportedGrantTypes>
  <GrantType>request.queryparam.grant_type</GrantType>
  <GenerateResponse/>
</OAuthV2>

Atributos de <OAuthV2>

<OAuthV2 async="false" continueOnError="false" enabled="true" name="MyOAuthPolicy">

A tabela a seguir descreve atributos comuns a todos os elementos pai de políticas:

Atributo Descrição Padrão Presença
name

O nome interno da política. O valor do atributo name pode conter letras, números, espaços, hifens, sublinhados e pontos. Esse valor não pode exceder 255 caracteres.

Opcionalmente, use o elemento <DisplayName> para rotular a política no editor de proxy da IU de gerenciamento com um nome de linguagem natural diferente.

 N/A Obrigatório
continueOnError

Defina como false para retornar um erro quando uma política falhar. Esse é o comportamento esperado na maioria das políticas.

Defina como true para que a execução do fluxo continue, mesmo depois que uma política falhar.

 falso Opcional
enabled

Defina como true para aplicar a política.

Defina como false para desativar a política. A política não será aplicada mesmo se ela permanecer anexada a um fluxo.

 true Opcional
async

Esse atributo está obsoleto.

 falso Obsoleto

Elemento <DisplayName>

Use em conjunto com o atributo name para rotular a política no editor de proxy da IU de gerenciamento com um nome de linguagem natural diferente.

<DisplayName>Policy Display Name</DisplayName>
Padrão

N/A

Se você omitir esse elemento, será usado o valor do atributo name da política.
Presença Opcional
Tipo String

Elemento <AccessToken>

<AccessToken>request.header.access_token</AccessToken>

Por padrão, o VerifyAccessToken espera que o token de acesso seja enviado no cabeçalho Authorization. Você pode alterar esse padrão usando esse elemento. Por exemplo, request.queryparam.access_token indica que o token de acesso precisa estar presente como um parâmetro de consulta chamado access_token.

Exemplo em que <AccessToken>request.header.access_token</AccessToken> é especificado:

curl https://your_host_alias/oauth2/validate -H "access_token:Rft3dqrs56Blirls56a"

Exemplo em que <AccessToken>request.queryparam.access_token</AccessToken> é especificado:

curl "https://your_host_alias/oauth2/validate?access_token:Rft3dqrs56Blirls56a"

Em que your_host_alias é um domínio aberto ao público usado para acessar suas APIs, conforme configurado na propriedade virtualhosts.hostAliases do arquivo de modificações. Consulte Especificar substituições de configuração.

Padrão:

N/A

Presença:

Opcional
Tipo: String
Usado com operações:
  • VerifyAccessToken

Elemento <AccessTokenPrefix>

<AccessTokenPrefix>Bearer</AccessTokenPrefix>

Por padrão, o VerifyAccessToken espera que o token de acesso seja enviado no cabeçalho de autorização como um token do portador. Exemplo:

-H "Authorization: Bearer Rft3dqrs56Blirls56a"

Atualmente, o portador é o único prefixo compatível.

Padrão:

Portador

Presença:

Opcional
Tipo: String
Valores válidos:

Portador
Usado com operações:
  • VerifyAccessToken

Elemento <AppEndUser>

<AppEndUser>request.queryparam.app_enduser</AppEndUser>

Nos casos em que o ID do usuário final do aplicativo precisa ser enviado ao servidor de autorização, esse elemento permite especificar onde a Apigee deve procurar o ID do usuário final. Por exemplo, ele pode ser enviado como um parâmetro de consulta ou em um cabeçalho HTTP.

Por exemplo, request.queryparam.app_enduser indica que o AppEndUser precisa estar presente como um parâmetro de consulta, como, por exemplo, ?app_enduser=ntesla@theramin.com. Por exemplo, para exigir o AppEndUser em um cabeçalho HTTP, por exemplo, defina esse valor como request.header.app_enduser.

Fornecer essa configuração permite que você inclua um ID de usuário final do aplicativo no token de acesso. Esse recurso é útil se você quiser recuperar ou revogar tokens de acesso do OAuth 2.0 por ID do usuário final. Para mais informações, consulte Ativar a recuperação e a revogação de tokens de acesso do OAuth 2.0 por ID de usuário final, ID do aplicativo ou ambos.

Padrão:

N/A

Presença:

Opcional
Tipo: String
Valores válidos:

Qualquer variável de fluxo acessível para a política no tempo de execução.
Usado com tipos de concessão:
  • authorization_code
  • Implícito
  • senha
  • client_credentials

<Attributes/Attribute>

<Attributes>
    <Attribute name="attr_name1" ref="flow.variable" display="true|false">value1</Attribute>
    <Attribute name="attr_name2" ref="flow.variable" display="true|false">value2</Attribute>
</Attributes>

Use esse elemento para adicionar atributos personalizados a um token de acesso ou a códigos de autorização. Por exemplo, talvez você queira incorporar um ID de usuário ou identificador de sessão em um token de acesso que possa ser extraído e verificado no ambiente de execução.

Esse elemento permite especificar um valor em uma variável de fluxo ou de uma string literal. Se você especificar uma variável e uma string, o valor especificado na variável de fluxo será usado. Se a variável não puder ser resolvida, a string será o padrão.

Para mais informações sobre como usar esse elemento, consulte Como personalizar tokens e códigos de autorização.

Como exibir ou ocultar atributos personalizados na resposta

Lembre-se de que se você definir o elemento GenerateResponse dessa política como true, a representação JSON completa do token será retornada na resposta, incluindo todos os atributos personalizados que você definir. Em alguns casos, você pode ocultar alguns ou todos os atributos personalizados na resposta para que eles não fiquem visíveis para os apps clientes.

Por padrão, os atributos personalizados aparecem na resposta. Se quiser ocultá-los, defina o parâmetro display como false. Exemplo:

<Attributes>
    <Attribute name="employee_id" ref="employee.id" display="false"/>
    <Attribute name="employee_name" ref="employee.name" display="false"/>
</Attributes>

O valor do atributo display não é mantido. Digamos que você gere um token de acesso com atributos personalizados que quer ocultar na resposta gerada. A definição de display=false atinge essa meta. No entanto, se um novo token de acesso for gerado posteriormente usando um token de atualização, os atributos personalizados originais do token de acesso serão exibidos na resposta do token de atualização. Isso ocorre porque a Apigee não se lembra de que o atributo display foi definido originalmente como false na política de geração de tokens de acesso. O atributo personalizado é simplesmente parte dos metadados do token de acesso.

Você verá o mesmo comportamento se adicionar atributos personalizados a um código de autorização. Quando um token de acesso for gerado usando esse código, esses atributos personalizados serão exibidos na resposta do token de acesso. Novamente, esse pode não ser o comportamento esperado.

Para ocultar atributos personalizados nesses casos, você tem as seguintes opções:

  • Redefina explicitamente os atributos personalizados na política de tokens de atualização e defina a exibição deles como "false". Nesse caso, talvez seja necessário recuperar os valores personalizados originais do token de acesso original usando a política GetOAuthV2Info.
  • Use uma política JavaScript de pós-processamento para extrair manualmente quaisquer atributos personalizados que você não quer ver na resposta.

Consulte também Como personalizar tokens e códigos de autorização.

Padrão:

N/A

Presença:

Opcional
Valores válidos:
  • name -O nome do atributo
  • ref - O valor do atributo. Pode vir de uma variável de fluxo.
  • display - (opcional) permite especificar se os atributos personalizados aparecem ou não na resposta. Se for true, os atributos personalizados serão exibidos na resposta (se GenerateResponse também estiver ativado). Se false, os atributos personalizados não serão incluídos na resposta. O valor padrão é true. Consulte Como exibir ou ocultar atributos personalizados na resposta.
Usado com tipos de concessão:
  • authorization_code
  • Implícito
  • senha
  • client_credentials
  • refresh_token
  • Também pode ser usada com a operação GenerateAuthorizationCode.

Elemento <ClientId>

<ClientId>request.formparam.client_id</ClientId>

Em vários casos, o app cliente precisa enviar o ID do cliente para o servidor de autorização. Esse elemento permite especificar onde a Apigee precisa procurar o ID do cliente. O único local válido que você pode definir é o local padrão, a variável de fluxo request.formparam.client_id. Não é possível definir ClientId como nenhuma outra variável. Consulte também Como solicitar tokens de acesso e códigos de autorização.

Padrão:

request.formparam.client_id (um x-www-form-urlencoded e especificado no corpo da solicitação)

Presença:

Opcional
Tipo: String
Valores válidos: A variável de fluxo: request.formparam.client_id
Usado com tipos de concessão:
  • authorization_code
  • senha
  • Implícito
  • client_credentials

Também pode ser usada com a operação GenerateAuthorizationCode.

Elemento <Code>

<Code>request.queryparam.code</Code>

No fluxo de tipo de concessão de autorização, o cliente precisa enviar um código de autorização ao servidor de autorização (Apigee). Esse elemento permite especificar onde a Apigee deve procurar o código de autorização. Por exemplo, ele pode ser enviado como um parâmetro de consulta, um cabeçalho HTTP ou um parâmetro de formulário (o padrão).

A variável request.queryparam.auth_code indica que o código de autorização deve estar presente como um parâmetro de consulta, como, por exemplo, ?auth_code=AfGlvs9. Para exigir o código de autorização em um cabeçalho HTTP, por exemplo, defina esse valor como request.header.auth_code. Consulte também Como solicitar tokens de acesso e códigos de autorização.

Padrão:

request.formparam.code (um x-www-form-urlencoded e especificado no corpo da solicitação)

Presença:

opcional
Tipo: String
Valores válidos: Qualquer variável de fluxo acessível para a política no tempo de execução
Usado com tipos de concessão: authorization_code

Elemento <ExpiresIn>

<ExpiresIn>10000</ExpiresIn>

Aplica o tempo de expiração dos tokens de acesso e códigos de autorização em milissegundos. Para tokens de atualização, use <RefreshTokenExpiresIn>. O valor do tempo de expiração é um valor gerado pelo sistema mais o valor <ExpiresIn>. Se <ExpiresIn> for definido como -1, o token ou código expirará de acordo com a expiração máxima do token de acesso OAuth. Se <ExpiresIn> não for especificado, o sistema aplicará um valor padrão configurado no nível do sistema.

O tempo de expiração também pode ser definido no tempo de execução usando um valor padrão codificado ou referir-se a uma variável de fluxo. Por exemplo, você pode armazenar um valor de expiração de token em um mapa de chave-valor, recuperá-lo, atribuí-lo a uma variável e referenciá-lo na política. Por exemplo, kvm.oauth.expires_in.

A Apigee mantém as seguintes entidades em cache por pelo menos 180 segundos após serem acessadas.

  • Tokens de acesso do OAuth Isso significa que o elemento ExpiresIn na política do OAuth v2 não poderá expirar um token de acesso em menos de 180 segundos.
  • Entidades de serviço de gerenciamento de chaves (KMS) (apps, desenvolvedores, produtos de API).
  • Atributos personalizados em tokens OAuth e entidades KMS.

A estrofe a seguir especifica também uma variável de fluxo e um valor padrão. Observe que o valor da variável de fluxo tem precedência sobre o valor padrão especificado.

<ExpiresIn ref="kvm.oauth.expires_in">
    3600000 <!--default value in milliseconds-->
</ExpiresIn>

A Apigee não permite uma maneira de forçar a expiração de um token depois que ele foi criado. Se você precisar forçar a expiração de token (por exemplo, com base em uma condição), uma solução possível pode ser descrita nesta postagem da comunidade da Apigee.

Por padrão, os tokens de acesso expirados são limpos do sistema Apigee automaticamente três dias após a expiração. Consulte também Como limpar tokens de acesso

Padrão:

Se não for especificado, o sistema aplicará um valor padrão configurado no nível do sistema.

Presença:

Opcional
Tipo: Inteiro
Valores válidos:
  • Qualquer número inteiro positivo e não zero. Especifique o prazo de validade em milissegundos. Embora o valor desse elemento esteja em milissegundos, o valor definido na propriedade expires_in do token e na variável de fluxo expires_in é expresso em segundos.
  • -1 expirará de acordo com a expiração máxima do token de acesso OAuth.

    Observação: especificar qualquer outro número inteiro negativo ou zero causa um erro de implantação.
Usado com tipos de concessão:
  • authorization_code
  • Implícito
  • senha
  • client_credentials
  • refresh_token

Também usado com a operação GenerateAuthorizationCode.
.

Elemento <ExternalAccessToken>

<ExternalAccessToken>request.queryparam.external_access_token</ExternalAccessToken>

Informa à Apigee onde encontrar um token de acesso externo (um token de acesso não gerado pela Apigee).

A variável request.queryparam.external_access_token indica que o token de acesso externo precisa estar presente como um parâmetro de consulta, como, por exemplo, ?external_access_token=12345678. Para exigir o token de acesso externo em um cabeçalho HTTP, por exemplo, defina esse valor como request.header.external_access_token. Consulte também Como usar tokens OAuth de terceiros.

Elemento <ExternalAuthorization>

<ExternalAuthorization>true</ExternalAuthorization>

Se esse elemento for falso ou não presente, a Apigee validará client_id e client_secret normalmente em relação ao armazenamento de autorização da Apigee. Use esse elemento quando quiser trabalhar com tokens OAuth de terceiros. Para detalhes sobre como usar esse elemento, consulte Como usar tokens OAuth de terceiros.

Padrão:

falso

Presença:

Opcional
Tipo: Booleanos
Valores válidos: verdadeiro ou falso
Usado com tipos de concessão:
  • authorization_code
  • senha
  • client_credentials

Elemento <ExternalAuthorizationCode>

<ExternalAuthorizationCode>request.queryparam.external_auth_code</ExternalAuthorizationCode>

Informa à Apigee onde encontrar um código de autenticação externo (um código de autenticação não gerado pela Apigee).

A variável request.queryparam.external_auth_code indica que o código de autenticação externo deve estar presente como um parâmetro de consulta, como, por exemplo, ?external_auth_code=12345678. Para exigir o código de autenticação externo em um cabeçalho HTTP, por exemplo, defina esse valor como request.header.external_auth_code. Consulte também Como usar tokens OAuth de terceiros.

Elemento <ExternalRefreshToken>

<ExternalRefreshToken>request.queryparam.external_refresh_token</ExternalRefreshToken>

Informa à Apigee onde encontrar um token de atualização externo (um token de atualização não gerado pela Apigee).

A variável request.queryparam.external_refresh_token indica que o token de atualização externo precisa estar presente como um parâmetro de consulta, como, por exemplo, ?external_refresh_token=12345678. Para exigir o token de atualização externo em um cabeçalho HTTP, por exemplo, defina esse valor como request.header.external_refresh_token. Consulte também Como usar tokens OAuth de terceiros.

Elemento <GenerateResponse>

<GenerateResponse enabled='true'/>

Se definida como true, a política gerará e retornará uma resposta. Por exemplo, para GenerateAccessToken, a resposta pode ser como:

{
  "issued_at" : "1467841035013",
  "scope" : "read",
  "application_name" : "e31b8d06-d538-4f6b-9fe3-8796c11dc930",
  "refresh_token_issued_at" : "1467841035013",
  "status" : "approved",
  "refresh_token_status" : "approved",
  "api_product_list" : "[Product1, nhl_product]",
  "expires_in" : "1799",
  "developer.email" : "edward@slalom.org",
  "token_type" : "BearerToken",
  "refresh_token" : "rVSmm3QaNa0xBVFbUISz1NZI15akvgLJ",
  "client_id" : "Adfsdvoc7KX5Gezz9le745UEql5dDmj",
  "access_token" : "AnoHsh2oZ6EFWF4h0KrA0gC5og3a",
  "organization_name" : "cerruti",
  "refresh_token_expires_in" : "0",
  "refresh_count" : "0"
}

Se false, nenhuma resposta será enviada. Em vez disso, um conjunto de variáveis de fluxo é preenchido com valores relacionados à função da política. Por exemplo, uma variável de fluxo chamada oauthv2authcode.OAuthV2-GenerateAuthorizationCode.code é preenchida com o código de autenticação recém-criado. Observe que expires_in é expresso em segundos na resposta.

Padrão:

falso

Presença:

Opcional
Tipo: string
Valores válidos: verdadeiro ou falso
Usado com tipos de concessão:
  • Implícito
  • senha
  • client_credentials
  • refresh_token
  • Também pode ser usada com a operação GenerateAuthorizationCode.

Elemento <GenerateErrorResponse>

<GenerateErrorResponse enabled='true'/>

Se configurada como true, a política gerará e retornará uma resposta se o atributo ContinueOnError estiver definido como "true". Se false (o padrão), nenhuma resposta será enviada. Em vez disso, um conjunto de variáveis de fluxo é preenchido com valores relacionados à função da política.

Padrão:

falso

Presença:

Opcional
Tipo: string
Valores válidos: verdadeiro ou falso
Usado com tipos de concessão:
  • Implícito
  • senha
  • client_credentials
  • refresh_token
  • Também pode ser usada com a operação GenerateAuthorizationCode.

<GrantType>

<GrantType>request.queryparam.grant_type</GrantType>

Informa a política para encontrar o parâmetro de tipo de concessão que é transmitido em uma solicitação. De acordo com a especificação OAuth 2.0, o tipo de concessão precisa ser fornecido com solicitações de tokens de acesso e códigos de autorização. A variável pode ser um cabeçalho, um parâmetro de consulta ou um parâmetro de formulário (padrão).

Por exemplo, request.queryparam.grant_type indica que a senha precisa estar presente como um parâmetro de consulta, como, por exemplo, ?grant_type=password. Para exigir o tipo de concessão em um cabeçalho HTTP, por exemplo, defina esse valor como request.header.grant_type. Consulte também Como solicitar tokens de acesso e códigos de autorização.

Padrão:

request.formparam.grant_type (um x-www-form-urlencoded e especificado no corpo da solicitação)

Presença:

Opcional
Tipo: string
Valores válidos: Uma variável, conforme explicado acima.
Usado com tipos de concessão:
  • authorization_code
  • senha
  • Implícito
  • client_credentials
  • refresh_token

Elemento <Operation>

<Operation>GenerateAuthorizationCode</Operation>

A operação do OAuth 2.0 executada pela política.

Padrão:

Se <Operation> não for especificado, a Apigee analisará a lista de <SupportedGrantTypes>. Somente as operações nesses tipos de concessão serão bem-sucedidas. Em outras palavras, você pode omitir <Operation> se especificar um <GrantType> na lista <SupportedGrantTypes>. Se <Operation> e <SupportedGrantTypes> não forem especificados, o tipo de concessão padrão será authorization_code. Ou seja, as solicitações de tipo de concessão de autorização_codificarão, mas todas as outras falharão.

Presença:

Opcional
Tipo: String
Valores válidos:

Elemento <PassWord>

<PassWord>request.queryparam.password</PassWord>

Este elemento é usado apenas com o tipo de concessão de senha. Com o tipo de concessão de senha, as credenciais de usuário (senha e nome de usuário) precisam ser disponibilizadas à política de OAuthV2. Os elementos <PassWord> e <UserName> são usados para especificar variáveis em que a Apigee pode encontrar esses valores. Se esses elementos não forem especificados, a política espera encontrar os valores (por padrão) nos parâmetros do formulário chamados username e password. Se os valores não forem encontrados, a política emitirá um erro. É possível usar os elementos <PassWord> e <UserName> para referir-se a qualquer variável de fluxo que contenha as credenciais.

Por exemplo, é possível transmitir a senha em uma solicitação de token usando um parâmetro de consulta e definir o elemento da seguinte maneira: <PassWord>request.queryparam.password</PassWord>. Para exigir a senha em um cabeçalho HTTP, defina esse valor para request.header.password.

A política OAuthV2 não faz mais nada com esses valores de credenciais; A Apigee está apenas verificando se eles estão presentes. Cabe ao desenvolvedor da API recuperar a solicitação de valores e enviá-los para um provedor de identidade antes da execução da política de geração de tokens.

Consulte também Como solicitar tokens de acesso e códigos de autorização.

Padrão:

request.formparam.password (um x-www-form-urlencoded e especificado no corpo da solicitação)

Presença:

Opcional
Tipo: String
Valores válidos: Qualquer variável de fluxo disponível para a política no ambiente da execução.
Usado com tipos de concessão: senha

Elemento <RedirectUri>

<RedirectUri>request.queryparam.redirect_uri</RedirectUri>

Específica onde a Apigee deve procurar o parâmetro redirect_uri na solicitação.

Sobre URIs de redirecionamento

Os URIs de redirecionamento são usados com os códigos de autorização e os tipos de concessão implícitos. O URI de redirecionamento informa ao servidor de autorização (Apigee) para onde enviar um código de autorização (para o tipo de concessão de código de autenticação) ou token de acesso (para o tipo de concessão implícita). É importante entender quando esse parâmetro é obrigatório, quando ele é opcional e como ele é usado:

  • (obrigatório) Se um URL de callback for registrado no app de desenvolvedor associado às chaves de cliente da solicitação e se redirect_uri estiver presente na solicitação, os dois precisarão corresponder exatamente. Se não corresponderem, um erro será retornado. Para informações sobre como registrar aplicativos para desenvolvedores no Apigee e especificar um URL de retorno de chamada, consulte Registrar aplicativos e gerenciar chaves de API.

  • (opcional) Se um URL de uma chamada de retorno for registrado e o redirect_uri estiver ausente da solicitação, a Apigee redirecionará para o URL de callback registrado.
  • (obrigatório) Se um URL de chamada de retorno não estiver registrado, o redirect_uri será necessário. Nesse caso, a Apigee aceitará qualquer URL. Este caso pode apresentar um problema de segurança,e só deve ser usado com aplicativos clientes confiáveis. Se os aplicativos clientes não forem confiáveis, a prática recomendada é sempre exigir o registro de um URL de retorno de chamada.

É possível enviar esse parâmetro em um parâmetro de consulta ou em um cabeçalho. A variável request.queryparam.redirect_uri indica que o RedirectUri precisa estar presente como um parâmetro de consulta, como, por exemplo, ?redirect_uri=login.myapp.com. Para exigir o RedirectUri em um cabeçalho HTTP, por exemplo, defina esse valor como request.header.redirect_uri. Consulte também Como solicitar tokens de acesso e códigos de autorização.

Padrão:

request.formparam.redirect_uri (um x-www-form-urlencoded e especificado no corpo da solicitação)

Presença:

Opcional
Tipo: String
Valores válidos: Qualquer variável de fluxo acessível para a política no tempo de execução
Usado com tipos de concessão:
  • authorization_code
  • Implícito

Também usado com a operação GenerateAuthorizationCode.

Elemento <RefreshToken>

<RefreshToken>request.queryparam.refreshtoken</RefreshToken>

Ao solicitar um token de acesso usando um token de atualização, é necessário fornecer o token de atualização na solicitação. Esse elemento permite especificar onde a Apigee precisa procurar o token de atualização. Por exemplo, ele pode ser enviado como um parâmetro de consulta, um cabeçalho HTTP ou um parâmetro de formulário (o padrão).

A variável request.queryparam.refreshtoken indica que o token de atualização precisa estar presente como um parâmetro de consulta, como, por exemplo, ?refresh_token=login.myapp.com. Para exigir ou atualizar um cabeçalho HTTP, por exemplo, defina esse valor como request.header.refresh_token. Consulte também Como solicitar tokens de acesso e códigos de autorização.

Padrão:

request.formparam.refresh_token (um x-www-form-urlencoded e especificado no corpo da solicitação)

Presença:

Opcional
Tipo: String
Valores válidos: Qualquer variável de fluxo acessível para a política no tempo de execução
Usado com tipos de concessão:
  • refresh_token

Elemento <RefreshTokenExpiresIn>

<RefreshTokenExpiresIn>1000</RefreshTokenExpiresIn>

Aplica o tempo de expiração dos tokens de atualização em milissegundos. O valor do tempo de expiração é um valor gerado pelo sistema mais o valor de <RefreshTokenExpiresIn>. Se <RefreshTokenExpiresIn> for definido como -1, o token de atualização expirará de acordo com a expiração máxima do token de atualização OAuth. Se <RefreshTokenExpiresIn> não for especificado, o sistema aplicará um valor padrão configurado no nível do sistema. Entre em contato com o suporte da Apigee para mais informações sobre as configurações padrão do sistema.

O tempo de expiração também pode ser definido no tempo de execução usando um valor padrão codificado ou referir-se a uma variável de fluxo. Por exemplo, você pode armazenar um valor de expiração de token em um mapa de chave-valor, recuperá-lo, atribuí-lo a uma variável e referenciá-lo na política. Por exemplo, kvm.oauth.expires_in.

A estrofe a seguir especifica também uma variável de fluxo e um valor padrão. Observe que o valor da variável de fluxo tem precedência sobre o valor padrão especificado.

<RefreshTokenExpiresIn ref="kvm.oauth.expires_in">
    3600000 <!--default value in milliseconds-->
</RefreshTokenExpiresIn>

Padrão:

Se não for especificado, o sistema aplicará um valor padrão configurado no nível do sistema.

Presença:

Opcional
Tipo: Inteiro
Valores válidos:
  • Qualquer número inteiro positivo e não zero. Especifica o tempo de expiração em milissegundos.
  • -1 expirará de acordo com a expiração máxima do token de atualização OAuth.

    Observação: especificar qualquer outro número inteiro negativo ou zero causa um erro de implantação.
Usado com tipos de concessão:
  • authorization_code
  • senha
  • refresh_token

Elemento <ResponseType>

<ResponseType>request.queryparam.response_type</ResponseType>

Esse elemento informa à Apigee qual tipo de concessão o aplicativo cliente está solicitando. Ela é usada apenas com o código de autorização e fluxos de tipo de concessão implícito.

Por padrão, a Apigee procura o valor de tipo de resposta em um parâmetro de consulta response_type. Se você quiser modificar esse comportamento padrão, use o elemento <ResponseType> para configurar uma variável de fluxo contendo o valor do tipo de resposta. Por exemplo, se você definir esse elemento como request.header.response_type, o Apigee procurará o tipo de resposta a ser passado no cabeçalho da solicitação. Consulte também Como solicitar tokens de acesso e códigos de autorização.

Padrão:

request.formparam.response_type (a x-www-form-urlencoded and specified in the request body)

Presença:

Opcional. Use este elemento se quiser modificar o comportamento padrão.

Tipo: String
Valores válidos: code (para o tipo de concessão de código de autorização) ou token (para o tipo de concessão implícito)
Usado com tipos de concessão:
  • Implícito
  • Também usado com a operação GenerateAuthorizationCode.

Elemento <ReuseRefreshToken>

<ReuseRefreshToken>true</ReuseRefreshToken>

Quando definido como true, o token de atualização existente é reutilizado até que ele expire. Se for false, um novo token de atualização será emitido pela Apigee quando um token de atualização válido for apresentado.

Padrão:

false

Presença:

opcional
Tipo: boolean
Valores válidos:

true ou false
Usado com tipo de concessão:
  • refresh_token

Elemento <RFCCompliantRequestResponse>

<RFCCompliantRequestResponse>[true | false]</RFCCompliantRequestResponse>

Quando true, a política está em conformidade com os padrões RFC6749 e ativa os seguintes comportamentos compatíveis:

  • Respostas de erro e sem erros incluirão o campo de cabeçalho de resposta HTTP Cache-Control para obedecer ao RFC2616 (protocolo de transferência de hipertexto -- HTTP/1.1), com um valor de no-store em qualquer resposta que contenha tokens, credenciais ou outras informações confidenciais, bem como o campo de cabeçalho de resposta Pragma com um valor de no-cache.
  • A propriedade expires_in estará em formato alfanumérico. Para consistência, o refresh_token_expires_in também será alfanumérico.
  • As respostas OAuthV2 para geração de tokens incluirão o campo de cabeçalho Bearer compatível com RFC em vez de BearerToken.
  • As mensagens de erro em payloads de resposta estarão no formato: {"error" : "xxx", "error_description" :"yyy"} para erros de token de atualização.

Padrão:

false: por padrão, a política permite certos comportamentos não compatíveis com o RFC. Veja mais detalhes em Comportamento não compatível com o RFC. Defina esse elemento como true para ativar a conformidade com o RFC.

Presença:

Opcional
Tipo: Booleanos
Valores válidos: true ou false
Usado com tipos de concessão: Tudo

Elemento <Scope>

<Scope>request.queryparam.scope</Scope>

Se esse elemento estiver presente em uma das políticas GenerateAccessToken ou GenerateAuthorizationCode, ele será usado para especificar os escopos que serão concedidos ao token ou código. Normalmente, esses valores são transmitidos à política na solicitação de um app cliente. Você pode configurar o elemento para ter uma variável de fluxo, dando a opção de escolher como os escopos são passados em uma solicitação. No exemplo a seguir, request.queryparam.scope indica que o escopo deve estar presente como um parâmetro de consulta, por exemplo, ?scope=READ. Para exigir o escopo em um cabeçalho HTTP, por exemplo, defina esse valor como request.header.scope.

Se esse elemento aparecer em uma política "VerifyAccessToken", ele será usado para especificar quais escopos a política precisa aplicar. Nesse tipo de política, o valor precisa ser um nome de escopo "codificado". Não é possível usar variáveis. Exemplo:

<Scope>A B</Scope>

Consulte também Como trabalhar com escopos do OAuth2 e Como solicitar tokens de acesso e códigos de autorização.

Padrão:

Sem escopo

Presença:

Opcional
Tipo: String
Valores válidos:

Se usada com políticas Generate*, uma variável de fluxo.

Se usadA com VerifyAccessToken, uma lista separada por espaço de nomes de escopo (strings).
Usado com tipos de concessão:
  • authorization_code
  • Implícito
  • senha
  • client_credentials
  • Também pode ser usado com as operações GenerateAuthorizationCode e VerifyAccessToken.

Elemento <State>

<State>request.queryparam.state</State>

Nos casos em que o app cliente precisa enviar as informações de estado ao servidor de autorização, esse elemento permite especificar onde a Apigee deve procurar os valores de estado. Por exemplo, ele pode ser enviado como um parâmetro de consulta ou em um cabeçalho HTTP. O valor do estado normalmente é usado como uma medida de segurança para evitar ataques CSRF.

Por exemplo, request.queryparam.state indica que o estado deve estar presente como um parâmetro de consulta, como, por exemplo, ?state=HjoiuKJH32. Para exigir o estado em um cabeçalho HTTP, por exemplo, defina esse valor como request.header.state. Consulte também Como solicitar tokens de acesso e códigos de autorização.

Padrão:

Sem estado

Presença:

Opcional
Tipo: String
Valores válidos: Qualquer variável de fluxo acessível para a política no tempo de execução
Usado com tipos de concessão:
  • Todos
  • Também pode ser usada com a operação GenerateAuthorizationCode

Elemento <StoreToken>

 <StoreToken>true</StoreToken>

Defina esse elemento como true quando o elemento <ExternalAuthorization> for true. O elemento <StoreToken> instrui a Apigee a armazenar o token de acesso externo. Caso contrário, não será mantida.

Padrão:

falso

Presença:

Opcional
Tipo: Booleanos
Valores válidos: verdadeiro ou falso
Usado com tipos de concessão:
  • authorization_code
  • senha
  • client_credentials

Elemento <SupportedGrantTypes>/<GrantType>

<SupportedGrantTypes>
    <GrantType>authorization_code</GrantType>
    <GrantType>client_credentials</GrantType>
    <GrantType>implicit</GrantType>
    <GrantType>password</GrantType>
</SupportedGrantTypes>

Especifica os tipos de concessão compatíveis com um endpoint de token OAuth na Apigee. Um endpoint pode aceitar vários tipos de concessão, ou seja, um único endpoint pode ser configurado para distribuir tokens de acesso para vários tipos de concessão. Para mais informações sobre endpoints, consulte Noções básicas sobre endpoints do OAuth. O tipo de concessão é transmitido em solicitações de token em um parâmetro grant_type.

Se nenhum tipo de concessão compatível for especificado, os únicos tipos de concessão permitidos serão authorization_code e implicit. Veja também o elemento <GrantType>, que é um elemento de nível superior usado para especificar onde a Apigee deve procurar o parâmetro grant_type transmitido em um cliente. solicitação. A Apigee garantirá que o valor do parâmetro grant_type corresponda a um dos tipos de concessão compatíveis.

Padrão:

authorization _code e implícito

Presença:

Obrigatório
Tipo: String
Valores válidos:
  • client_credentials
  • authorization_code
  • senha
  • Implícito

Elemento <Tokens>/<Token>

Usado com as operações ValidateToken e InvalidateToken. Consulte também Como aprovar e revogar tokens de acesso. O elemento <Token> identifica a variável do fluxo que define a origem do token a ser revogado. Se os desenvolvedores precisarem enviar tokens de acesso como parâmetros de consulta chamados access_token, por exemplo, use request.queryparam.access_token.

Elemento <UserName>

<UserName>request.queryparam.user_name</UserName>

Este elemento é usado apenas com o tipo de concessão de senha. Com o tipo de concessão de senha, as credenciais de usuário (senha e nome de usuário) precisam ser disponibilizadas à política de OAuthV2. Os elementos <PassWord> e <UserName> são usados para especificar variáveis em que a Apigee pode encontrar esses valores. Se esses elementos não forem especificados, a política espera encontrar os valores (por padrão) nos parâmetros do formulário chamados username e password. Se os valores não forem encontrados, a política emitirá um erro. É possível usar os elementos <PassWord> e <UserName> para referir-se a qualquer variável de fluxo que contenha as credenciais.

Por exemplo, você pode passar o nome de usuário em um parâmetro de consulta e definir o elemento <UserName> como este: <UserName>request.queryparam.username</UserName>. Para exigir o nome de usuário em um cabeçalho HTTP, defina esse valor como request.header.username.

A política OAuthV2 não faz mais nada com esses valores de credenciais; A Apigee está apenas verificando se eles estão presentes. Cabe ao desenvolvedor da API recuperar a solicitação de valores e enviá-los para um provedor de identidade antes da execução da política de geração de tokens.

Consulte também Como solicitar tokens de acesso e códigos de autorização.

Padrão:

request.formparam.username (um x-www-form-urlencoded e especificado no corpo da solicitação)

Presença:

Opcional
Tipo: String
Valores válidos: Qualquer configuração de variável.
Usado com tipos de concessão: senha

Como verificar tokens de acesso

Quando um endpoint de token é configurado para um proxy de API, uma política OAuthV2 correspondente que especifica a operação VerifyAccessToken é anexada ao fluxo que expõe o recurso protegido.

Por exemplo, para garantir que todas as solicitações para uma API sejam autorizadas, a seguinte política impõe a verificação de token de acesso:

<OAuthV2 name="VerifyOAuthAccessToken">
  <Operation>VerifyAccessToken</Operation>
</OAuthV2>

A política está anexada ao recurso de API a ser protegido. Para garantir que todas as solicitações a uma API sejam verificadas, anexe a política ao PreFlow da solicitação ProxyEndpoint da seguinte maneira:

<PreFlow>
  <Request>
    <Step><Name>VerifyOAuthAccessToken</Name></Step>
  </Request>
</PreFlow>

Os seguintes elementos opcionais podem ser usados para substituir as definições padrão da operação VerifyAccessToken.

Nome Descrição
escopo

Uma lista de escopos delimitada por espaço. A verificação será bem-sucedida se pelo menos um dos escopos listados estiver presente no token de acesso. Por exemplo, a política a seguir verificará o token de acesso para garantir que ela contenha pelo menos um dos escopos listados. Se READ ou WRITE estiver presente, a verificação será bem-sucedida.


<OAuthV2 name="ValidateOauthScopePolicy">
  <Operation>VerifyAccessToken</Operation>
  <Scope>READ WRITE</Scope>
</OAuthV2>
AccessToken A variável onde se espera que o token de acesso esteja localizado. Por exemplo, request.queryparam.accesstoken. Por padrão, o token de acesso será apresentado pelo aplicativo no cabeçalho HTTP de autorização, de acordo com a especificação do OAuth 2.0. Use essa configuração se espera que o token de acesso seja apresentado em um local não padrão, como um parâmetro de consulta ou um cabeçalho HTTP com um nome diferente de Authorization.

Consulte também Como verificar tokens de acesso e Como solicitar tokens de acesso e códigos de autorização.

Como especificar locais de variáveis de solicitação

Para cada tipo de concessão, a política faz suposições sobre o local ou as informações necessárias em mensagens de solicitação. Essas suposições são baseadas na especificação do OAuth 2.0. Se os seus apps precisarem se desviar da especificação OAuth 2.0, especifique os locais esperados para cada parâmetro. Por exemplo, ao manipular um código de autorização, é possível especificar o local do código de autorização, o ID do cliente, o URI de redirecionamento e o escopo. Eles podem ser especificados como cabeçalhos HTTP, parâmetros de consulta ou parâmetros de formulário.

No exemplo abaixo, demonstramos como você pode especificar a localização dos parâmetros obrigatórios do código de autorização como cabeçalhos HTTP:

  ...
  <GrantType>request.header.grant_type</GrantType>
  <Code>request.header.code</Code>
  <ClientId>request.header.client_id</ClientId>
  <RedirectUri>request.header.redirect_uri</RedirectUri>
  <Scope>request.header.scope</Scope>
  ...

Ou, se necessário, para oferecer suporte à sua base de aplicativos cliente, você pode misturar e corresponder cabeçalhos e parâmetros de consulta:

  ...
  <GrantType>request.header.grant_type</GrantType>
  <Code>request.header.code</Code>
  <ClientId>request.queryparam.client_id</ClientId>
  <RedirectUri>request.queryparam.redirect_uri</RedirectUri>
  <Scope>request.queryparam.scope</Scope>
  ...

Só é possível configurar um local por parâmetro.

Variáveis de fluxo

As variáveis de fluxo definidas nesta tabela são preenchidas quando as respectivas políticas de OAuth são executadas e, portanto, estão disponíveis para outras políticas ou aplicativos em execução no fluxo de proxy da API.

Operação VerifyAccessToken

Quando a operação VerifyAccessToken é executada, um grande número de variáveis de fluxo é preenchido no contexto de execução do proxy. Essas variáveis fornecem propriedades relacionadas ao token de acesso, ao app do desenvolvedor, ao desenvolvedor e à empresa. Você pode usar uma política do AssignMessage ou JavaScript, por exemplo, para ler qualquer uma dessas variáveis e usá-las conforme necessário mais tarde no fluxo. Essas variáveis também podem ser úteis para fins de depuração.

Variáveis específicas de token

Variáveis Descrição
organization_name O nome da organização em que o proxy está sendo executado.
developer.id O ID do desenvolvedor associado ao app cliente registrado.
developer.app.name O nome do desenvolvedor associado ao app cliente registrado.
client_id O ID do cliente do aplicativo cliente registrado.
grant_type O tipo de concessão associado à solicitação.
token_type O tipo de token associado à solicitação.
access_token O token de acesso que está sendo verificado.
accesstoken.{custom_attribute} Um atributo personalizado nomeado no token de acesso.
issued_at A data em que o token de acesso foi emitido, expresso no horário de era Unix em milissegundos.
expires_in O prazo de validade do token de acesso. Expresso em segundos. Embora o elemento ExpiresIn defina a validade em milissegundos, nas variáveis de fluxo e resposta do token, o valor é expressado em segundos.
status O status do token de acesso (por exemplo, aprovado ou revogado).
scope O escopo (se houver) associado ao token de acesso.
apiproduct.<custom_attribute_name> Um atributo personalizado nomeado do produto da API associado ao aplicativo cliente registrado.
apiproduct.name O nome do produto da API associado ao aplicativo cliente registrado.
revoke_reason

(Somente híbridos da Apigee) Indica por que o token de acesso foi revogado.

O valor pode ser REVOKED_BY_APP, REVOKED_BY_ENDUSER, REVOKED_BY_APP_ENDUSER, ou TOKEN_REVOKED.

Variáveis específicas do aplicativo

Essas variáveis estão relacionadas ao app do desenvolvedor associado ao token.

Variáveis Descrição
app.name
app.id
app.accessType
app.callbackUrl
app.status aprovado ou revogado
app.scopes
app.appFamily
app.apiproducts
app.appParentStatus
app.appType Por exemplo: desenvolvedor
app.appParentId
app.created_by
app.created_at
app.last_modified_at
app.last_modified_by
app.{custom_attributes} Um atributo personalizado nomeado do app cliente registrado.

Variáveis específicas de desenvolvedor

Se o app.appType for "Company", os atributos da empresa serão preenchidos e se app.appType for "Developer", os atributos do desenvolvedor serão preenchidos.

Variáveis Descrição
Variáveis específicas de desenvolvedor
developer.id
developer.userName
developer.firstName
developer.lastName
developer.email
developer.status ativo ou inativo
developer.apps
developer.created_by
developer.created_at
developer.last_modified_at
developer.last_modified_by
developer.{custom_attributes} Um atributo personalizado nomeado do desenvolvedor.

Variáveis específicas da empresa

Se o app.appType for "Company", os atributos da empresa serão preenchidos e se app.appType for "Developer", os atributos do desenvolvedor serão preenchidos.

Variáveis Descrição
company.id
company.displayName
company.apps
company.appOwnerStatus
company.created_by
company.created_at
company.last_modified_at
company.last_modified_by
company.{custom_attributes} Um atributo personalizado nomeado da empresa.

Operação GenerateAuthorizationCode

Essas variáveis são definidas quando a operação GenerateAuthorizationCode é executada com êxito:

Prefixo: oauthv2authcode.{policy_name}.{variable_name}

Exemplo: oauthv2authcode.GenerateCodePolicy.code

Variável Descrição
code O código de autorização gerado quando a política é executada.
redirect_uri O URI de redirecionamento associado ao aplicativo cliente registrado.
scope O escopo opcional do OAuth transmitido na solicitação do cliente.
client_id ID do cliente passado na solicitação do cliente

Operações GenerateAccessToken e RefreshAccessToken operations

Essas variáveis são definidas quando as operações GenerateAccessToken e RefreshAccessToken são executadas com êxito. As variáveis de token de atualização não se aplicam ao fluxo de tipo de credencial do cliente.

Prefixo: oauthv2accesstoken.{policy_name}.{variable_name}

Exemplo: oauthv2accesstoken.GenerateTokenPolicy.access_token

Nome da variável Descrição
access_token O token de acesso gerado.
client_id O ID do cliente do aplicativo de desenvolvedor associado a este token.
expires_in O valor de expiração do token. Consulte o elemento <ExpiresIn> para detalhes. Na resposta, expires_in é expresso em segundos.
scope Lista dos escopos disponíveis configurados para o token. Consulte Como trabalhar com escopos do OAuth2.
status approved ou revoked.
token_type Está definida como BearerToken.
developer.email O endereço de e-mail do desenvolvedor registrado que é proprietário do app de desenvolvedor associado ao token.
organization_name A organização em que o proxy é executado.
api_product_list Uma lista dos produtos associados ao aplicativo de desenvolvedor correspondente do token.
refresh_count
refresh_token O token de atualização gerado. Observe que os tokens de atualização não são gerados para o tipo de concessão de credenciais do cliente.
refresh_token_expires_in A vida útil do token de atualização, em segundos.
refresh_token_issued_at Esse valor de tempo é a representação de string da quantidade de carimbo de data/hora correspondente de 32 bits. Por exemplo, "Quarta-feira, 21 de agosto de 2013 19:16:47 UTC" corresponde ao valor de carimbo de data/hora 1377112607413.
refresh_token_status approved ou revoked.

GenerateAccessTokenImplicitGrant

Essas variáveis são definidas quando a operação GenerateAccessTokenImplicit é executada com êxito para o fluxo de tipo de concessão implícita.

Prefixo: oauthv2accesstoken.{policy_name}.{variable_name}

Exemplo: oauthv2accesstoken.RefreshTokenPolicy.access_token

Variável Descrição
oauthv2accesstoken.access_token O token de acesso gerado quando a política é executada.
oauthv2accesstoken.{policy_name}.expires_in O valor de expiração do token, em segundos. Consulte o elemento <ExpiresIn> para detalhes.

Referência de erros

Esta seção descreve os códigos de falha e as mensagens de erro que são retornadas e as variáveis de falha definidas pela Apigee quando essa política aciona um erro. Essas informações são importantes para saber se você está desenvolvendo regras de falha para lidar com falhas. Para saber mais, consulte O que você precisa saber sobre erros de política e Como lidar com falhas.

Erros de execução

Esses erros podem ocorrer quando a política é executada.

Código de falha Status HTTP Causa Lançada por operações
steps.oauth.v2.access_token_expired 401 O token de acesso expirou.

VerifyAccessToken
InvalidateToken
steps.oauth.v2.access_token_not_approved 401 O token de acesso foi revogado. VerifyAccessToken
steps.oauth.v2.apiresource_doesnot_exist 401 O recurso solicitado não existe nos produtos de API associados ao token de acesso. VerifyAccessToken
steps.oauth.v2.FailedToResolveAccessToken 500 A política esperada encontrou um token de acesso em uma variável especificada no elemento <AccessToken>, mas não foi possível resolver a variável. GenerateAccessToken
steps.oauth.v2.FailedToResolveAuthorizationCode 500 A política esperada encontrou um código de autorização em uma variável especificada no elemento <Code>, mas não foi possível resolver a variável. GenerateAuthorizationCode
steps.oauth.v2.FailedToResolveClientId 500 A política esperada encontra o ID do cliente em uma variável especificada no elemento <ClientId>, mas não foi possível resolver a variável. GenerateAccessToken
GenerateAuthorizationCode
GenerateAccessTokenImplicitGrant
RefreshAccessToken
steps.oauth.v2.FailedToResolveRefreshToken 500 A política esperada encontrou um token de atualização em uma variável especificada no elemento <RefreshToken>, mas não foi possível resolver a variável. RefreshAccessToken
steps.oauth.v2.FailedToResolveToken 500 A política esperada encontrou um token em uma variável especificada no elemento <Tokens>, mas não foi possível resolver a variável.

ValidateToken
InvalidateToken
steps.oauth.v2.InsufficientScope 403 O token de acesso apresentado na solicitação tem um escopo que não corresponde ao escopo especificado na política de verificação de tokens de acesso. Para saber mais sobre o escopo, consulte Como trabalhar com escopos do OAuth2. VerifyAccessToken
steps.oauth.v2.invalid_access_token 401 O token de acesso enviado do cliente é inválido. VerifyAccessToken
steps.oauth.v2.invalid_client 401

Esse nome de erro é retornado quando a propriedade <GenerateResponse> da política é definida como verdadeira e o ID do cliente enviado na solicitação é inválido. Verifique se você está usando os valores corretos de secret e de chave do cliente do app para o app do desenvolvedor associado ao seu proxy. Normalmente, esses valores são enviados como um cabeçalho de autorização básica codificado em Base64.

 GenerateAccessToken
RefreshAccessToken
steps.oauth.v2.invalid_request 400 Esse nome é usado para vários tipos diferentes de erro, geralmente para parâmetros ausentes ou incorretos enviados na solicitação. Se <GenerateResponse> estiver definido como false, use variáveis de falha (descritas abaixo) para recuperar detalhes sobre o erro, como o nome e a causa da falha. GenerateAccessToken
GenerateAuthorizationCode
GenerateAccessTokenImplicitGrant
RefreshAccessToken
steps.oauth.v2.InvalidAccessToken 401 O cabeçalho de autorização não tem a palavra Bearer, que é obrigatória. Por exemplo: Authorization: Bearer your_access_token VerifyAccessToken
steps.oauth.v2.InvalidAPICallAsNo\
steps.oauth.v2.ApiProductMatchFound		 401

O proxy da API não está no produto associado ao token de acesso.

Dicas: verifique se o produto associado ao token de acesso está configurado corretamente. Por exemplo, se você usar caracteres curinga em caminhos de recursos, verifique se os caracteres curinga estão sendo usados corretamente. Consulte os detalhes em Como gerenciar produtos da API.

Consulte também Verificação do token de acesso do Oauth2.0 gera um erro "Chamada de API inválida como nenhuma correspondência de apiproduct encontrada" para ver detalhes sobre as causas desse erro.

 VerifyAccessToken
steps.oauth.v2.InvalidClientIdentifier 500

Esse nome de erro é retornado quando a propriedade <GenerateResponse> da política é definida como falsa e o ID do cliente enviado na solicitação é inválido. Verifique se você está usando os valores corretos de secret e de chave do cliente do app para o app do desenvolvedor associado ao seu proxy. Normalmente, esses valores são enviados como um cabeçalho de autorização básica codificado em Base64.

GenerateAccessToken
RefreshAccessToken
steps.oauth.v2.InvalidParameter 500 A política precisa especificar um token de acesso ou um código de autorização, mas não ambos. GenerateAuthorizationCode
GenerateAccessTokenImplicitGrant
steps.oauth.v2.InvalidTokenType 500 O elemento <Tokens>/<Token> requer que você especifique o tipo de token (por exemplo, refreshtoken). Se o cliente transmitir o tipo errado, esse erro será gerado. ValidateToken
InvalidateToken
steps.oauth.v2.MissingParameter 500 O tipo de resposta é token, mas nenhum tipo de concessão é especificado. GenerateAuthorizationCode
GenerateAccessTokenImplicitGrant
steps.oauth.v2.UnSupportedGrantType 500

O cliente especificou um tipo de concessão que não é compatível com a política (não listada no elemento <SupportedGrantTypes>).

 GenerateAccessToken
GenerateAuthorizationCode
GenerateAccessTokenImplicitGrant
RefreshAccessToken

Erros na implantação

Esses erros podem ocorrer quando você implanta um proxy que contém esta política.

Nome do erro Causa
InvalidValueForExpiresIn

Para o elemento <ExpiresIn>, os valores válidos são números inteiros positivos e -1.
InvalidValueForRefreshTokenExpiresIn Para o elemento <RefreshTokenExpiresIn>, os valores válidos são números inteiros positivos e -1.
InvalidGrantType Um tipo de concessão inválido é especificado no elemento <SupportedGrantTypes>. Consulte a referência da política para ver uma lista de tipos válidos.
ExpiresInNotApplicableForOperation Verifique se as operações especificadas no elemento <Operations> são compatíveis com a expiração. Por exemplo, a operação VerifyToken não é.
RefreshTokenExpiresInNotApplicableForOperation Verifique se as operações especificadas no elemento <Operations> são compatíveis com a expiração do token de atualização. Por exemplo, a operação VerifyToken não.
GrantTypesNotApplicableForOperation Verifique se os tipos de concessão especificados em <SupportedGrantTypes> são compatíveis com a operação especificada.
OperationRequired

Especifique uma operação nessa política usando o elemento <Operation>.
InvalidOperation

Especifique uma operação válida nesta política usando o elemento <Operation>.
TokenValueRequired Especifique um valor de token <Token> no elemento <Tokens>.

Variáveis de falha

Essas variáveis são definidas quando essa política aciona um erro no ambiente de execução.

Variáveis Onde Exemplo
fault.name="fault_name" fault_name é o nome da falha, conforme listado na tabela Erros de ambiente de execução acima. O nome da falha é a última parte do código de falha. fault.name = "invalid_request"
oauthV2.policy_name.failed policy_name é o nome da política especificada pelo usuário que gerou a falha. oauthV2.GenerateAccesstoken.failed = true
oauthV2.policy_name.fault.name policy_name é o nome da política especificada pelo usuário que gerou a falha. oauthV2.GenerateAccesstoken.fault.name = invalid_request
oauthV2.policy_name.fault.cause policy_name é o nome da política especificada pelo usuário que gerou a falha. oauthV2.GenerateAccesstoken.cause = Required param : grant_type

Exemplo de resposta de erro

Essas respostas serão enviadas de volta ao cliente se o elemento <GenerateResponse> for verdadeiro.

Se <GenerateResponse> for verdadeiro, a política retornará erros nesse formato para operações que geram tokens e códigos. Para uma lista completa, consulte a Referência de resposta de erro HTTP do OAuth.

{"ErrorCode" : "invalid_client", "Error" :"ClientId is Invalid"}

Se <GenerateResponse> for verdadeiro, a política retornará erros nesse formato para verificar e validar operações. Para uma lista completa, consulte a Referência de resposta de erro HTTP do OAuth.

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

Exemplo de regra de falha

<FaultRule name=OAuthV2 Faults">
    <Step>
        <Name>AM-InvalidClientResponse</Name>
        <Condition>(fault.name = "invalid_client") OR (fault.name = "InvalidClientIdentifier")</Condition>
    </Step>
    <Step>
        <Name>AM-InvalidTokenResponse</Name>
        <Condition>(fault.name = "invalid_access_token")</Condition>
    </Step>
    <Condition>(oauthV2.failed = true) </Condition>
</FaultRule>

Esquema de política

Cada tipo de política é definido por um esquema XML (.xsd). Para referência, os esquemas de política estão disponíveis no GitHub.

Os tokens no Storage são criptografados com hash

Se você estiver usando a Apigee híbrida ou a Apigee X, os tokens de acesso e os tokens de atualização do OAuthV2 serão criptografados com hash por padrão quando armazenados no banco de dados do ambiente de execução do Cassandra. O hash impede que os tokens sejam usados se o banco de dados estiver comprometido.

Como trabalhar com a configuração padrão do OAuth

Todas as organizações (até mesmo uma organização de avaliação gratuita) na Apigee são provisionadas com um endpoint de token OAuth. O endpoint é pré-configurado com políticas no proxy de API chamado oauth. É possível começar a usar o endpoint de token assim que criar uma conta na Apigee. Para detalhes, consulte Noções básicas sobre os endpoints do OAuth.

Como limpar tokens de acesso

Por padrão, os tokens OAuth2 são eliminados do sistema Apigee três dias (259.200 segundos) depois que o token de acesso e o token de atualização (se houver) tiverem expirado. Em alguns casos, é possível alterar esse padrão. Por exemplo, é possível encurtar o tempo de limpeza para economizar espaço em disco se um grande número de tokens estiver sendo gerado.

Comportamento não compatível com a RFC

Por padrão, a política OAuthV2, com a operação GenerateAccessToken, retorna uma resposta de token que contém determinadas propriedades não compatíveis com o RFC. A tabela a seguir mostra as propriedades não compatíveis retornadas pela política OAuthV2 e as propriedades compatíveis correspondentes.

O OAuthV2 retorna: A propriedade em conformidade com a RFC é:
"token_type":"BearerToken" "token_type":"Bearer"
"expires_in":"3600" "expires_in":3600

O valor em conformidade é um número, não uma string.

Além disso, a resposta de erro de um token de atualização expirado quando grant_type = refresh_token é:

{"ErrorCode" : "invalid_request", "Error" :"Refresh Token expired"}

No entanto, a resposta compatível com RFC é:

{"error" : "invalid_grant", "error_description" :"refresh token expired"}

Temas relacionados