Esta página aplica-se ao Apigee e ao Apigee Hybrid.
Veja a documentação do
Apigee Edge.
Esta página é uma referência para cada recurso do Kubernetes suportado pelo Apigee Operator para Kubernetes. Salvo indicação específica como Opcional, todos os campos são obrigatórios.
APIProduct
| Campo | Descrição |
|---|---|
apiVersion
Tipo: |
apim.googleapis.com/v1
|
kind
Tipo: |
APIProduct
|
metadata
|
Consulte a documentação da API Kubernetes para ver os campos disponíveis em metadata.
|
spec
Tipo: APIProductSpec |
spec define o estado pretendido do APIProductSet.
|
APIProductSpec
| Campo | Descrição |
|---|---|
name
Tipo: |
O nome do produto API. |
approvalType
Tipo: |
Flag que especifica como as chaves da API são aprovadas para aceder às APIs definidas pelo produto de API.
Se for definido como manual, a chave do consumidor é gerada e devolvida como pending.
Neste caso, as chaves da API não funcionam até serem aprovadas explicitamente.
Se for definido como |
description
Tipo: |
Descrição do produto API. |
displayName
Tipo: |
Nome apresentado na IU ou no portal do programador aos programadores que se registam para aceder à API. |
analytics
Tipo: Analytics |
Define se devem ser recolhidas estatísticas para as operações associadas a este produto. |
enforcementRefs
Tipo: |
Matriz de recursos EnforcementRef a aplicar ao produto API. |
attributes
Tipo: |
Matriz de atributos que podem ser usados para expandir o perfil do produto da API predefinido com metadados específicos do cliente. |
EnforcementRef
| Campo | Descrição |
|---|---|
name
Tipo: |
O nome do recurso de destino. |
kind
Tipo: |
APIMExtensionPolicy
|
group
Tipo: |
O APIGroup para o operador APIM da Apigee, que é apim.googleapis.com.
|
namespace
Tipo: |
(Opcional) O espaço de nomes do referente. Quando não é especificado, o espaço de nomes local é inferido. |
Atributo
| Campo | Descrição |
|---|---|
name
Tipo: |
A chave do atributo. |
value
Tipo: |
O valor do atributo. |
APIOperationSet
| Campo | Descrição |
|---|---|
apiVersion
Tipo: |
apim.googleapis.com/v1
|
kind
Tipo: |
APIOperationSet
|
metadata
|
Consulte a documentação da API Kubernetes para ver os campos disponíveis em metadata.
|
spec
Tipo: APIOperationSetSpec |
Define o estado pretendido do APIOperationSet. |
APIOperationSetSpec
| Campo | Descrição |
|---|---|
quota
Tipo: Quota |
Definição de quota. |
restOperations
Tipo: |
Matriz de definições de RESTOperation. |
apiProductRefs
Tipo: |
Matriz de recursos APIProductRef ou referências a produtos da API onde as RESTOperations devem ser aplicadas. |
Quota
| Campo | Descrição |
|---|---|
limit
Tipo: |
Número de mensagens de pedido permitidas por app pelo produto API para o interval especificado
e timeUnit.
|
interval
Tipo: |
Intervalo de tempo durante o qual o número de mensagens de pedidos é calculado. |
timeUnit
Tipo: |
Unidade de tempo definida para o intervalo. Os valores válidos incluem minute, hour,
day ou month.
|
RESTOperation
| Campo | Descrição |
|---|---|
name
Tipo: |
O nome da operação REST. |
path
Tipo: |
Em combinação com methods, path é o caminho HTTP a corresponder a uma quota
e/ou a um produto API.
|
methods
Tipo: |
Em combinação com path, methods é a lista (como strings) de
métodos http aplicáveis a corresponder a uma quota
e/ou a um produto API.
|
APIProductRef
| Campo | Descrição |
|---|---|
name
Tipo: |
O nome do recurso de destino. |
kind
Tipo: |
APIProduct
|
group
Tipo: |
O APIGroup para o operador APIM da Apigee, que é apim.googleapis.com.
|
namespace
Tipo: |
(Opcional) O espaço de nomes do referente. Quando não é especificado, o espaço de nomes local é inferido. |
APIMExtensionPolicy
| Campo | Descrição |
|---|---|
apiVersion
Tipo: |
apim.googleapis.com/v1
|
kind
Tipo: |
APIMExtensionPolicy |
metadata
|
Consulte a documentação da API Kubernetes para ver os campos disponíveis em metadata.
|
spec
Tipo: APIMExtensionPolicySpec |
Define o estado pretendido de APIMExtensionPolicy. |
APIMExtensionPolicySpec
| Campo | Descrição |
|---|---|
apigeeEnv
|
(Opcional) Ambiente Apigee.
Se não for fornecido, é criado um novo ambiente e anexado a todas as instâncias disponíveis. Se for fornecido, este ambiente tem de estar associado a todas as instâncias disponíveis quando usar um equilibrador de carga global externo. |
failOpen
Tipo: |
Especifica se deve ou não falhar na abertura quando o tempo de execução do Apigee está inacessível.
Se estiver definido como true, as chamadas para o tempo de execução do Apigee são tratadas como bem-sucedidas, mesmo que o tempo de execução esteja inacessível.
|
timeout
Tipo: |
Especifica o período de limite de tempo antes de as chamadas para o tempo de execução do Apigee falharem, em segundos ou milissegundos.
Por exemplo, 10s.
|
targetRef
Tipo: ExtensionServerRef |
Identifica o gateway do Google Kubernetes Engine onde a extensão deve ser instalada. |
location
Tipo: |
Identifica a Google Cloud localização onde a APIMExtensionPolicy é aplicada. |
supportedEvents
Tipo: |
Especifica a lista de eventos do processador de extensões enviados para o Apigee. Estes incluem o seguinte:
|
ExtensionServerRef
| Campo | Descrição |
|---|---|
name
Tipo: |
O nome do recurso de destino. |
kind
Tipo: |
Especifica o kind do recurso de destino, por exemplo, Gateway ou Service.
|
group
Tipo: |
O APIGroup para o operador APIM da Apigee, que é apim.googleapis.com.
|
namespace
Tipo: |
(Opcional) O espaço de nomes do referente. Quando não é especificado, o espaço de nomes local é inferido. |
ApigeeGatewayPolicy
| Campo | Descrição |
|---|---|
apiVersion
Tipo: |
apim.googleapis.com/v1 |
kind
Tipo: |
ApigeeGatewayPolicy |
metadata
|
Consulte a documentação da API Kubernetes para ver os campos disponíveis em metadata.
|
spec
Tipo: ApigeeGatewayPolicySpec |
Define o estado pretendido de ApigeeGatewayPolicy. |
ApigeeGatewayPolicySpec
| Campo | Descrição |
|---|---|
refTipo: ExtensionServerRef |
Refere-se ao modelo de APIM criado para reger as políticas aplicadas ao GKE Gateway. |
targetRef
Tipo: ExtensionServerRef |
Refere-se à política de extensão da APIM que deve aplicar esta política de gateway específica. Refere-se indiretamente ao GKE Gateway. |
serviceAccount
|
(Opcional) Especifica a conta de serviço usada para gerar Google tokens de autorização num proxy do Apigee ProApigee. |
ApimTemplate
| Campo | Descrição |
|---|---|
apiVersion
Tipo: |
apim.googleapis.com/v1 |
kind
Tipo: |
ApimTemplate |
metadata
|
Consulte a documentação da API Kubernetes para ver os campos disponíveis em metadata.
|
spec
Tipo: ApimTemplateSpec |
Define o estado pretendido de ApimTemplate. |
ApimTemplateSpec
| Campo | Descrição |
|---|---|
templates
Tipo: |
Uma lista de recursos ApimTemplateFlow que especificam as políticas a executar no fluxo de pedidos. |
apimTemplateRule
Tipo: ExtensionServerRef |
Especifica a regra do modelo da APIM que deve ser usada para validar as políticas aplicadas. |
ApimTemplateFlow
| Campo | Descrição |
|---|---|
policies
Tipo: |
Uma lista de recursos ConditionalParameterReference que especificam a lista ordenada de políticas a serem executadas como parte do fluxo de pedidos. |
condition
Tipo: |
Especifica as condições para executar este recurso. |
ConditionalParameterReference
| Campo | Descrição |
|---|---|
condition
|
Especifica as condições para executar este recurso. |
ApimTemplateRule
| Campo | Descrição |
|---|---|
apiVersion
Tipo: |
apim.googleapis.com/v1 |
kind
Tipo: |
ApimTemplateRule |
metadata
|
Consulte a documentação da API Kubernetes para ver os campos disponíveis em metadata.
|
spec
Tipo: ApimTemplateRuleSpec |
Define o estado pretendido de ApimTemplateRule. |
ApimTemplateRuleSpec
| Campo | Descrição |
|---|---|
requiredList
|
A lista de políticas (como strings) que tem de estar presente no ApimTemplate.
|
denyList
|
A lista de políticas (como strings) que não devem estar presentes no ApimTemplate.
|
allowList
|
A lista de políticas (como strings) que podem estar presentes no ApimTemplate, mas não são obrigatórias.
|
override
Tipo: |
Substitui as atualizações à regra do modelo da APIM no caso de existirem modelos da APIM que usem a regra.
Os valores válidos são true ou false.
|
AssignMessage (injeção de tokenGoogle )
| Campo | Descrição |
|---|---|
apiVersion
Tipo: |
apim.googleapis.com/v1 |
kind
Tipo: |
AssignMessage |
metadata
|
Consulte a documentação da API Kubernetes para ver os campos disponíveis em metadata.
|
spec
Tipo: AssignMessageBean |
Define o estado pretendido da política AssignMessage. |
AssignMessageBean
| Campo | Descrição |
|---|---|
setActions
Tipo: |
Matriz de objetos SetActionsBean. Substitui os valores das propriedades existentes no pedido ou na resposta,
conforme especificado pelo elemento AssignTo.
Se os cabeçalhos ou os parâmetros já estiverem presentes na mensagem original, o |
AssignTo
Tipo: AssignToBean |
Especifica em que mensagem a política AssignMessage opera. As opções incluem o pedido, a resposta ou uma nova mensagem personalizada. |
SetActionsBean
| Campo | Descrição |
|---|---|
Authentication
Tipo: AuthenticationBean |
Gera tokens Google OAuth 2.0 ou OpenID Connect para fazer chamadas autenticadas para Google serviços ou serviços personalizados executados em determinados Google Cloud produtos, como funções do Cloud Run e o Cloud Run. |
AuthenticationBean
| Campo | Descrição |
|---|---|
GoogleAccessToken
Tipo: GoogleAccessTokenBean |
Gera tokens Google OAuth 2.0 para fazer chamadas autenticadas aos serviços Google. |
GoogleIDToken
Tipo: GoogleIDTokenBean |
Configuração para gerar um token OpenID Connect para autenticar o pedido de destino. |
headerName
Tipo: |
Por predefinição, quando existe uma configuração de autenticação, o Apigee gera um token de autorização e injeta-o no cabeçalho de autorização da mensagem enviada para o sistema de destino.
O elemento headerName permite-lhe especificar o nome de um cabeçalho diferente para conter o token de autorização.
|
GoogleAccessTokenBean
| Campo | Descrição |
|---|---|
scopes
Tipo: |
Matriz de strings que especifica um âmbito da API Google válido. Para mais informações, consulte o artigo Âmbitos do OAuth 2.0 para APIs Google.
|
LifetimeInSeconds
Tipo: |
Especifica a duração total do token de acesso em segundos. |
GoogleIDTokenBean
| Campo | Descrição |
|---|---|
Audience
Tipo: AudienceBean |
O público-alvo do token de autenticação gerado, como a API ou a conta de serviço com acesso concedido pelo token. |
IncludeEmail
Tipo: |
Se estiver definido como true, o token de autenticação gerado vai conter as reivindicações email e email_verified da conta de serviço.
|
AudienceBean
| Campo | Descrição |
|---|---|
useTargetHost
Tipo: |
Se o valor de Audience estiver vazio ou a variável ref não for resolvida para um valor válido e useTargetUrl for true, o URL do destino (excluindo quaisquer parâmetros de consulta) é usado como público-alvo.
|
useTargetUrl
Tipo: |
Por predefinição, useTargetUrl é false.
|
AssignToBean
| Campo | Descrição |
|---|---|
createNew
Tipo: |
Determina se a política cria uma nova mensagem quando atribui valores. Se estiver definida como true, a política cria uma nova mensagem.
|
type
Tipo: |
Especifica o tipo da nova mensagem quando CreateNew está definido como true verdadeiro.
Os valores válidos são request ou response.
|
JavaScript
| Campo | Descrição |
|---|---|
apiVersion
Tipo: |
apim.googleapis.com/v1 |
kind
Tipo: |
JavaScript |
metadata
|
Consulte a documentação da API Kubernetes para ver os campos disponíveis em metadata.
|
spec
Tipo: JavascriptBean |
Define o estado pretendido da política de JavaScript. |
JavascriptBean
| Campo | Descrição |
|---|---|
mode
Tipo: |
Matriz de strings que especifica ProxyRequest ou ProxyResponse. Determina se a política está
anexada ao fluxo de pedidos ou ao fluxo de respostas.
|
source
Tipo: |
Código JavaScript inline. |
timeLimit
Tipo: |
Especifica o limite de tempo para a execução do código JavaScript. |
KVM
| Campo | Descrição |
|---|---|
apiVersion
Tipo: |
apim.googleapis.com/v1 |
kind
Tipo: |
KVM |
metadata
|
Consulte a documentação da API Kubernetes para ver os campos disponíveis em metadata.
|
spec
|
Define o estado pretendido da política de KVM. |
KeyValueMapOperationsBean
| Campo | Descrição |
|---|---|
MapName
Tipo: |
Permite que a política identifique que KVM usar dinamicamente, no momento da execução. Para mais informações, consulte o elemento MapName. |
expiryTimeInSecs
Tipo: |
Especifica a duração em segundos após a qual o Apigee atualiza o respetivo valor em cache do KVM especificado. Para mais informações, consulte o elemento ExpiryTimeInSecs. |
initialEntries
Tipo: |
Valores de seed para KVMs, que são preenchidos no KVM quando é inicializado. Para mais informações, consulte o artigo Elemento InitialEntries. |
delete
Tipo: |
Elimina o par de chave/valor especificado do KVM. Para mais informações, consulte o artigo Elimine o elemento. |
get
Tipo: |
Recupera o valor de uma chave do KVM. Para mais informações, consulte Get element. |
OASValidation
| Campo | Descrição |
|---|---|
apiVersion
Tipo: |
apim.googleapis.com/v1 |
kind
Tipo: |
OASValidation |
metadata
|
Consulte a documentação da API Kubernetes para ver os campos disponíveis em metadata.
|
spec
Tipo: OASValidationBean |
Define o estado pretendido da política OASValidation. |
status
Tipo: ApimResourceStatus |
Mostra o estado da política de validação da OAS. |
OASValidationBean
| Campo | Descrição |
|---|---|
openApiSpec
Tipo: |
Especifica a especificação OpenAPI em yaml a ser validada. Como se trata de um fragmento de várias linhas
yaml, use o delimitador "|". |
source
Tipo: |
Uma das seguintes opções: message, request ou response. Quando definido como request,
avalia os pedidos recebidos das apps cliente; quando definido como response, avalia as respostas dos servidores de destino. Quando definido como message, avalia automaticamente o pedido
ou a resposta, consoante a política esteja anexada ao fluxo de pedidos ou de respostas. |
options
Tipo: |
Consulte OASValidationOptions/td> |
OASValidationOptions
| Campo | Descrição |
|---|---|
validateMessageBody
Tipo: |
Especifica se a política deve validar o corpo da mensagem em relação ao esquema do corpo do pedido da operação na especificação OpenAPI. Definido como true para validar o conteúdo do corpo da mensagem. Defina
como false para validar apenas se o corpo da mensagem existe. |
allowUnspecifiedParameters
Tipo: |
Consulte StrictOptions |
StrictOptions
| Campo | Descrição |
|---|---|
header
Tipo: |
Para permitir que os parâmetros do cabeçalho sejam especificados no pedido que não estão definidos na especificação OpenAPI, defina este parâmetro como true.
Caso contrário, defina este parâmetro como false para fazer com que a execução da política falhe. |
query
Tipo: |
Para permitir que os parâmetros de consulta sejam especificados no pedido e não estejam definidos na especificação OpenAPI,
defina este parâmetro como true. Caso contrário, defina este parâmetro como false
para fazer com que a execução da política falhe. |
cookie
Tipo: |
Para permitir que os parâmetros de cookies sejam especificados no pedido que não estão definidos na especificação OpenAPI,
defina este parâmetro como true. Caso contrário, defina este parâmetro como false para fazer com que a execução da política falhe. |
ApimResourceStatus
| Campo | Descrição |
|---|---|
currentState
Tipo: |
Mostra o estado atual do recurso:
|
errorMessage
Tipo: |
Mensagem de erro relacionada com um dos estados de falha do campo currentState. |
operationResult
Tipo: |
Uma string de resposta de uma das operações de longa duração relacionadas com a criação, a atualização ou a eliminação de recursos. |
ServiceCallout
| Campo | Descrição |
|---|---|
apiVersion
Tipo: |
apim.googleapis.com/v1 |
kind
Tipo: |
ServiceCallout |
metadata
|
Consulte a documentação da API Kubernetes para ver os campos disponíveis em metadata.
|
spec
Tipo: ServiceCalloutBean |
Define o estado pretendido da política ServiceCallout. |
status
Tipo: ApimResourceStatus |
Mostra o estado da política ServiceCallout. |
ServiceCalloutBean
| Campo | Descrição |
|---|---|
httpTargetConnection
Tipo: |
Fornece detalhes de transporte, como URL, TLS/SSL e propriedades HTTP. |
request
Tipo: CalloutRequest |
Especifica a variável que contém a mensagem de pedido enviada do proxy de API para o outro serviço. |
Response
Tipo: |
Especifica a variável que contém a mensagem de resposta devolvida ao proxy de API do serviço externo. |
HttpTargetConnection
| Campo | Descrição |
|---|---|
url
Tipo: |
O URL do serviço de destino. |
properties
Tipo: |
Propriedades de transporte HTTP para o serviço de back-end. Para mais informações, consulte o artigo Referência das propriedades de pontos finais. |
timeout
Tipo: |
O limite de tempo em milissegundos para o pedido de serviço. Para mais informações, consulte o artigo Limite de tempo. |
CalloutRequest
| Campo | Descrição |
|---|---|
url
Tipo: |
O URL do serviço de destino. |
properties
Tipo: |
Propriedades de transporte HTTP para o serviço de back-end. Para mais informações, consulte o artigo Referência das propriedades de pontos finais. |
SpikeArrest
| Campo | Descrição |
|---|---|
apiVersion
Tipo: |
apim.googleapis.com/v1 |
kind
Tipo: |
SpikeArrest |
metadata
|
Consulte a documentação da API Kubernetes para ver os campos disponíveis em metadata.
|
spec
Tipo: SpikeArrestBean |
Define o estado pretendido da política SpikeArrest. |
SpikeArrestBean
| Campo | Descrição |
|---|---|
mode
Tipo: |
Matriz de strings que especifica ProxyRequest ou ProxyResponse. Determina se a política está
anexada ao fluxo de pedidos ou ao fluxo de respostas.
|
peakMessageRate
Tipo: peakMessageRate |
Especifica a taxa de mensagens para o SpikeArrest. |
useEffectiveCount
Tipo: |
Se estiver definido como truetrue, o SpikeArrest é distribuído numa região, com as contagens de pedidos sincronizadas nos processadores de mensagens (MPs) do Apigee numa região.
Se estiver definido como |
peakMessageRate
| Campo | Descrição |
|---|---|
ref
Tipo: |
Variável que referencia o valor de rate.
|
value
Tipo: |
Valor rate real se não estiver disponível uma referência.
|
GenerateJWT
| Campo | Descrição |
|---|---|
apiVersion
Tipo: |
apim.googleapis.com/v1 |
kind
Tipo: |
GenerateJWT |
metadata
|
Consulte a documentação da API Kubernetes para ver os campos disponíveis em metadata.
|
spec
Tipo: GenerateJWTBean |
Define o estado pretendido da política GenerateJWT. |
status
Tipo: ApimResourceStatus |
Mostra o estado da política GenerateJWT. |
GenerateJWTBean
| Campo | Descrição |
|---|---|
subject
Tipo: PropertyBean |
Identifica o principal que é o assunto do JWT. Para mais informações, consulte o elemento Subject. |
issuer
Tipo: PropertyBean |
Identifica o principal que emitiu o JWT. Para mais informações, consulte o artigo Elemento Issuer. |
audience
Tipo: VarArrayBean |
Identifica os destinatários a quem se destina o JWT. Para mais informações, consulte o elemento Audience. |
id
Tipo: PropertyBean |
Especifica um identificador exclusivo para o JWT. Para mais informações, consulte o artigo Elemento ID. |
expiresIn
Tipo: PropertyBean |
Especifica a hora de validade do JWT. Para mais informações, consulte o elemento ExpiresIn. |
notBefore
Tipo: PropertyBean |
Identifica a hora antes da qual o JWT não deve ser aceite para processamento. Para mais informações, consulte o artigo Elemento NotBefore. |
additionalClaims
Tipo: AdditionalClaimsBean |
Especifica reivindicações adicionais a incluir no JWT. Para mais informações, consulte o elemento AdditionalClaims. |
compress
Tipo: |
Especifica se o payload do JWT deve ser comprimido. Para mais informações, consulte o artigo Comprimir elemento. |
PropertyBean
| Campo | Descrição |
|---|---|
value
Tipo: |
O valor literal da propriedade. |
ref
Tipo: |
Uma referência a uma variável que contém o valor da propriedade. |
VarArrayBean
| Campo | Descrição |
|---|---|
values
Tipo: |
Uma matriz de valores de strings literais. |
ref
Tipo: |
Uma referência a uma variável que contém a matriz de valores. |
AdditionalClaimsBean
| Campo | Descrição |
|---|---|
claims
Tipo: |
Um mapa de nomes de reivindicações para valores de reivindicações. |
ref
Tipo: |
Uma referência a uma variável que contém o mapa de reivindicações. |
OAuthV2
| Campo | Descrição |
|---|---|
apiVersion
Tipo: |
apim.googleapis.com/v1 |
kind
Tipo: |
OAuthV2 |
metadata
|
Consulte a documentação da API Kubernetes para ver os campos disponíveis em metadata.
|
spec
Tipo: OAuthV2Bean |
Define o estado pretendido da política OAuthV2. |
status
Tipo: ApimResourceStatus |
Mostra o estado da política OAuthV2. |
OAuthV2Bean
| Campo | Descrição |
|---|---|
operation
Tipo: |
A operação OAuthV2 a realizar. Os valores válidos são:
|
configRef
Tipo: |
(Opcional) Referência a um nome de recurso personalizado OAuthV2Config que contenha definições OAuthV2 reutilizáveis. |
scope
Tipo: |
O âmbito do token de acesso. Para mais informações, consulte o artigo Elemento Scope. |
generateResponse
Tipo: GenerateResponse |
Configura a geração de respostas. Para mais informações, consulte o artigo Elemento GenerateResponse. |
generateErrorResponse
Tipo: GenerateErrorResponse |
Configura a geração de respostas de erro. Para mais informações, consulte o artigo Elemento GenerateErrorResponse. |
expiresIn
Tipo: PropertyExpiryBean |
A hora de validade do token de acesso. Para mais informações, consulte o elemento ExpiresIn. |
refreshTokenExpiresIn
Tipo: PropertyExpiryBean |
A hora de validade do token de atualização. Para mais informações, consulte o elemento RefreshTokenExpiresIn. |
supportedGrantTypes
Tipo: |
Uma lista de tipos de concessão suportados. Para mais informações, consulte o elemento SupportedGrantTypes. |
redirectURI
Tipo: |
O URI de redirecionamento usado no tipo de concessão de código de autorização. Para mais informações, consulte o artigo Elemento RedirectUri. |
responseType
Tipo: |
O tipo de resposta para o tipo de concessão com código de autorização. Para mais informações, consulte o elemento ResponseType. |
clientID
Tipo: |
O ID de cliente. Para mais informações, consulte o elemento ClientId. |
state
Tipo: |
O parâmetro state para o tipo de concessão do código de autorização. Para mais informações, consulte o artigo Elemento State. |
appEndUser
Tipo: |
O ID do utilizador final. Para mais informações, consulte o artigo Elemento AppEndUser. |
code
Tipo: |
O código de autorização. Para mais informações, consulte o elemento code. |
userName
Tipo: |
O nome de utilizador para o tipo de concessão de palavra-passe. Para mais informações, consulte o artigo Elemento UserName. |
password
Tipo: |
A palavra-passe para o tipo de concessão de palavra-passe. Para mais informações, consulte o artigo Elemento de palavra-passe. |
grantType
Tipo: |
O tipo de concessão. Para mais informações, consulte o elemento GrantType. |
refreshToken
Tipo: |
O token de atualização. Para mais informações, consulte o elemento RefreshToken. |
accessToken
Tipo: |
A chave de acesso. Para mais informações, consulte o artigo Elemento AccessToken. |
cacheExpiryInSeconds
Tipo: PropertyExpiryBean |
O tempo de expiração da cache em segundos. Para mais informações, consulte o artigo Definições de expiração da cache. |
verifyAccessTokenPrefix
Tipo: |
(Opcional) Prefixo a usar ao validar um token de acesso. |
externalAuthorization
Tipo: |
Indica se deve ser usado um serviço de autorização externo. Para mais informações, consulte o artigo Elemento ExternalAuthorization. |
reuseRefreshToken
Tipo: |
Especifica se os tokens de atualização devem ser reutilizados. Para mais informações, consulte o artigo Elemento ReuseRefreshToken. |
rfcCompliance
Tipo: |
Impõe a conformidade com a RFC. Para mais informações, consulte o elemento RFCCompliantRequestResponse. |
enforceStrictCallbackURIEnforced
Tipo: |
(Opcional) Aplica a correspondência rigorosa do URI de callback. |
customAttributes
Tipo: |
Atributos personalizados a adicionar ao token. Para mais informações, consulte o artigo Elemento attributes. |
externalAccessToken
Tipo: |
Uma chave de acesso externa. Para mais informações, consulte o elemento ExternalAccessToken. |
externalRefreshToken
Tipo: |
Um token de atualização externo. Para mais informações, consulte o artigo Elemento ExternalRefreshToken. |
storeToken
Tipo: |
Especifica se o token deve ser armazenado. Para mais informações, consulte o elemento StoreToken. |
tokens
Tipo: |
Uma lista de tokens a invalidar. Para mais informações, consulte o elemento Tokens. |
algorithm
Tipo: |
O algoritmo usado para assinar o JWT. Para mais informações, consulte o elemento Algorithm. |
secretKey
Tipo: SecretKey |
A chave secreta usada para assinar o JWT. Para mais informações, consulte o artigo Elemento SecretKey. |
privateKey
Tipo: PrivateKey |
A chave privada usada para assinar o JWT. Para mais informações, consulte o elemento PrivateKey. |
publicKey
Tipo: PublicKey |
A chave pública usada para validar o JWT. Para mais informações, consulte o artigo Elemento PublicKey. |
GenerateResponse
| Campo | Descrição |
|---|---|
enabled
Tipo: |
Se for definida como true ou se o atributo enabled for omitido, a política gera e devolve uma resposta. |
format
Tipo: |
Uma de XML, FORM_PARAM. |
GenerateErrorResponse
| Campo | Descrição |
|---|---|
enabled
Tipo: |
Se for definida como true ou se o atributo enabled for omitido, a política gera e devolve uma resposta. |
format
Tipo: |
Uma de XML, FORM_PARAM. |
realm
Tipo: PropertyBean |
O domínio a devolver no cabeçalho WWW-Authenticate. |
PropertyExpiryBean
| Campo | Descrição |
|---|---|
value
Tipo: |
O valor literal da data de validade. |
ref
Tipo: |
Uma referência a uma variável que contém o valor de validade. |
CustomAttribute
| Campo | Descrição |
|---|---|
name
Tipo: |
O nome do atributo personalizado. |
ref
Tipo: |
Uma referência a uma variável que contém o valor do atributo. |
value
Tipo: |
O valor literal do atributo. |
SecretKey
| Campo | Descrição |
|---|---|
value
Tipo: PropertyBean |
Especifica a chave secreta usada para assinar o JWT. Para mais informações, consulte o artigo Elemento SecretKey. |
PrivateKey
| Campo | Descrição |
|---|---|
value
Tipo: PropertyBean |
Especifica a chave privada usada para assinar o JWT. Para mais informações, consulte o elemento PrivateKey. |
PublicKey
| Campo | Descrição |
|---|---|
value
Tipo: PropertyBean |
Especifica a chave pública usada para validar o JWT. Para mais informações, consulte o artigo Elemento PublicKey. |
Política ResponseCache
| Campo | Descrição |
|---|---|
apiVersion
Tipo: |
apim.googleapis.com/v1 |
kind
Tipo: |
ResponseCache |
metadata
|
Consulte a documentação da API Kubernetes para ver os campos disponíveis em metadata.
|
spec
Tipo: APIExtensionPolicySpec |
Define o estado pretendido de ResponseCache. |
ResponseCacheBean
| Campo | Descrição |
|---|---|
mode
Tipo: |
Especifica ProxyRequest ou ProxyResponse. Determina se a política está
anexada ao fluxo de pedidos ou ao fluxo de respostas.
|
cacheExpiry
Tipo: cacheExpiry |
Fornece o objeto cacheExpiry. |
cacheKey
Tipo: cacheKey |
Fornece o objeto cacheKey. |
cacheLookupTimeOut
type: |
Especifica o período de tempo limite de procura na cache. |
cacheResourceRef
type: |
Especifica o identificador do recurso de cache através de uma referência de variável. |
excludeErrorResponse
type: |
Esta política pode colocar em cache respostas HTTP com qualquer código de estado. Isto significa que as respostas de sucesso e de erro podem ser colocadas em cache, incluindo os códigos de estado 2xx e 3xx.
|
skipCacheLookupCondition
type: |
Define uma expressão que, se for avaliada como true no tempo de execução, especifica que a procura na cache deve ser ignorada e a cache deve ser atualizada
|
skipCachePopulationCondition
type: |
Define uma expressão que, se for avaliada como true no tempo de execução, especifica que a procura na cache deve ser ignorada e que a cache deve ser atualizada
no tempo de execução, especifica que uma gravação na cache deve ser ignorada.
|
useAcceptHeader
type: |
Defina como true para anexar valores dos cabeçalhos Accept de resposta à chave de cache da entrada de cache de resposta.
|
useResponseCacheHeaders
type: |
Defina como true para que os cabeçalhos de resposta HTTP sejam considerados ao definir o "tempo de vida" (TTL) da resposta na cache.
|
cacheExpiry
| Campo | Descrição |
|---|---|
expiryDate
Tipo: |
Especifica a data em que uma entrada da cache deve expirar. |
timeOfDay
Tipo: |
Especifica a hora do dia em que uma entrada da cache deve expirar. |
timeoutInSeconds
Tipo: |
Especifica o número de segundos após os quais uma entrada da cache deve expirar. |
cacheKey
| Campo | Descrição |
|---|---|
cacheKeyPrefix
Tipo: |
Especifica um valor a usar como prefixo da chave de cache. |
fragments
Tipo: |
Especifica um valor a incluir na chave da cache para criar um espaço de nomes para pedidos correspondentes a respostas em cache. |