Apigee Operator – Referenz für Kubernetes-Ressourcen

Diese Seite gilt für Apigee und Apigee Hybrid.

Apigee Edge-Dokumentation aufrufen

Auf dieser Seite finden Sie eine Referenz für jede Kubernetes-Ressource, die vom Apigee Operator für Kubernetes unterstützt wird. Sofern nicht ausdrücklich als optional angegeben, sind alle Felder erforderlich.

APIProduct

Feld Beschreibung
apiVersion

Typ: string

apim.googleapis.com/v1
kind

Typ: string

APIProduct
metadata

Typ: Kubernetes meta/v1.ObjectMeta

Informationen zu den in metadata verfügbaren Feldern finden Sie in der Dokumentation zur Kubernetes API.
spec

Typ: APIProductSpec

spec definiert den gewünschten Status des APIProductSet.

APIProductSpec

Feld Beschreibung
name

Typ: string

Der Name des API-Produkts.
approvalType

Typ: string

Flag, das angibt, wie API-Schlüssel für den Zugriff auf die vom API-Produkt definierten APIs zugelassen sind. Wenn dieser Wert auf manual gesetzt ist, wird der Consumer-Key generiert und als pending zurückgegeben. In diesem Fall funktionieren die API-Schlüssel erst, wenn sie explizit genehmigt wurden.

Wenn dieser Wert auf auto gesetzt ist, wird der Verbraucherschlüssel generiert und als approved zurückgegeben. Er kann sofort verwendet werden.

description

Typ: string

Beschreibung des API-Produkts.
displayName

Typ: string

Name, der in der Benutzeroberfläche oder im Entwicklerportal für Entwickler angezeigt wird, die sich für den API-Zugriff registrieren.
analytics

Typ: Analytics

Gibt an, ob Analysen für Vorgänge im Zusammenhang mit diesem Produkt erfasst werden sollen.
enforcementRefs

Typ: Array

Array von EnforcementRef-Ressourcen, die auf das API-Produkt angewendet werden sollen.
attributes

Typ: Array

Array von Attributen, mit denen das Standard-API-Produktprofil mit kundenspezifischen Metadaten erweitert werden kann.

EnforcementRef

Feld Beschreibung
name

Typ: string

Der Name der Zielressource.
kind

Typ: string

APIMExtensionPolicy
group

Typ: string

Die APIGroup für den Apigee APIM Operator, die apim.googleapis.com ist.
namespace

Typ: string

(Optional) Der Namespace des Referenten. Wenn nicht angegeben, wird der lokale Namespace abgeleitet.

Attribut

Feld Beschreibung
name

Typ: string

Der Schlüssel des Attributs.
value

Typ: string

Der Wert des Attributs.

APIOperationSet

Feld Beschreibung
apiVersion

Typ: string

apim.googleapis.com/v1
kind

Typ: string

APIOperationSet
metadata

Typ: Kubernetes meta/v1.ObjectMeta

Informationen zu den in metadata verfügbaren Feldern finden Sie in der Dokumentation zur Kubernetes API.
spec

Typ: APIOperationSetSpec

Definiert den gewünschten Status des APIOperationSet.

APIOperationSetSpec

Feld Beschreibung
quota

Typ: Quota

Kontingentdefinition.
restOperations

Typ: Array

Array von RESTOperation-Definitionen.
apiProductRefs

Typ: Array

Array von APIProductRef-Ressourcen oder Verweise auf API-Produkte, auf die die REST-Vorgänge angewendet werden sollen.

Kontingent

Feld Beschreibung
limit

Typ: integer

Anzahl der Anfragenachrichten, die pro App vom API-Produkt für die angegebene interval und timeUnit zulässig sind.
interval

Typ: integer

Zeitintervall, für das die Anzahl der Anfragenachrichten berechnet wird.
timeUnit

Typ: string

Für das Intervall definierte Zeiteinheit. Zulässige Werte sind minute, hour, day oder month.

RESTOperation

Feld Beschreibung
name

Typ: string

Der Name des REST-Vorgangs.
path

Typ: string

In Kombination mit methods ist path der HTTP-Pfad, der für ein Kontingent und/oder ein API-Produkt abgeglichen werden soll.
methods

Typ: array

In Kombination mit path ist methods die Liste (als strings) der anwendbaren HTTP-Methoden, die für ein Kontingent und/oder für ein API-Produkt abgeglichen werden sollen.

APIProductRef

Feld Beschreibung
name

Typ: string

Der Name der Zielressource.
kind

Typ: string

APIProduct
group

Typ: string

Die APIGroup für den Apigee APIM Operator, die apim.googleapis.com ist.
namespace

Typ: string

(Optional) Der Namespace des Referenten. Wenn nicht angegeben, wird der lokale Namespace abgeleitet.

APIMExtensionPolicy

Feld Beschreibung
apiVersion

Typ: string

apim.googleapis.com/v1
kind

Typ: string

APIMExtensionPolicy
metadata

Typ: Kubernetes meta/v1.ObjectMeta

Informationen zu den in metadata verfügbaren Feldern finden Sie in der Dokumentation zur Kubernetes API.
spec

Typ: APIMExtensionPolicySpec

Definiert den gewünschten Status von APIMExtensionPolicy.

APIMExtensionPolicySpec

Feld Beschreibung
apigeeEnv (Optional) Apigee-Umgebung.

Wenn keine angegeben ist, wird eine neue Umgebung erstellt und an alle verfügbaren Instanzen angehängt.

Wenn diese Umgebung bereitgestellt wird, muss sie an alle verfügbaren Instanzen angehängt werden, wenn ein externer globaler Load Balancer verwendet wird.

failOpen

Typ: boolean

Gibt an, ob Fail Open verwendet werden soll, wenn die Apigee-Laufzeit nicht erreichbar ist. Wenn true festgelegt ist, werden Aufrufe der Apigee-Laufzeit als erfolgreich behandelt, auch wenn die Laufzeit nicht erreichbar ist.
timeout

Typ: string

Gibt das Zeitlimit an, bevor Aufrufe der Apigee-Laufzeit fehlschlagen, in Sekunden oder Millisekunden. Beispiel: 10s.
targetRef

Typ: ExtensionServerRef

Gibt das Google Kubernetes Engine-Gateway an, in dem die Erweiterung installiert werden soll.
location

Typ: string

Gibt den Google Cloud Speicherort an, an dem die APIMExtensionPolicy erzwungen wird.
supportedEvents

Typ: List Ereignisse

Gibt die Liste der Ereignisse für Erweiterungsprozessoren an, die an Apigee gesendet werden. Dazu gehören:
  • "REQUEST_HEADERS"
  • "RESPONSE_HEADERS"
  • "REQUEST_BODY" (Vorschau)
  • "RESPONSE_BODY" (Vorschau)
  • "REQUEST_TRAILERS"
  • "RESPONSE_TRAILERS"

ExtensionServerRef

Feld Beschreibung
name

Typ: string

Der Name der Zielressource.
kind

Typ: string

Gibt den kind der Zielressource an, z. B. Gateway oder Service.
group

Typ: string

Die APIGroup für den Apigee APIM Operator, die apim.googleapis.com ist.
namespace

Typ: string

(Optional) Der Namespace des Referenten. Wenn nicht angegeben, wird der lokale Namespace abgeleitet.

ApigeeGatewayPolicy

Feld Beschreibung
apiVersion

Typ: string

apim.googleapis.com/v1
kind

Typ: string

ApigeeGatewayPolicy
metadata

Typ: Kubernetes meta/v1.ObjectMeta

Informationen zu den in metadata verfügbaren Feldern finden Sie in der Dokumentation zur Kubernetes API.
spec

Typ: ApigeeGatewayPolicySpec

Definiert den gewünschten Status von ApigeeGatewayPolicy.

ApigeeGatewayPolicySpec

Feld Beschreibung
ref

Typ: ExtensionServerRef

Bezieht sich auf die APIM-Vorlage, die erstellt wurde, um die auf das GKE-Gateway angewendeten Richtlinien zu verwalten.
targetRef

Typ: ExtensionServerRef

Bezieht sich auf die APIM-Erweiterungsrichtlinie, die diese spezifische Gateway-Richtlinie anwenden soll. Bezieht sich indirekt auf das GKE Gateway.
serviceAccount (Optional) Gibt das Dienstkonto an, das zum Generieren von Google auth-Tokens in einem Apigee-Proxy verwendet wird.

ApimTemplate

Feld Beschreibung
apiVersion

Typ: string

apim.googleapis.com/v1
kind

Typ: string

ApimTemplate
metadata

Typ: Kubernetes meta/v1.ObjectMeta

Informationen zu den in metadata verfügbaren Feldern finden Sie in der Dokumentation zur Kubernetes API.
spec

Typ: ApimTemplateSpec

Definiert den gewünschten Status von ApimTemplate.

ApimTemplateSpec

Feld Beschreibung
templates

Typ: list

Eine Liste von ApimTemplateFlow-Ressourcen, die die Richtlinien angeben, die im Anfragefluss ausgeführt werden sollen.
apimTemplateRule

Typ: ExtensionServerRef

Gibt die APIM-Vorlagenregel an, die zum Validieren der angewendeten Richtlinien verwendet werden soll.

ApimTemplateFlow

Feld Beschreibung
policies

Typ: list ConditionalParameterReference

Eine Liste von ConditionalParameterReference-Ressourcen, die die sortierte Liste der Richtlinien angeben, die als Teil des Anforderungsablaufs ausgeführt werden sollen.
condition

Typ: string

Gibt die Bedingungen für die Ausführung dieser Ressource an.

ConditionalParameterReference

Feld Beschreibung
condition

Type: string

Gibt die Bedingungen für die Ausführung dieser Ressource an.

ApimTemplateRule

Feld Beschreibung
apiVersion

Typ: string

apim.googleapis.com/v1
kind

Typ: string

ApimTemplateRule
metadata

Typ: Kubernetes meta/v1.ObjectMeta

Informationen zu den in metadata verfügbaren Feldern finden Sie in der Dokumentation zur Kubernetes API.
spec

Typ: ApimTemplateRuleSpec

Definiert den gewünschten Status von ApimTemplateRule.

ApimTemplateRuleSpec

Feld Beschreibung
requiredList Die Liste der Richtlinien (als strings), die im ApimTemplate vorhanden sein müssen.
denyList Die Liste der Richtlinien (als strings), die nicht im ApimTemplate vorhanden sein sollten.
allowList Die Liste der Richtlinien (als strings), die möglicherweise im ApimTemplate vorhanden sind, aber nicht erforderlich sind.
override

Typ: boolean

Überschreibt Aktualisierungen der APIM-Vorlagenregel, falls APIM-Vorlagen mit der Regel vorhanden sind. Gültige Werte sind true und false.

AssignMessage (Google -Token-Injektion)

Feld Beschreibung
apiVersion

Typ: string

apim.googleapis.com/v1
kind

Typ: string

AssignMessage
metadata

Typ: Kubernetes meta/v1.ObjectMeta

Informationen zu den in metadata verfügbaren Feldern finden Sie in der Dokumentation zur Kubernetes API.
spec

Typ: AssignMessageBean

Definiert den gewünschten Status der AssignMessage-Richtlinie.

AssignMessageBean

Feld Beschreibung
setActions

Typ: array

Array von SetActionsBean-Objekten. Ersetzt Werte vorhandener Attribute in der Anfrage oder Antwort, die durch das Element AssignTo angegeben werden.

Wenn die Header oder Parameter bereits in der ursprünglichen Nachricht vorhanden sind, werden die Werte von setActions überschrieben. Andernfalls fügt setActions neue Header oder Parameter wie angegeben hinzu.

AssignTo

Typ: AssignToBean

Gibt an, auf welche Nachricht die AssignMessage-Richtlinie angewendet wird. Das kann die Anfrage, die Antwort oder eine neue benutzerdefinierte Nachricht sein.

SetActionsBean

Feld Beschreibung
Authentication

Typ: AuthenticationBean

Generiert Google OAuth 2.0- oder OpenID Connect-Tokens für authentifizierte Aufrufe an Google -Dienste oder benutzerdefinierte Dienste, die in bestimmten Google Cloud -Produkten ausgeführt werden, z. B. Cloud Run-Funktionen und Cloud Run.

AuthenticationBean

Feld Beschreibung
GoogleAccessToken

Typ: GoogleAccessTokenBean

Generiert Google OAuth 2.0-Tokens für authentifizierte Aufrufe an Google-Dienste.
GoogleIDToken

Typ: GoogleIDTokenBean

Konfiguration zum Generieren eines OpenID Connect-Tokens zur Authentifizierung der Zielanfrage.
headerName

Typ: string

Wenn eine Authentifizierungskonfiguration vorhanden ist, generiert Apigee standardmäßig ein Inhabertoken und fügt es in den Autorisierungsheader der Nachricht ein, die an das Zielsystem gesendet wird. Mit dem Element headerName können Sie den Namen eines anderen Headers angeben, der das Inhabertoken enthält.

GoogleAccessTokenBean

Feld Beschreibung
scopes

Typ: array

Array von strings, das einen gültigen Google API-Bereich angibt. Weitere Informationen finden Sie unter OAuth 2.0-Bereiche für Google APIs.
LifetimeInSeconds

Typ: integer

Gibt die Lebensdauer des Zugriffstokens in Sekunden an.

GoogleIDTokenBean

Feld Beschreibung
Audience

Typ: AudienceBean

Das Zielobjekt für das generierte Authentifizierungstoken, z. B. die API oder das Dienstkonto, auf das das Token Zugriff gewährt.
IncludeEmail

Typ: boolean

Wenn dafür true festgelegt ist, enthält das generierte Authentifizierungstoken die Anforderungen email und email_verified des Dienstkontos.

AudienceBean

Feld Beschreibung
useTargetHost

Typ: string

Wenn der Wert von Audience leer ist oder die Variable ref nicht in einen gültigen Wert aufgelöst wird und useTargetUrl true ist, dann wird die URL des Ziels (ohne Abfrageparameter) als Zielgruppe verwendet.
useTargetUrl

Typ: boolean

Standardmäßig ist useTargetUrl auf false festgelegt.

AssignToBean

Feld Beschreibung
createNew

Typ: boolean

Bestimmt, ob die Richtlinie eine neue Nachricht erstellt, wenn Werte zugewiesen werden. Wenn dieser Wert auf true gesetzt ist, wird von der Richtlinie eine neue Nachricht erstellt.
type

Typ: string

Gibt den Typ der neuen Nachricht an, wenn CreateNew auf true „true“ gesetzt ist. Gültige Werte sind request oder response.

JavaScript

Feld Beschreibung
apiVersion

Typ: string

apim.googleapis.com/v1
kind

Typ: string

JavaScript
metadata

Typ: Kubernetes meta/v1.ObjectMeta

Informationen zu den in metadata verfügbaren Feldern finden Sie in der Dokumentation zur Kubernetes API.
spec

Typ: JavascriptBean

Definiert den gewünschten Status der JavaScript-Richtlinie.

JavascriptBean

Feld Beschreibung
mode

Typ: array

Array von strings, das ProxyRequest oder ProxyResponse angibt. Gibt an, ob die Richtlinie an den Anfrage- oder Antwortablauf angehängt ist.
source

Typ: string

Inline-JavaScript-Code
timeLimit

Typ: integer

Gibt das Zeitlimit für die Ausführung von JavaScript-Code an.

KVM

Feld Beschreibung
apiVersion

Typ: string

apim.googleapis.com/v1
kind

Typ: string

KVM
metadata

Typ: Kubernetes meta/v1.ObjectMeta

Informationen zu den in metadata verfügbaren Feldern finden Sie in der Dokumentation zur Kubernetes API.
spec

Typ: KeyValueMapOperationsBean

Definiert den gewünschten Status der KVM-Richtlinie.

KeyValueMapOperationsBean

Feld Beschreibung
MapName

Typ: MapName

Ermöglicht der Richtlinie, festzulegen, welche KVM zur Laufzeit dynamisch verwendet werden soll. Weitere Informationen finden Sie unter MapName-Element.
expiryTimeInSecs

Typ: integer

Gibt die Dauer in Sekunden an, nach der Apigee seinen im Cache gespeicherten Wert von der angegebenen KVM aktualisiert. Weitere Informationen finden Sie unter Element „ExpiryTimeInSecs“.
initialEntries

Typ: list

Seed-Werte für KVMs, die bei der Initialisierung in der KVM ausgefüllt werden. Weitere Informationen finden Sie unter InitialEntries-Element.
delete

Typ: list von Delete

Löscht das angegebene Schlüssel/Wert-Paar aus der KVM. Weitere Informationen finden Sie unter Element löschen.
get

Typ: list von Get

Ruft den Wert eines Schlüssels aus der KVM ab. Weitere Informationen finden Sie unter Element abrufen.

OASValidation

Feld Beschreibung
apiVersion

Typ: string

apim.googleapis.com/v1
kind

Typ: string

OASValidation
metadata

Typ: Kubernetes meta/v1.ObjectMeta

Informationen zu den in metadata verfügbaren Feldern finden Sie in der Dokumentation zur Kubernetes API.
spec

Typ: OASValidationBean

Definiert den gewünschten Status der OASValidation-Richtlinie.
status

Typ: ApimResourceStatus

Zeigt den Status der OASValidation-Richtlinie an.

OASValidationBean

Feld Beschreibung
openApiSpec

Typ: string

Gibt die zu validierende OpenAPI-Spezifikation in yaml an. Da es sich um ein mehrzeiliges yaml-Fragment handelt, verwenden Sie das Trennzeichen „|“.
source

Typ: string

Entweder message, request oder response. Wenn der Wert auf request gesetzt ist, werden eingehende Anfragen von Client-Apps ausgewertet. Wenn er auf response gesetzt ist, werden Antworten von Zielservern ausgewertet. Wenn message festgelegt ist, wird die Anfrage oder Antwort automatisch ausgewertet, je nachdem, ob die Richtlinie an den Anfrage- oder Antwortablauf angehängt ist.
options

Typ: OASValidationOptions

Weitere Informationen finden Sie unter OASValidationOptions/td>

OASValidationOptions

Feld Beschreibung
validateMessageBody

Typ: boolean

Gibt an, ob der Richtlinientext in der OpenAPI-Spezifikation mit dem Anfragetexttext des Vorgangs abgeglichen werden soll. Setzen Sie diesen Wert auf true, um den Inhalt des Nachrichtentexts zu validieren. Setzen Sie diesen Wert auf false, um nur zu prüfen, ob der Nachrichtentext vorhanden ist.
allowUnspecifiedParameters

Typ: StrictOptions

Siehe StrictOptions.

StrictOptions

Feld Beschreibung
header

Typ: boolean

Damit Headerparameter in der Anfrage angegeben werden können, die nicht in der OpenAPI-Spezifikation definiert sind, setzen Sie diesen Parameter auf true. Setzen Sie andernfalls diesen Parameter auf false, damit die Richtlinienausführung fehlschlägt.
query

Typ: boolean

Damit Abfrageparameter in der Anfrage angegeben werden können, die nicht in der OpenAPI-Spezifikation definiert sind, setzen Sie diesen Parameter auf true. Setzen Sie andernfalls diesen Parameter auf false, damit die Richtlinienausführung fehlschlägt.
cookie

Typ: boolean

Damit Cookieparameter in der Anfrage angegeben werden können, die nicht in der OpenAPI-Spezifikation definiert sind, setzen Sie diesen Parameter auf true. Setzen Sie andernfalls diesen Parameter auf false, damit die Richtlinienausführung fehlschlägt.

ApimResourceStatus

Feld Beschreibung
currentState

Typ: enum

Zeigt den aktuellen Status der Ressource an:
  • RUNNING = Ressource wird ausgeführt.
  • CREATING = Ressource wird erstellt
  • CREATED = Ressource wurde erstellt
  • UPDATING = Ressource wird aktualisiert
  • DELETING = Ressource wird gelöscht
  • CREATE_UPDATE_FAILED = Erstellungs- oder Aktualisierungsvorgang fehlgeschlagen
  • DELETE_FAILED = Löschvorgang fehlgeschlagen
errorMessage

Typ: string

Fehlermeldung, die sich auf einen der Fehlerstatus des Felds currentState bezieht.
operationResult

Typ: string

Ein Antwortstring von einem der Vorgänge mit langer Ausführungszeit, die sich auf das Erstellen, Aktualisieren oder Löschen von Ressourcen beziehen.

ServiceCallout

Feld Beschreibung
apiVersion

Typ: string

apim.googleapis.com/v1
kind

Typ: string

ServiceCallout
metadata

Typ: Kubernetes meta/v1.ObjectMeta

Informationen zu den in metadata verfügbaren Feldern finden Sie in der Dokumentation zur Kubernetes API.
spec

Typ: ServiceCalloutBean

Definiert den gewünschten Status der ServiceCallout-Richtlinie.
status

Typ: ApimResourceStatus

Zeigt den Status der ServiceCallout-Richtlinie an.

ServiceCalloutBean

Feld Beschreibung
httpTargetConnection

Typ: HttpTargetConnection

Stellt Transportdetails wie URL, TLS/SSL und HTTP-Attribute bereit.
request

Typ: CalloutRequest

Gibt die Variable mit der Anfragenachricht an, die vom API-Proxy an den anderen Dienst gesendet wird.
Response

Typ: string

Gibt die Variable mit der Antwortnachricht an, die vom externen Dienst an den API-Proxy zurückgegeben wird.

HttpTargetConnection

Feld Beschreibung
url

Typ: string

Die URL des Zieldienstes.
properties

Typ: Map of <string, string>

HTTP-Transportattribute für den Back-End-Dienst. Weitere Informationen finden Sie unter Referenz für Endpunktattribute.
timeout

Typ: int

Das Zeitlimit für den Service-Callout in Millisekunden. Weitere Informationen finden Sie unter Zeitüberschreitung.

CalloutRequest

Feld Beschreibung
url

Typ: string

Die URL des Zieldienstes.
properties

Typ: Map of <string, string>

HTTP-Transportattribute für den Back-End-Dienst. Weitere Informationen finden Sie unter Referenz für Endpunktattribute.

SpikeArrest

Feld Beschreibung
apiVersion

Typ: string

apim.googleapis.com/v1
kind

Typ: string

SpikeArrest
metadata

Typ: Kubernetes meta/v1.ObjectMeta

Informationen zu den in metadata verfügbaren Feldern finden Sie in der Dokumentation zur Kubernetes API.
spec

Typ: SpikeArrestBean

Definiert den gewünschten Status der SpikeArrest-Richtlinie.

SpikeArrestBean

Feld Beschreibung
mode

Typ: array

Array von strings, das ProxyRequest oder ProxyResponse angibt. Gibt an, ob die Richtlinie an den Anfrage- oder Antwortablauf angehängt ist.
peakMessageRate

Typ: peakMessageRate

Gibt die Rate der Nachrichten für SpikeArrest an.
useEffectiveCount

Typ: boolean

Wenn truetrue festgelegt ist, wird SpikeArrest in einer Region verteilt. Die Anzahl der Anfragen wird zwischen den Apigee-Message Processors (MPs) in einer Region synchronisiert.

Wenn false festgelegt ist, verwendet SpikeArrest lokal einen Token-Bucket-Algorithmus. Weitere Informationen finden Sie unter UseEffectiveCount.

peakMessageRate

Feld Beschreibung
ref

Typ: string

Variable, die auf den Wert rate verweist.
value

Typ: string

Tatsächlicher rate-Wert, wenn keine Referenz verfügbar ist.

GenerateJWT

Feld Beschreibung
apiVersion

Typ: string

apim.googleapis.com/v1
kind

Typ: string

GenerateJWT
metadata

Typ: Kubernetes meta/v1.ObjectMeta

Informationen zu den in metadata verfügbaren Feldern finden Sie in der Dokumentation zur Kubernetes API.
spec

Typ: GenerateJWTBean

Definiert den gewünschten Status der GenerateJWT-Richtlinie.
status

Typ: ApimResourceStatus

Zeigt den Status der GenerateJWT-Richtlinie an.

GenerateJWTBean

Feld Beschreibung
subject

Typ: PropertyBean

Gibt das Konto an, das das Subjekt des JWT ist. Weitere Informationen finden Sie unter Subject-Element.
issuer

Typ: PropertyBean

Gibt das Hauptkonto an, das das JWT ausgestellt hat. Weitere Informationen finden Sie unter Ausstellerelement.
audience

Typ: VarArrayBean

Identifiziert die Empfänger, für die das JWT bestimmt ist. Weitere Informationen finden Sie unter Zielgruppenelement.
id

Typ: PropertyBean

Gibt eine eindeutige Kennung für das JWT an. Weitere Informationen finden Sie unter Id-Element.
expiresIn

Typ: PropertyBean

Gibt die Ablaufzeit für das JWT an. Weitere Informationen finden Sie unter ExpiresIn-Element.
notBefore

Typ: PropertyBean

Gibt die Zeit an, vor der das JWT nicht zur Verarbeitung akzeptiert werden darf. Weitere Informationen finden Sie unter NotBefore-Element.
additionalClaims

Typ: AdditionalClaimsBean

Gibt zusätzliche Anforderungen an, die im JWT enthalten sein sollen. Weitere Informationen finden Sie unter Element „AdditionalClaims“.
compress

Typ: boolean

Gibt an, ob die JWT-Nutzlast komprimiert werden soll. Weitere Informationen finden Sie unter Element komprimieren.

PropertyBean

Feld Beschreibung
value

Typ: string

Der Literalwert der Property.
ref

Typ: string

Ein Verweis auf eine Variable, die den Wert der Eigenschaft enthält.

VarArrayBean

Feld Beschreibung
values

Typ: array von string

Ein Array von Literal-Stringwerten.
ref

Typ: string

Ein Verweis auf eine Variable, die das Array mit den Werten enthält.

AdditionalClaimsBean

Feld Beschreibung
claims

Typ: map von string bis string

Eine Zuordnung von Anforderungsnamen zu Anforderungswerten.
ref

Typ: string

Ein Verweis auf eine Variable, die die Zuordnung der Ansprüche enthält.

OAuthV2

Feld Beschreibung
apiVersion

Typ: string

apim.googleapis.com/v1
kind

Typ: string

OAuthV2
metadata

Typ: Kubernetes meta/v1.ObjectMeta

Informationen zu den in metadata verfügbaren Feldern finden Sie in der Dokumentation zur Kubernetes API.
spec

Typ: OAuthV2Bean

Definiert den gewünschten Status der OAuthV2-Richtlinie.
status

Typ: ApimResourceStatus

Zeigt den Status der OAuthV2-Richtlinie an.

OAuthV2Bean

Feld Beschreibung
operation

Typ: enum

Der auszuführende OAuthV2-Vorgang. Gültige Werte sind:
  • GenerateAuthorizationCode
  • GenerateAccessToken
  • GenerateAccessTokenImplicitGrant
  • GenerateJWTAccessTokenImplicitGrant
  • GenerateJWTAccessToken
  • RefreshAccessToken
  • RefreshJWTAccessToken
  • VerifyAccessToken
  • VerifyJWTAccessToken
  • ValidateToken
  • InvalidateToken
Weitere Informationen finden Sie unter Operation element.
configRef

Typ: string

(Optional) Verweis auf einen benutzerdefinierten Ressourcennamen für OAuthV2Config, der wiederverwendbare OAuthV2-Einstellungen enthält.
scope

Typ: string

Der Bereich des Zugriffstokens. Weitere Informationen finden Sie unter Bereichselement.
generateResponse

Typ: GenerateResponse

Konfiguriert die Antwortgenerierung. Weitere Informationen finden Sie unter GenerateResponse-Element.
generateErrorResponse

Typ: GenerateErrorResponse

Konfiguriert die Generierung von Fehlerantworten. Weitere Informationen finden Sie unter GenerateErrorResponse-Element.
expiresIn

Typ: PropertyExpiryBean

Die Ablaufzeit des Zugriffstokens. Weitere Informationen finden Sie unter ExpiresIn-Element.
refreshTokenExpiresIn

Typ: PropertyExpiryBean

Die Ablaufzeit des Aktualisierungstokens. Weitere Informationen finden Sie unter Element „RefreshTokenExpiresIn“.
supportedGrantTypes

Typ: array von string

Eine Liste der unterstützten Berechtigungstypen. Weitere Informationen finden Sie unter SupportedGrantTypes-Element.
redirectURI

Typ: string

Der Weiterleitungs-URI, der im Autorisierungscode-Grant-Typ verwendet wird. Weitere Informationen finden Sie unter RedirectUri-Element.
responseType

Typ: string

Der Antworttyp für den Grant-Typ „Autorisierungscode“. Weitere Informationen finden Sie unter ResponseType-Element.
clientID

Typ: string

Die Client-ID. Weitere Informationen finden Sie unter Element „ClientId“.
state

Typ: string

Der Statusparameter für den Autorisierungscode-Grant-Typ. Weitere Informationen finden Sie unter State-Element.
appEndUser

Typ: string

Die Endnutzer-ID. Weitere Informationen finden Sie unter AppEndUser-Element.
code

Typ: string

Der Autorisierungscode. Weitere Informationen finden Sie unter Code-Element.
userName

Typ: string

Der Nutzername für den Passwort-Grant-Typ. Weitere Informationen finden Sie unter UserName-Element.
password

Typ: string

Das Passwort für den Grant-Typ „Passwort“. Weitere Informationen finden Sie unter Passwort-Element.
grantType

Typ: string

Der Berechtigungstyp. Weitere Informationen finden Sie unter GrantType-Element.
refreshToken

Typ: string

Das Aktualisierungstoken. Weitere Informationen finden Sie unter RefreshToken-Element.
accessToken

Typ: string

Das Zugriffstoken. Weitere Informationen finden Sie unter AccessToken-Element.
cacheExpiryInSeconds

Typ: PropertyExpiryBean

Die Cache-Ablaufzeit in Sekunden. Weitere Informationen finden Sie unter Cache-Ablauf-Einstellungen.
verifyAccessTokenPrefix

Typ: string

Optional: Präfix, das beim Überprüfen eines Zugriffstokens verwendet werden soll.
externalAuthorization

Typ: boolean

Gibt an, ob ein externer Autorisierungsdienst verwendet werden soll. Weitere Informationen finden Sie unter ExternalAuthorization-Element.
reuseRefreshToken

Typ: boolean

Gibt an, ob Aktualisierungstokens wiederverwendet werden sollen. Weitere Informationen finden Sie unter ReuseRefreshToken-Element.
rfcCompliance

Typ: boolean

Erzwingt die RFC-Compliance. Weitere Informationen finden Sie unter RFCCompliantRequestResponse-Element.
enforceStrictCallbackURIEnforced

Typ: boolean

(Optional) Erzwingt einen strengen Abgleich des Callback-URI.
customAttributes

Typ: array von CustomAttribute

Benutzerdefinierte Attribute, die dem Token hinzugefügt werden sollen. Weitere Informationen finden Sie unter Element „Attributes“.
externalAccessToken

Typ: string

Ein externes Zugriffstoken. Weitere Informationen finden Sie unter ExternalAccessToken-Element.
externalRefreshToken

Typ: string

Ein externes Aktualisierungstoken. Weitere Informationen finden Sie unter ExternalRefreshToken-Element.
storeToken

Typ: string

Gibt an, ob das Token gespeichert werden soll. Weitere Informationen finden Sie unter StoreToken-Element.
tokens

Typ: array von Token

Eine Liste der zu invalidierenden Tokens. Weitere Informationen finden Sie unter Element „Tokens“.
algorithm

Typ: string

Der Algorithmus, der zum Signieren des JWT verwendet wird. Weitere Informationen finden Sie unter Algorithmus-Element.
secretKey

Typ: SecretKey

Der geheime Schlüssel, der zum Signieren des JWT verwendet wird. Weitere Informationen finden Sie unter SecretKey-Element.
privateKey

Typ: PrivateKey

Der private Schlüssel, der zum Signieren des JWT verwendet wird. Weitere Informationen finden Sie unter Element „PrivateKey“.
publicKey

Typ: PublicKey

Der öffentliche Schlüssel, der zum Überprüfen des JWT verwendet wird. Weitere Informationen finden Sie unter PublicKey-Element.

GenerateResponse

Feld Beschreibung
enabled

Typ: boolean

Wenn der Wert auf true gesetzt ist oder wenn das Attribut „enabled“ weggelassen wird, generiert die Richtlinie eine Antwort und gibt diese zurück.
format

Typ: enum

Entweder XML oder FORM_PARAM.

GenerateErrorResponse

Feld Beschreibung
enabled

Typ: boolean

Wenn der Wert auf true gesetzt ist oder wenn das Attribut „enabled“ weggelassen wird, generiert die Richtlinie eine Antwort und gibt diese zurück.
format

Typ: enum

Entweder XML oder FORM_PARAM.
realm

Typ: PropertyBean

Der Bereich, der im WWW-Authenticate-Header zurückgegeben werden soll.

PropertyExpiryBean

Feld Beschreibung
value

Typ: long

Der Literalwert des Ablaufs.
ref

Typ: string

Ein Verweis auf eine Variable, die den Ablaufwert enthält.

CustomAttribute

Feld Beschreibung
name

Typ: string

Der Name des benutzerdefinierten Attributs.
ref

Typ: string

Ein Verweis auf eine Variable, die den Attributwert enthält.
value

Typ: string

Der Literalwert des Attributs.

SecretKey

Feld Beschreibung
value

Typ: PropertyBean

Gibt den geheimen Schlüssel an, der zum Signieren des JWT verwendet wird. Weitere Informationen finden Sie unter SecretKey-Element.

PrivateKey

Feld Beschreibung
value

Typ: PropertyBean

Gibt den privaten Schlüssel an, der zum Signieren des JWT verwendet wird. Weitere Informationen finden Sie unter Element „PrivateKey“.

PublicKey

Feld Beschreibung
value

Typ: PropertyBean

Gibt den öffentlichen Schlüssel an, mit dem das JWT überprüft wird. Weitere Informationen finden Sie unter PublicKey-Element.

ResponseCache-Richtlinie

Feld Beschreibung
apiVersion

Typ: string

apim.googleapis.com/v1
kind

Typ: string

ResponseCache
metadata

Typ: Kubernetes meta/v1.ObjectMeta

Informationen zu den in metadata verfügbaren Feldern finden Sie in der Dokumentation zur Kubernetes API.
spec

Typ: APIExtensionPolicySpec

Definiert den gewünschten Status von ResponseCache.

ResponseCacheBean

Feld Beschreibung
mode

Typ: boolean

Gibt ProxyRequest oder ProxyResponse an. Gibt an, ob die Richtlinie an den Anfrage- oder Antwortablauf angehängt ist.
cacheExpiry

Typ: cacheExpiry

Stellt das „cacheExpiry“-Objekt bereit.
cacheKey

Typ: cacheKey

Stellt das cacheKey-Objekt bereit.
cacheLookupTimeOut

Typ: integer

Gibt das Zeitlimit für die Cache-Suche an.
cacheResourceRef

Typ: string

Gibt die Cache-Ressourcen-ID mithilfe eines Variablenverweises an.
excludeErrorResponse

Typ: boolean

Mit dieser Richtlinie können HTTP-Antworten mit einem beliebigen Statuscode im Cache gespeichert werden. Das bedeutet, dass sowohl Erfolgs- als auch Fehlerantworten im Cache gespeichert werden können, einschließlich der Statuscodes 2xx und 3xx.
skipCacheLookupCondition

Typ: string

Definiert einen Ausdruck, der angibt, dass die Cache-Suche übersprungen und der Cache aktualisiert werden soll. Voraussetzung ist, dass der Ausdruck zur Laufzeit true ergibt.
skipCachePopulationCondition

Typ: string

Definiert einen Ausdruck, der bei Auswertung zur Laufzeit als true angibt, dass die Cache-Suche übersprungen und der Cache aktualisiert werden soll.
useAcceptHeader

Typ: boolean

Legen Sie true fest, um Werte aus den Antwort-Accept-Headern an den Cache-Schlüssel des Antwort-Cache-Eintrags anzuhängen.
useResponseCacheHeaders

Typ: boolean

Legen Sie true fest, damit HTTP-Antwortheader beim Festlegen der Gültigkeitsdauer (TTL) der Antwort im Cache berücksichtigt werden.

cacheExpiry

Feld Beschreibung
expiryDate

Typ: object

Gibt das Datum an, an dem ein Cache-Eintrag ablaufen soll.
timeOfDay

Typ: object

Gibt die Tageszeit an, zu der ein Cache-Eintrag ablaufen soll.
timeoutInSeconds

Typ: object

Gibt die Anzahl der Sekunden an, nach denen ein Cache-Eintrag ablaufen soll.

cacheKey

Feld Beschreibung
cacheKeyPrefix

Typ: string

Gibt den Wert an, der als Cache-Schlüsselpräfix verwendet werden soll.
fragments

Typ: object

Gibt einen Wert an, der im Cache-Schlüssel enthalten sein muss, um einen Namespace für den Abgleich von Anfragen mit im Cache gespeicherten Antworten zu erstellen.