Apiportal v1alpha1 — hub.traefik.io

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.

auth object

Auth references the APIPortalAuth resource for authentication configuration.

name string required

Name is the name of the APIPortalAuth resource.

maxLength: 253

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.

conditions []object

lastTransitionTime string required

lastTransitionTime is the last time the condition transitioned from one status to another. This should be when the underlying condition changed. If that is not known, then using the time when the API field changed is acceptable.

format: date-time

message string required

message is a human readable message indicating details about the transition. This may be an empty string.

maxLength: 32768

observedGeneration integer

observedGeneration represents the .metadata.generation that the condition was set based upon. For instance, if .metadata.generation is currently 12, but the .status.conditions[x].observedGeneration is 9, the condition is out of date with respect to the current state of the instance.

format: int64

minimum: 0

reason string required

reason contains a programmatic identifier indicating the reason for the condition's last transition. Producers of specific condition types may define expected values and meanings for this field, and whether the values are considered a guaranteed API. The value should be a CamelCase string. This field may not be empty.

pattern: ^[A-Za-z]([A-Za-z0-9_,:]*[A-Za-z0-9_])?$

minLength: 1

maxLength: 1024

status string required

status of the condition, one of True, False, Unknown.

enum: True, False, Unknown

type string required

type of condition in CamelCase or in foo.example.com/CamelCase.

pattern: ^([a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*/)?(([A-Za-z0-9][-A-Za-z0-9_.]*)?[A-Za-z0-9])$

maxLength: 316

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