Referencia del recurso de Kubernetes del operador de Apigee

Esta página se aplica a Apigee y Apigee Hybrid.

Consulta la documentación de Apigee Edge.

En esta página, se proporciona una referencia para cada recurso de Kubernetes que admite el operador de Apigee para Kubernetes. A menos que se indique específicamente que son opcionales, todos los campos son obligatorios.

APIProduct

Campo Descripción
apiVersion

Tipo: string

apim.googleapis.com/v1
kind

Tipo: string

APIProduct
metadata

Tipo: Kubernetes meta/v1.ObjectMeta

Consulta la documentación de la API de Kubernetes para conocer los campos disponibles en metadata.
spec

Tipo: APIProductSpec

spec define el estado deseado del APIProductSet.

APIProductSpec

Campo Descripción
name

Tipo: string

Es el nombre del producto de API.
approvalType

Tipo: string

Es una marca que especifica cómo se aprueban las claves de API para acceder a las APIs definidas por el producto de API. Si se establece en manual, la clave del consumidor se genera y se devuelve como pending. En este caso, las claves de API no funcionarán hasta que se aprueben de forma explícita.

Si se establece en auto, la clave del consumidor se genera y se devuelve como approved, y se puede usar de inmediato.

description

Tipo: string

Descripción del producto de API.
displayName

Tipo: string

Es el nombre que se muestra en la IU o en el portal para desarrolladores a los desarrolladores que se registran para obtener acceso a la API.
analytics

Tipo: Analytics

Define si se deben recopilar estadísticas para las operaciones asociadas a este producto.
enforcementRefs

Tipo: Array

Es un array de recursos EnforcementRef que se aplicarán al producto de API.
attributes

Tipo: Array

Es un array de atributos que se pueden usar para extender el perfil predeterminado del producto de la API con metadatos específicos del cliente.

EnforcementRef

Campo Descripción
name

Tipo: string

Es el nombre del recurso de destino.
kind

Tipo: string

APIMExtensionPolicy
group

Tipo: string

APIGroup para el operador de APIM de Apigee, que es apim.googleapis.com.
namespace

Tipo: string

Es el espacio de nombres del referente (opcional). Cuando no se especifica, se infiere el espacio de nombres local.

Atributo

Campo Descripción
name

Tipo: string

Es la clave del atributo.
value

Tipo: string

Es el valor del atributo.

APIOperationSet

Campo Descripción
apiVersion

Tipo: string

apim.googleapis.com/v1
kind

Tipo: string

APIOperationSet
metadata

Tipo: Kubernetes meta/v1.ObjectMeta

Consulta la documentación de la API de Kubernetes para conocer los campos disponibles en metadata.
spec

Tipo: APIOperationSetSpec

Define el estado deseado del objeto APIOperationSet.

APIOperationSetSpec

Campo Descripción
quota

Tipo: Quota

Es la definición de la cuota.
restOperations

Tipo: Array

Es un array de definiciones de RESTOperation.
apiProductRefs

Tipo: Array

Es un array de recursos APIProductRef o referencias a productos de API en los que se deben aplicar los RESTOperations.

Cuota

Campo Descripción
limit

Tipo: integer

Cantidad de mensajes de solicitud permitidos por app por el producto de API para los interval y timeUnit especificados.
interval

Tipo: integer

Es el intervalo de tiempo durante el que se calcula la cantidad de mensajes de solicitud.
timeUnit

Tipo: string

Unidad de tiempo definida para el intervalo. Los valores válidos incluyen minute, hour, day o month.

RESTOperation

Campo Descripción
name

Tipo: string

Nombre de la operación de REST.
path

Tipo: string

En combinación con methods, path es la ruta de acceso HTTP que se debe hacer coincidir para una cuota o un producto de API.
methods

Tipo: array

En combinación con path, methods es la lista (como strings) de los métodos HTTP aplicables que se deben coincidir para una cuota o para un producto de API.

APIProductRef

Campo Descripción
name

Tipo: string

Es el nombre del recurso de destino.
kind

Tipo: string

APIProduct
group

Tipo: string

APIGroup para el operador de APIM de Apigee, que es apim.googleapis.com.
namespace

Tipo: string

Es el espacio de nombres del referente (opcional). Cuando no se especifica, se infiere el espacio de nombres local.

APIMExtensionPolicy

Campo Descripción
apiVersion

Tipo: string

apim.googleapis.com/v1
kind

Tipo: string

APIMExtensionPolicy
metadata

Tipo: Kubernetes meta/v1.ObjectMeta

Consulta la documentación de la API de Kubernetes para conocer los campos disponibles en metadata.
spec

Tipo: APIMExtensionPolicySpec

Define el estado deseado de APIMExtensionPolicy.

APIMExtensionPolicySpec

Campo Descripción
apigeeEnv (Opcional) Es el entorno de Apigee.

Si no se proporciona, se crea un entorno nuevo y se conecta a todas las instancias disponibles.

Si se proporciona, este entorno debe adjuntarse a todas las instancias disponibles cuando se usa un balanceador de cargas externo global.

failOpen

Tipo: boolean

Especifica si se debe abrir en caso de falla cuando no se puede acceder al tiempo de ejecución de Apigee. Si se establece en true, las llamadas al entorno de ejecución de Apigee se tratarán como exitosas, incluso si no se puede acceder al entorno de ejecución.
timeout

Tipo: string

Especifica el período de tiempo de espera antes de que fallen las llamadas al tiempo de ejecución de Apigee, en segundos o milisegundos. Por ejemplo, 10s.
targetRef

Tipo: ExtensionServerRef

Identifica la puerta de enlace de Google Kubernetes Engine en la que se debe instalar la extensión.
location

Tipo: string

Identifica la ubicación Google Cloud en la que se aplica APIMExtensionPolicy.
supportedEvents

Tipo: List de eventos

Especifica la lista de eventos del procesador de extensiones que se envían a Apigee. Estas incluyen las siguientes:
  • "REQUEST_HEADERS"
  • "RESPONSE_HEADERS"
  • "REQUEST_BODY" (Vista previa)
  • "RESPONSE_BODY" (Vista previa)
  • "REQUEST_TRAILERS"
  • "RESPONSE_TRAILERS"

ExtensionServerRef

Campo Descripción
name

Tipo: string

Es el nombre del recurso de destino.
kind

Tipo: string

Especifica el kind del recurso de destino, por ejemplo, Gateway o Service.
group

Tipo: string

APIGroup para el operador de APIM de Apigee, que es apim.googleapis.com.
namespace

Tipo: string

Es el espacio de nombres del referente (opcional). Cuando no se especifica, se infiere el espacio de nombres local.

ApigeeGatewayPolicy

Campo Descripción
apiVersion

Tipo: string

apim.googleapis.com/v1
kind

Tipo: string

ApigeeGatewayPolicy
metadata

Tipo: Kubernetes meta/v1.ObjectMeta

Consulta la documentación de la API de Kubernetes para conocer los campos disponibles en metadata.
spec

Tipo: ApigeeGatewayPolicySpec

Define el estado deseado de ApigeeGatewayPolicy.

ApigeeGatewayPolicySpec

Campo Descripción
ref

Tipo: ExtensionServerRef

Hace referencia a la plantilla de APIM creada para regir las políticas aplicadas a la puerta de enlace de GKE.
targetRef

Tipo: ExtensionServerRef

Hace referencia a la política de extensión de APIM que debe aplicar esta política específica de Gateway. Se refiere indirectamente a la puerta de enlace de GKE.
serviceAccount (Opcional) Especifica la cuenta de servicio que se usa para generar tokens de autorización de Google en un proxy de Apigee ProApigee.

ApimTemplate

Campo Descripción
apiVersion

Tipo: string

apim.googleapis.com/v1
kind

Tipo: string

ApimTemplate
metadata

Tipo: Kubernetes meta/v1.ObjectMeta

Consulta la documentación de la API de Kubernetes para conocer los campos disponibles en metadata.
spec

Tipo: ApimTemplateSpec

Define el estado deseado de ApimTemplate.

ApimTemplateSpec

Campo Descripción
templates

Tipo: list

Es una lista de recursos ApimTemplateFlow que especifican las políticas que se ejecutarán en el flujo de la solicitud.
apimTemplateRule

Tipo: ExtensionServerRef

Especifica la regla de plantilla de APIM que se debe usar para validar las políticas aplicadas.

ApimTemplateFlow

Campo Descripción
policies

Tipo: list ConditionalParameterReference

Es una lista de recursos ConditionalParameterReference que especifican la lista ordenada de políticas que se ejecutarán como parte del flujo de la solicitud.
condition

Tipo: string

Especifica las condiciones para ejecutar este recurso.

ConditionalParameterReference

Campo Descripción
condition

Type: string

Especifica las condiciones para ejecutar este recurso.

ApimTemplateRule

Campo Descripción
apiVersion

Tipo: string

apim.googleapis.com/v1
kind

Tipo: string

ApimTemplateRule
metadata

Tipo: Kubernetes meta/v1.ObjectMeta

Consulta la documentación de la API de Kubernetes para conocer los campos disponibles en metadata.
spec

Tipo: ApimTemplateRuleSpec

Define el estado deseado de ApimTemplateRule.

ApimTemplateRuleSpec

Campo Descripción
requiredList Lista de políticas (como strings) que deben estar presentes en ApimTemplate.
denyList Lista de políticas (como strings) que no deberían estar presentes en ApimTemplate.
allowList Es la lista de políticas (como strings) que pueden estar presentes en ApimTemplate, pero no son obligatorias.
override

Tipo: boolean

Anula las actualizaciones de la regla de plantilla de APIM en caso de que existan plantillas de APIM que usen la regla. Los valores válidos son true o false.

AssignMessage (inyección de tokenGoogle )

Campo Descripción
apiVersion

Tipo: string

apim.googleapis.com/v1
kind

Tipo: string

AssignMessage
metadata

Tipo: Kubernetes meta/v1.ObjectMeta

Consulta la documentación de la API de Kubernetes para conocer los campos disponibles en metadata.
spec

Tipo: AssignMessageBean

Define el estado deseado de la política AssignMessage.

AssignMessageBean

Campo Descripción
setActions

Tipo: array

Es un array de objetos SetActionsBean. Reemplaza los valores de las propiedades existentes en la solicitud o respuesta, según lo especifica el elemento AssignTo.

Si los encabezados o parámetros ya están presentes en el mensaje original, setActions reemplaza los valores. De lo contrario, setActions agrega encabezados o parámetros nuevos según lo especificado.

AssignTo

Tipo: AssignToBean

Especifica en qué mensaje opera la política AssignMessage. Las opciones incluyen la solicitud, la respuesta o un nuevo mensaje personalizado.

SetActionsBean

Campo Descripción
Authentication

Tipo: AuthenticationBean

Genera tokens de Google OAuth 2.0 o OpenID Connect para realizar llamadas autenticadas a Google servicios o servicios personalizados que se ejecutan en ciertos Google Cloud productos, como las funciones de Cloud Run y Cloud Run.

AuthenticationBean

Campo Descripción
GoogleAccessToken

Tipo: GoogleAccessTokenBean

Genera tokens de Google OAuth 2.0 para realizar llamadas autenticadas a los servicios de Google.
GoogleIDToken

Tipo: GoogleIDTokenBean

Es la configuración para generar un token de OpenID Connect y autenticar la solicitud de destino.
headerName

Tipo: string

De forma predeterminada, cuando hay una configuración de autenticación, Apigee genera un token del portador y lo inserta en el encabezado de autorización del mensaje enviado al sistema de destino. El elemento headerName te permite especificar el nombre de un encabezado diferente para contener el token del portador.

GoogleAccessTokenBean

Campo Descripción
scopes

Tipo: array

Es un array de strings que especifica un permiso de API de Google válido. Si deseas obtener más información, consulta Permisos de OAuth 2.0 para las APIs de Google.
LifetimeInSeconds

Tipo: integer

Especifica la duración del token de acceso en segundos.

GoogleIDTokenBean

Campo Descripción
Audience

Tipo: AudienceBean

Es el público del token de autenticación generado, como la API o la cuenta de servicio a la que el token otorga acceso.
IncludeEmail

Tipo: boolean

Si se configura como true, el token de autenticación generado contendrá las reclamaciones de cuenta de servicio email y email_verified.

AudienceBean

Campo Descripción
useTargetHost

Tipo: string

Si el valor de Audience está vacío o si la variable ref no se resuelve en un valor válido, y useTargetUrl es true, la URL del destino (excluyendo cualquier parámetro de consulta) se usa como público.
useTargetUrl

Tipo: boolean

El valor predeterminado de useTargetUrl es false.

AssignToBean

Campo Descripción
createNew

Tipo: boolean

Determina si la política crea un mensaje nuevo cuando asigna valores. Si se configura como true, la política crea un mensaje nuevo.
type

Tipo: string

Especifica el tipo de mensaje nuevo, cuando CreateNew se establece en true verdadero. Los valores válidos son request o response.

JavaScript

Campo Descripción
apiVersion

Tipo: string

apim.googleapis.com/v1
kind

Tipo: string

JavaScript
metadata

Tipo: Kubernetes meta/v1.ObjectMeta

Consulta la documentación de la API de Kubernetes para conocer los campos disponibles en metadata.
spec

Tipo: JavascriptBean

Define el estado deseado de la política de JavaScript.

JavascriptBean

Campo Descripción
mode

Tipo: array

Es un array de strings que especifica ProxyRequest o ProxyResponse. Determina si la política se adjunta al flujo de solicitud o al flujo de respuesta.
source

Tipo: string

Es código JavaScript intercalado.
timeLimit

Tipo: integer

Especifica el tiempo de espera para la ejecución del código JavaScript.

KVM

Campo Descripción
apiVersion

Tipo: string

apim.googleapis.com/v1
kind

Tipo: string

KVM
metadata

Tipo: Kubernetes meta/v1.ObjectMeta

Consulta la documentación de la API de Kubernetes para conocer los campos disponibles en metadata.
spec

Tipo: KeyValueMapOperationsBean

Define el estado deseado de la política de KVM.

KeyValueMapOperationsBean

Campo Descripción
MapName

Tipo: MapName

Habilita la política para identificar qué KVM se usará dinámicamente en el entorno de ejecución. Para obtener más información, consulta el elemento MapName.
expiryTimeInSecs

Tipo: integer

Especifica la duración en segundos a partir de la cual Apigee actualiza su valor almacenado en caché del KVM especificado. Para obtener más información, consulta el elemento ExpiryTimeInSecs.
initialEntries

Tipo: list

Valores iniciales de KVM, que se propagan en el KVM cuando se inicializa. Para obtener más información, consulta el elemento InitialEntries.
delete

Tipo: list de Delete

Borra el par clave-valor especificado del KVM. Para obtener más información, consulta Borra un elemento.
get

Tipo: list de Get

Recupera el valor de una clave del KVM. Para obtener más información, consulta Elemento Get.

OASValidation

Campo Descripción
apiVersion

Tipo: string

apim.googleapis.com/v1
kind

Tipo: string

OASValidation
metadata

Tipo: Kubernetes meta/v1.ObjectMeta

Consulta la documentación de la API de Kubernetes para conocer los campos disponibles en metadata.
spec

Tipo: OASValidationBean

Define el estado deseado de la política OASValidation.
status

Tipo: ApimResourceStatus

Muestra el estado de la política OASValidation.

OASValidationBean

Campo Descripción
openApiSpec

Tipo: string

Especifica la especificación de OpenAPI en yaml que se validará. Como se trata de un fragmento yaml de varias líneas, usa el delimitador "|".
source

Tipo: string

Es uno de los siguientes: message, request o response. Cuando se establece en request, evaluará las solicitudes entrantes de las apps cliente; cuando se establece en response, evaluará las respuestas de los servidores de destino. Cuando se configura como message, evaluará automáticamente la solicitud o la respuesta según si la política se adjunta al flujo de solicitud o de respuesta.
options

Tipo: OASValidationOptions

Consulta OASValidationOptions.

OASValidationOptions

Campo Descripción
validateMessageBody

Tipo: boolean

Especifica si la política debe validar el cuerpo del mensaje en el esquema del cuerpo de la solicitud de la operación en la Especificación de OpenAPI. Se establece en true para validar el contenido del cuerpo del mensaje. Se configura en false para validar solo que el cuerpo del mensaje exista.
allowUnspecifiedParameters

Tipo: StrictOptions

Consulta StrictOptions.

StrictOptions

Campo Descripción
header

Tipo: boolean

Para permitir que se especifiquen parámetros de encabezado en la solicitud que no se definen en la Especificación de OpenAPI, configura este parámetro en true. De lo contrario, establece este parámetro en false para que falle la ejecución de la política.
query

Tipo: boolean

Para permitir que los parámetros de búsqueda se especifiquen en la solicitud que no están definidos en la Especificación de OpenAPI, configura este parámetro en true. De lo contrario, establece este parámetro en false para que falle la ejecución de la política.
cookie

Tipo: boolean

Para permitir que los parámetros de cookies se especifiquen en la solicitud que no se definen en la Especificación de OpenAPI, configura este parámetro en true. De lo contrario, establece este parámetro en false para que falle la ejecución de la política.

ApimResourceStatus

Campo Descripción
currentState

Tipo: enum

Muestra el estado actual del recurso:
  • RUNNING = El recurso está en estado de ejecución.
  • CREATING = Se está creando el recurso
  • CREATED = Se creó el recurso
  • UPDATING = Se está actualizando el recurso
  • DELETING = Se está borrando el recurso
  • CREATE_UPDATE_FAILED = Error en la operación de creación o actualización
  • DELETE_FAILED = No se pudo realizar la operación de eliminación
errorMessage

Tipo: string

Es un mensaje de error relacionado con uno de los estados de falla del campo currentState.
operationResult

Tipo: string

Es una cadena de respuesta de una de las operaciones de larga duración relacionadas con la creación, actualización o eliminación de recursos.

ServiceCallout

Campo Descripción
apiVersion

Tipo: string

apim.googleapis.com/v1
kind

Tipo: string

ServiceCallout
metadata

Tipo: Kubernetes meta/v1.ObjectMeta

Consulta la documentación de la API de Kubernetes para conocer los campos disponibles en metadata.
spec

Tipo: ServiceCalloutBean

Define el estado deseado de la política ServiceCallout.
status

Tipo: ApimResourceStatus

Muestra el estado de la política ServiceCallout.

ServiceCalloutBean

Campo Descripción
httpTargetConnection

Tipo: HttpTargetConnection

Proporciona detalles del transporte, como las URL, TLS/SSL y las propiedades de HTTP.
request

Tipo: CalloutRequest

Especifica la variable que contiene el mensaje de la solicitud que se envía desde el proxy de API al otro servicio.
Response

Tipo: string

Especifica la variable que contiene el mensaje de respuesta que se devuelve al proxy de API desde el servicio externo.

HttpTargetConnection

Campo Descripción
url

Tipo: string

Es la URL del servicio de destino.
properties

Tipo: Map of <string, string>

Propiedades de transporte HTTP al servicio de backend Para obtener más información, consulta Referencia de propiedades de extremos.
timeout

Tipo: int

Es el tiempo de espera en milisegundos para la llamada de servicio. Para obtener más información, consulta timeout.

CalloutRequest

Campo Descripción
url

Tipo: string

Es la URL del servicio de destino.
properties

Tipo: Map of <string, string>

Propiedades de transporte HTTP al servicio de backend Para obtener más información, consulta Referencia de propiedades de extremos.

SpikeArrest

Campo Descripción
apiVersion

Tipo: string

apim.googleapis.com/v1
kind

Tipo: string

SpikeArrest
metadata

Tipo: Kubernetes meta/v1.ObjectMeta

Consulta la documentación de la API de Kubernetes para conocer los campos disponibles en metadata.
spec

Tipo: SpikeArrestBean

Define el estado deseado de la política de SpikeArrest.

SpikeArrestBean

Campo Descripción
mode

Tipo: array

Es un array de strings que especifica ProxyRequest o ProxyResponse. Determina si la política se adjunta al flujo de solicitud o al flujo de respuesta.
peakMessageRate

Tipo: peakMessageRate

Especifica la tasa de mensajes para SpikeArrest.
useEffectiveCount

Tipo: boolean

Si se configura como truetrue, SpikeArrest se distribuye en una región, y los recuentos de solicitudes se sincronizan entre los procesadores de mensajes (MP) de Apigee en una región.

Si se configura como false, SpikeArrest usa un algoritmo de bucket de tokens de forma local. Para obtener más información, consulta UseEffectiveCount.

peakMessageRate

Campo Descripción
ref

Tipo: string

Variable que hace referencia al valor rate.
value

Tipo: string

Valor de rate real si no hay una referencia disponible.

GenerateJWT

Campo Descripción
apiVersion

Tipo: string

apim.googleapis.com/v1
kind

Tipo: string

GenerateJWT
metadata

Tipo: Kubernetes meta/v1.ObjectMeta

Consulta la documentación de la API de Kubernetes para conocer los campos disponibles en metadata.
spec

Tipo: GenerateJWTBean

Define el estado deseado de la política GenerateJWT.
status

Tipo: ApimResourceStatus

Muestra el estado de la política de GenerateJWT.

GenerateJWTBean

Campo Descripción
subject

Tipo: PropertyBean

Identifica el principal que es el asunto del JWT. Para obtener más información, consulta Elemento subject.
issuer

Tipo: PropertyBean

Identifica la entidad principal que emitió el JWT. Para obtener más información, consulta Elemento Issuer.
audience

Tipo: VarArrayBean

Identifica a los destinatarios para los que está destinado el JWT. Para obtener más información, consulta Elemento Audience.
id

Tipo: PropertyBean

Especifica un identificador único para el JWT. Para obtener más información, consulta Elemento Id.
expiresIn

Tipo: PropertyBean

Especifica la fecha y hora de vencimiento del JWT. Para obtener más información, consulta el elemento ExpiresIn.
notBefore

Tipo: PropertyBean

Identifica la fecha y hora antes de las cuales no se debe aceptar el JWT para su procesamiento. Para obtener más información, consulta el elemento NotBefore.
additionalClaims

Tipo: AdditionalClaimsBean

Especifica reclamaciones adicionales para incluir en el JWT. Para obtener más información, consulta Elemento AdditionalClaims.
compress

Tipo: boolean

Especifica si se debe comprimir la carga útil del JWT. Para obtener más información, consulta Comprimir elemento.

PropertyBean

Campo Descripción
value

Tipo: string

Es el valor literal de la propiedad.
ref

Tipo: string

Es una referencia a una variable que contiene el valor de la propiedad.

VarArrayBean

Campo Descripción
values

Tipo: array de string

Es un array de valores de cadena literal.
ref

Tipo: string

Es una referencia a una variable que contiene el array de valores.

AdditionalClaimsBean

Campo Descripción
claims

Tipo: map de string a string

Es un mapa de nombres de reclamos y valores de reclamos.
ref

Tipo: string

Es una referencia a una variable que contiene el mapa de reclamos.

OAuthV2

Campo Descripción
apiVersion

Tipo: string

apim.googleapis.com/v1
kind

Tipo: string

OAuthV2
metadata

Tipo: Kubernetes meta/v1.ObjectMeta

Consulta la documentación de la API de Kubernetes para conocer los campos disponibles en metadata.
spec

Tipo: OAuthV2Bean

Define el estado deseado de la política OAuthV2.
status

Tipo: ApimResourceStatus

Muestra el estado de la política de OAuthV2.

OAuthV2Bean

Campo Descripción
operation

Tipo: enum

Operación de OAuthV2 que se realizará. Los valores válidos son los siguientes:
  • GenerateAuthorizationCode
  • GenerateAccessToken
  • GenerateAccessTokenImplicitGrant
  • GenerateJWTAccessTokenImplicitGrant
  • GenerateJWTAccessToken
  • RefreshAccessToken
  • RefreshJWTAccessToken
  • VerifyAccessToken
  • VerifyJWTAccessToken
  • ValidateToken
  • InvalidateToken
Para obtener más información, consulta Elemento Operation.
configRef

Tipo: string

(Opcional) Es una referencia a un nombre de recurso personalizado OAuthV2Config que contiene parámetros de configuración de OAuthV2 reutilizables.
scope

Tipo: string

Es el alcance del token de acceso. Para obtener más información, consulta Elemento de alcance.
generateResponse

Tipo: GenerateResponse

Configura la generación de respuestas. Para obtener más información, consulta el elemento GenerateResponse.
generateErrorResponse

Tipo: GenerateErrorResponse

Configura la generación de respuestas de error. Para obtener más información, consulta el elemento GenerateErrorResponse.
expiresIn

Tipo: PropertyExpiryBean

Es la hora de vencimiento del token de acceso. Para obtener más información, consulta el elemento ExpiresIn.
refreshTokenExpiresIn

Tipo: PropertyExpiryBean

Es la hora de vencimiento del token de actualización. Para obtener más información, consulta el elemento RefreshTokenExpiresIn.
supportedGrantTypes

Tipo: array de string

Es una lista de los tipos de otorgamiento admitidos. Para obtener más información, consulta el elemento SupportedGrantTypes.
redirectURI

Tipo: string

Es el URI de redireccionamiento que se usa en el tipo de otorgamiento de código de autorización. Para obtener más información, consulta el elemento RedirectUri.
responseType

Tipo: string

Es el tipo de respuesta para el tipo de otorgamiento de código de autorización. Para obtener más información, consulta el elemento ResponseType.
clientID

Tipo: string

Es el ID de cliente. Para obtener más información, consulta el elemento ClientId.
state

Tipo: string

Es el parámetro de estado para el tipo de otorgamiento de código de autorización. Para obtener más información, consulta Elemento state.
appEndUser

Tipo: string

Es el ID del usuario final. Para obtener más información, consulta el elemento AppEndUser.
code

Tipo: string

Es el código de autorización. Para obtener más información, consulta Elemento code.
userName

Tipo: string

Es el nombre de usuario para el tipo de otorgamiento de contraseña. Para obtener más información, consulta el elemento UserName.
password

Tipo: string

Es la contraseña para el tipo de otorgamiento de contraseña. Para obtener más información, consulta Elemento de contraseña.
grantType

Tipo: string

Es el tipo de otorgamiento. Para obtener más información, consulta el elemento GrantType.
refreshToken

Tipo: string

Es el token de actualización. Para obtener más información, consulta el elemento RefreshToken.
accessToken

Tipo: string

Es el token de acceso. Para obtener más información, consulta el elemento AccessToken.
cacheExpiryInSeconds

Tipo: PropertyExpiryBean

Es el hora de vencimiento de la caché en segundos. Para obtener más información, consulta Configuración de vencimiento de la caché.
verifyAccessTokenPrefix

Tipo: string

Prefijo (opcional) que se usará cuando se verifique un token de acceso.
externalAuthorization

Tipo: boolean

Indica si se debe usar un servicio de autorización externo. Para obtener más información, consulta el elemento ExternalAuthorization.
reuseRefreshToken

Tipo: boolean

Especifica si se deben reutilizar los tokens de actualización. Para obtener más información, consulta el elemento ReuseRefreshToken.
rfcCompliance

Tipo: boolean

Aplica el cumplimiento de RFC. Para obtener más información, consulta el elemento RFCCompliantRequestResponse.
enforceStrictCallbackURIEnforced

Tipo: boolean

(Opcional) Aplica una coincidencia estricta del URI de devolución de llamada.
customAttributes

Tipo: array de CustomAttribute

Son los atributos personalizados que se agregarán al token. Para obtener más información, consulta Elemento Attributes.
externalAccessToken

Tipo: string

Es un token de acceso externo. Para obtener más información, consulta el elemento ExternalAccessToken.
externalRefreshToken

Tipo: string

Es un token de actualización externo. Para obtener más información, consulta el elemento ExternalRefreshToken.
storeToken

Tipo: string

Especifica si se debe almacenar el token. Para obtener más información, consulta el elemento StoreToken.
tokens

Tipo: array de Token

Es una lista de tokens que se invalidarán. Para obtener más información, consulta Elemento tokens.
algorithm

Tipo: string

Es el algoritmo que se usa para firmar el JWT. Para obtener más información, consulta Elemento Algorithm.
secretKey

Tipo: SecretKey

Es la clave secreta que se usa para firmar el JWT. Para obtener más información, consulta el elemento SecretKey.
privateKey

Tipo: PrivateKey

Es la clave privada que se usa para firmar el JWT. Para obtener más información, consulta Elemento PrivateKey.
publicKey

Tipo: PublicKey

Es la clave pública que se usa para verificar el JWT. Para obtener más información, consulta el elemento PublicKey.

GenerateResponse

Campo Descripción
enabled

Tipo: boolean

Si se establece en true o si se omite el atributo enabled, la política genera y muestra una respuesta.
format

Tipo: enum

Es uno de los siguientes: XML, FORM_PARAM.

GenerateErrorResponse

Campo Descripción
enabled

Tipo: boolean

Si se establece en true o si se omite el atributo enabled, la política genera y muestra una respuesta.
format

Tipo: enum

Es uno de los siguientes: XML, FORM_PARAM.
realm

Tipo: PropertyBean

Es el dominio que se devolverá en el encabezado WWW-Authenticate.

PropertyExpiryBean

Campo Descripción
value

Tipo: long

Es el valor literal del vencimiento.
ref

Tipo: string

Es una referencia a una variable que contiene el valor de vencimiento.

CustomAttribute

Campo Descripción
name

Tipo: string

Es el nombre del atributo personalizado.
ref

Tipo: string

Es una referencia a una variable que contiene el valor del atributo.
value

Tipo: string

Es el valor literal del atributo.

SecretKey

Campo Descripción
value

Tipo: PropertyBean

Especifica la clave secreta que se usa para firmar el JWT. Para obtener más información, consulta el elemento SecretKey.

PrivateKey

Campo Descripción
value

Tipo: PropertyBean

Especifica la clave privada que se usa para firmar el JWT. Para obtener más información, consulta Elemento PrivateKey.

PublicKey

Campo Descripción
value

Tipo: PropertyBean

Especifica la clave pública que se usa para verificar el JWT. Para obtener más información, consulta el elemento PublicKey.

Política ResponseCache

Campo Descripción
apiVersion

Tipo: string

apim.googleapis.com/v1
kind

Tipo: string

ResponseCache
metadata

Tipo: Kubernetes meta/v1.ObjectMeta

Consulta la documentación de la API de Kubernetes para conocer los campos disponibles en metadata.
spec

Tipo: APIExtensionPolicySpec

Define el estado deseado de ResponseCache.

ResponseCacheBean

Campo Descripción
mode

Tipo: boolean

Especifica ProxyRequest o ProxyResponse. Determina si la política se adjunta al flujo de solicitud o al flujo de respuesta.
cacheExpiry

Tipo: cacheExpiry

Proporciona el objeto cacheExpiry.
cacheKey

Tipo: cacheKey

Proporciona el objeto cacheKey.
cacheLookupTimeOut

tipo: integer

Especifica el período de tiempo de espera de la búsqueda en la caché.
cacheResourceRef

tipo: string

Especifica el identificador del recurso de caché con una referencia de variable.
excludeErrorResponse

tipo: boolean

Esta política puede almacenar en caché respuestas HTTP con cualquier código de estado. Esto significa que tanto las respuestas correctas como las de error se pueden almacenar en caché, incluidos los códigos de estado 2xx y 3xx.
skipCacheLookupCondition

tipo: string

Define una expresión que, si se evalúa como true en el tiempo de ejecución, especifica que se debe omitir la búsqueda en caché y se debe actualizar la caché.
skipCachePopulationCondition

tipo: string

Define una expresión que, si se evalúa como true en el tiempo de ejecución, especifica que se debe omitir la búsqueda en caché y que se debe actualizar la caché en el tiempo de ejecución, especifica que se debe omitir una escritura en la caché.
useAcceptHeader

tipo: boolean

Configúralo como true para agregar valores de los encabezados Accept de respuesta a la clave de caché de la entrada de caché de respuesta.
useResponseCacheHeaders

tipo: boolean

Configúralo como true para que los encabezados de respuesta HTTP se consideren cuando se configure el “tiempo de actividad” (TTL) de la respuesta en la caché.

cacheExpiry

Campo Descripción
expiryDate

Tipo: object

Especifica la fecha en la que debe vencer una entrada de caché.
timeOfDay

Tipo: object

Especifica el momento del día en el que debe vencer una entrada de caché.
timeoutInSeconds

Tipo: object

Especifica la cantidad de segundos después de los cuales debe vencer una entrada de caché.

cacheKey

Campo Descripción
cacheKeyPrefix

Tipo: string

Especifica un valor para usar como prefijo de clave de caché.
fragments

Tipo: object

Especifica un valor que se debe incluir en la clave de caché para crear un espacio de nombres para hacer coincidir las solicitudes con las respuestas almacenadas en caché.