Skip to search

APIPortal

hub.traefik.io / v1alpha1

apiVersion: hub.traefik.io/v1alpha1 kind: APIPortal metadata: name: example
View raw schema
apiVersion string
APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
kind string
Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
metadata object
spec object
The desired behavior of this APIPortal.
description string
Description of the APIPortal.
title string
Title is the public facing name of the APIPortal.
trustedUrls []string required
TrustedURLs are the urls that are trusted by the OAuth 2.0 authorization server.
minItems: 1
maxItems: 1
ui object
UI holds the UI customization options.
logoUrl string
LogoURL is the public URL of the logo.
status object
The current status of this APIPortal.
hash string
Hash is a hash representing the APIPortal.
oidc object
OIDC is the OIDC configuration for accessing the exposed APIPortal WebUI.
clientId string
ClientID is the OIDC ClientID for accessing the exposed APIPortal WebUI.
companyClaim string
CompanyClaim is the name of the JWT claim containing the user company.
emailClaim string
EmailClaim is the name of the JWT claim containing the user email.
firstnameClaim string
FirstnameClaim is the name of the JWT claim containing the user firstname.
generic boolean
Generic indicates whether or not the APIPortal authentication relies on Generic OIDC.
groupsClaim string
GroupsClaim is the name of the JWT claim containing the user groups.
issuer string
Issuer is the OIDC issuer for accessing the exposed APIPortal WebUI.
lastnameClaim string
LastnameClaim is the name of the JWT claim containing the user lastname.
scopes string
Scopes is the OIDC scopes for getting user attributes during the authentication to the exposed APIPortal WebUI.
secretName string
SecretName is the name of the secret containing the OIDC ClientSecret for accessing the exposed APIPortal WebUI.
syncedAttributes []string
SyncedAttributes configure the user attributes to sync.
userIdClaim string
UserIDClaim is the name of the JWT claim containing the user ID.
syncedAt string
format: date-time
version string

No matches. Try .spec.description for an exact path