resources.v2.teleportSAMLConnector
"SAMLConnector is the Schema for the samlconnectors API"
Index
fn new(name)
obj metadata
fn withAnnotations(annotations)
fn withAnnotationsMixin(annotations)
fn withClusterName(clusterName)
fn withCreationTimestamp(creationTimestamp)
fn withDeletionGracePeriodSeconds(deletionGracePeriodSeconds)
fn withDeletionTimestamp(deletionTimestamp)
fn withFinalizers(finalizers)
fn withFinalizersMixin(finalizers)
fn withGenerateName(generateName)
fn withGeneration(generation)
fn withLabels(labels)
fn withLabelsMixin(labels)
fn withName(name)
fn withNamespace(namespace)
fn withOwnerReferences(ownerReferences)
fn withOwnerReferencesMixin(ownerReferences)
fn withResourceVersion(resourceVersion)
fn withSelfLink(selfLink)
fn withUid(uid)
obj spec
fn withAcs(acs)
fn withAllow_idp_initiated(allow_idp_initiated)
fn withAttributes_to_roles(attributes_to_roles)
fn withAttributes_to_rolesMixin(attributes_to_roles)
fn withAudience(audience)
fn withCert(cert)
fn withDisplay(display)
fn withEntity_descriptor(entity_descriptor)
fn withEntity_descriptor_url(entity_descriptor_url)
fn withIssuer(issuer)
fn withProvider(provider)
fn withService_provider_issuer(service_provider_issuer)
fn withSingle_logout_url(single_logout_url)
fn withSso(sso)
obj spec.assertion_key_pair
obj spec.attributes_to_roles
obj spec.client_redirect_settings
obj spec.signing_key_pair
Fields
fn new
new(name)
new returns an instance of TeleportSAMLConnector
obj metadata
"ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create."
fn metadata.withAnnotations
withAnnotations(annotations)
"Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: http://kubernetes.io/docs/user-guide/annotations"
fn metadata.withAnnotationsMixin
withAnnotationsMixin(annotations)
"Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: http://kubernetes.io/docs/user-guide/annotations"
Note: This function appends passed data to existing values
fn metadata.withClusterName
withClusterName(clusterName)
"The name of the cluster which the object belongs to. This is used to distinguish resources with same name and namespace in different clusters. This field is not set anywhere right now and apiserver is going to ignore it if set in create or update request."
fn metadata.withCreationTimestamp
withCreationTimestamp(creationTimestamp)
"Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers."
fn metadata.withDeletionGracePeriodSeconds
withDeletionGracePeriodSeconds(deletionGracePeriodSeconds)
"Number of seconds allowed for this object to gracefully terminate before it will be removed from the system. Only set when deletionTimestamp is also set. May only be shortened. Read-only."
fn metadata.withDeletionTimestamp
withDeletionTimestamp(deletionTimestamp)
"Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers."
fn metadata.withFinalizers
withFinalizers(finalizers)
"Must be empty before the object is deleted from the registry. Each entry is an identifier for the responsible component that will remove the entry from the list. If the deletionTimestamp of the object is non-nil, entries in this list can only be removed. Finalizers may be processed and removed in any order. Order is NOT enforced because it introduces significant risk of stuck finalizers. finalizers is a shared field, any actor with permission can reorder it. If the finalizer list is processed in order, then this can lead to a situation in which the component responsible for the first finalizer in the list is waiting for a signal (field value, external system, or other) produced by a component responsible for a finalizer later in the list, resulting in a deadlock. Without enforced ordering finalizers are free to order amongst themselves and are not vulnerable to ordering changes in the list."
fn metadata.withFinalizersMixin
withFinalizersMixin(finalizers)
"Must be empty before the object is deleted from the registry. Each entry is an identifier for the responsible component that will remove the entry from the list. If the deletionTimestamp of the object is non-nil, entries in this list can only be removed. Finalizers may be processed and removed in any order. Order is NOT enforced because it introduces significant risk of stuck finalizers. finalizers is a shared field, any actor with permission can reorder it. If the finalizer list is processed in order, then this can lead to a situation in which the component responsible for the first finalizer in the list is waiting for a signal (field value, external system, or other) produced by a component responsible for a finalizer later in the list, resulting in a deadlock. Without enforced ordering finalizers are free to order amongst themselves and are not vulnerable to ordering changes in the list."
Note: This function appends passed data to existing values
fn metadata.withGenerateName
withGenerateName(generateName)
"GenerateName is an optional prefix, used by the server, to generate a unique name ONLY IF the Name field has not been provided. If this field is used, the name returned to the client will be different than the name passed. This value will also be combined with a unique suffix. The provided value has the same validation rules as the Name field, and may be truncated by the length of the suffix required to make the value unique on the server.\n\nIf this field is specified and the generated name exists, the server will NOT return a 409 - instead, it will either return 201 Created or 500 with Reason ServerTimeout indicating a unique name could not be found in the time allotted, and the client should retry (optionally after the time indicated in the Retry-After header).\n\nApplied only if Name is not specified. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#idempotency"
fn metadata.withGeneration
withGeneration(generation)
"A sequence number representing a specific generation of the desired state. Populated by the system. Read-only."
fn metadata.withLabels
withLabels(labels)
"Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. More info: http://kubernetes.io/docs/user-guide/labels"
fn metadata.withLabelsMixin
withLabelsMixin(labels)
"Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. More info: http://kubernetes.io/docs/user-guide/labels"
Note: This function appends passed data to existing values
fn metadata.withName
withName(name)
"Name must be unique within a namespace. Is required when creating resources, although some resources may allow a client to request the generation of an appropriate name automatically. Name is primarily intended for creation idempotence and configuration definition. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/identifiers#names"
fn metadata.withNamespace
withNamespace(namespace)
"Namespace defines the space within which each name must be unique. An empty namespace is equivalent to the \"default\" namespace, but \"default\" is the canonical representation. Not all objects are required to be scoped to a namespace - the value of this field for those objects will be empty.\n\nMust be a DNS_LABEL. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/namespaces"
fn metadata.withOwnerReferences
withOwnerReferences(ownerReferences)
"List of objects depended by this object. If ALL objects in the list have been deleted, this object will be garbage collected. If this object is managed by a controller, then an entry in this list will point to this controller, with the controller field set to true. There cannot be more than one managing controller."
fn metadata.withOwnerReferencesMixin
withOwnerReferencesMixin(ownerReferences)
"List of objects depended by this object. If ALL objects in the list have been deleted, this object will be garbage collected. If this object is managed by a controller, then an entry in this list will point to this controller, with the controller field set to true. There cannot be more than one managing controller."
Note: This function appends passed data to existing values
fn metadata.withResourceVersion
withResourceVersion(resourceVersion)
"An opaque value that represents the internal version of this object that can be used by clients to determine when objects have changed. May be used for optimistic concurrency, change detection, and the watch operation on a resource or set of resources. Clients must treat these values as opaque and passed unmodified back to the server. They may only be valid for a particular resource or set of resources.\n\nPopulated by the system. Read-only. Value must be treated as opaque by clients and . More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency"
fn metadata.withSelfLink
withSelfLink(selfLink)
"SelfLink is a URL representing this object. Populated by the system. Read-only.\n\nDEPRECATED Kubernetes will stop propagating this field in 1.20 release and the field is planned to be removed in 1.21 release."
fn metadata.withUid
withUid(uid)
"UID is the unique in time and space value for this object. It is typically generated by the server on successful creation of a resource and is not allowed to change on PUT operations.\n\nPopulated by the system. Read-only. More info: http://kubernetes.io/docs/user-guide/identifiers#uids"
obj spec
"SAMLConnector resource definition v2 from Teleport"
fn spec.withAcs
withAcs(acs)
"AssertionConsumerService is a URL for assertion consumer service on the service provider (Teleport's side)."
fn spec.withAllow_idp_initiated
withAllow_idp_initiated(allow_idp_initiated)
"AllowIDPInitiated is a flag that indicates if the connector can be used for IdP-initiated logins."
fn spec.withAttributes_to_roles
withAttributes_to_roles(attributes_to_roles)
"AttributesToRoles is a list of mappings of attribute statements to roles."
fn spec.withAttributes_to_rolesMixin
withAttributes_to_rolesMixin(attributes_to_roles)
"AttributesToRoles is a list of mappings of attribute statements to roles."
Note: This function appends passed data to existing values
fn spec.withAudience
withAudience(audience)
"Audience uniquely identifies our service provider."
fn spec.withCert
withCert(cert)
"Cert is the identity provider certificate PEM. IDP signs <Response>
responses using this certificate."
fn spec.withDisplay
withDisplay(display)
"Display controls how this connector is displayed."
fn spec.withEntity_descriptor
withEntity_descriptor(entity_descriptor)
"EntityDescriptor is XML with descriptor. It can be used to supply configuration parameters in one XML file rather than supplying them in the individual elements."
fn spec.withEntity_descriptor_url
withEntity_descriptor_url(entity_descriptor_url)
"EntityDescriptorURL is a URL that supplies a configuration XML."
fn spec.withIssuer
withIssuer(issuer)
"Issuer is the identity provider issuer."
fn spec.withProvider
withProvider(provider)
"Provider is the external identity provider."
fn spec.withService_provider_issuer
withService_provider_issuer(service_provider_issuer)
"ServiceProviderIssuer is the issuer of the service provider (Teleport)."
fn spec.withSingle_logout_url
withSingle_logout_url(single_logout_url)
"SingleLogoutURL is the SAML Single log-out URL to initiate SAML SLO (single log-out). If this is not provided, SLO is disabled."
fn spec.withSso
withSso(sso)
"SSO is the URL of the identity provider's SSO service."
obj spec.assertion_key_pair
"EncryptionKeyPair is a key pair used for decrypting SAML assertions."
fn spec.assertion_key_pair.withCert
withCert(cert)
"Cert is a PEM-encoded x509 certificate."
fn spec.assertion_key_pair.withPrivate_key
withPrivate_key(private_key)
"PrivateKey is a PEM encoded x509 private key."
obj spec.attributes_to_roles
"AttributesToRoles is a list of mappings of attribute statements to roles."
fn spec.attributes_to_roles.withName
withName(name)
"Name is an attribute statement name."
fn spec.attributes_to_roles.withRoles
withRoles(roles)
"Roles is a list of static teleport roles to map to."
fn spec.attributes_to_roles.withRolesMixin
withRolesMixin(roles)
"Roles is a list of static teleport roles to map to."
Note: This function appends passed data to existing values
fn spec.attributes_to_roles.withValue
withValue(value)
"Value is an attribute statement value to match."
obj spec.client_redirect_settings
"ClientRedirectSettings defines which client redirect URLs are allowed for non-browser SSO logins other than the standard localhost ones."
fn spec.client_redirect_settings.withAllowed_https_hostnames
withAllowed_https_hostnames(allowed_https_hostnames)
"a list of hostnames allowed for https client redirect URLs"
fn spec.client_redirect_settings.withAllowed_https_hostnamesMixin
withAllowed_https_hostnamesMixin(allowed_https_hostnames)
"a list of hostnames allowed for https client redirect URLs"
Note: This function appends passed data to existing values
fn spec.client_redirect_settings.withInsecure_allowed_cidr_ranges
withInsecure_allowed_cidr_ranges(insecure_allowed_cidr_ranges)
"a list of CIDRs allowed for HTTP or HTTPS client redirect URLs"
fn spec.client_redirect_settings.withInsecure_allowed_cidr_rangesMixin
withInsecure_allowed_cidr_rangesMixin(insecure_allowed_cidr_ranges)
"a list of CIDRs allowed for HTTP or HTTPS client redirect URLs"
Note: This function appends passed data to existing values
obj spec.signing_key_pair
"SigningKeyPair is an x509 key pair used to sign AuthnRequest."
fn spec.signing_key_pair.withCert
withCert(cert)
"Cert is a PEM-encoded x509 certificate."
fn spec.signing_key_pair.withPrivate_key
withPrivate_key(private_key)
"PrivateKey is a PEM encoded x509 private key."