Documentation

Overview

    Package login is the internal version of the Pinniped login API.

    Index

    Constants

    View Source
    const GroupName = "login.concierge.pinniped.dev"

    Variables

    View Source
    var (
    	SchemeBuilder = runtime.NewSchemeBuilder(addKnownTypes)
    	AddToScheme   = SchemeBuilder.AddToScheme
    )
    View Source
    var SchemeGroupVersion = schema.GroupVersion{Group: GroupName, Version: runtime.APIVersionInternal}

      SchemeGroupVersion is group version used to register these objects.

      Functions

      func Kind

      func Kind(kind string) schema.GroupKind

        Kind takes an unqualified kind and returns back a Group qualified GroupKind.

        func Resource

        func Resource(resource string) schema.GroupResource

          Resource takes an unqualified resource and returns back a Group qualified GroupResource.

          Types

          type ClusterCredential

          type ClusterCredential struct {
          	// ExpirationTimestamp indicates a time when the provided credentials expire.
          	ExpirationTimestamp metav1.Time
          
          	// Token is a bearer token used by the client for request authentication.
          	Token string
          
          	// PEM-encoded client TLS certificates (including intermediates, if any).
          	ClientCertificateData string
          
          	// PEM-encoded private key for the above certificate.
          	ClientKeyData string
          }

            ClusterCredential is a credential (token or certificate) which is valid on the Kubernetes cluster.

            func (*ClusterCredential) DeepCopy

            func (in *ClusterCredential) DeepCopy() *ClusterCredential

              DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ClusterCredential.

              func (*ClusterCredential) DeepCopyInto

              func (in *ClusterCredential) DeepCopyInto(out *ClusterCredential)

                DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

                type TokenCredentialRequest

                type TokenCredentialRequest struct {
                	metav1.TypeMeta
                	metav1.ObjectMeta
                
                	Spec   TokenCredentialRequestSpec
                	Status TokenCredentialRequestStatus
                }

                  TokenCredentialRequest submits an IDP-specific credential to Pinniped in exchange for a cluster-specific credential. +k8s:deepcopy-gen:interfaces=k8s.io/apimachinery/pkg/runtime.Object

                  func (*TokenCredentialRequest) DeepCopy

                    DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new TokenCredentialRequest.

                    func (*TokenCredentialRequest) DeepCopyInto

                    func (in *TokenCredentialRequest) DeepCopyInto(out *TokenCredentialRequest)

                      DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

                      func (*TokenCredentialRequest) DeepCopyObject

                      func (in *TokenCredentialRequest) DeepCopyObject() runtime.Object

                        DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.

                        type TokenCredentialRequestList

                        type TokenCredentialRequestList struct {
                        	metav1.TypeMeta
                        	metav1.ListMeta
                        
                        	// Items is a list of TokenCredentialRequest
                        	Items []TokenCredentialRequest
                        }

                          TokenCredentialRequestList is a list of TokenCredentialRequest objects. +k8s:deepcopy-gen:interfaces=k8s.io/apimachinery/pkg/runtime.Object

                          func (*TokenCredentialRequestList) DeepCopy

                            DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new TokenCredentialRequestList.

                            func (*TokenCredentialRequestList) DeepCopyInto

                              DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

                              func (*TokenCredentialRequestList) DeepCopyObject

                              func (in *TokenCredentialRequestList) DeepCopyObject() runtime.Object

                                DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.

                                type TokenCredentialRequestSpec

                                type TokenCredentialRequestSpec struct {
                                	// Bearer token supplied with the credential request.
                                	Token string
                                
                                	// Reference to an authenticator which can validate this credential request.
                                	Authenticator corev1.TypedLocalObjectReference
                                }

                                func (*TokenCredentialRequestSpec) DeepCopy

                                  DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new TokenCredentialRequestSpec.

                                  func (*TokenCredentialRequestSpec) DeepCopyInto

                                    DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

                                    type TokenCredentialRequestStatus

                                    type TokenCredentialRequestStatus struct {
                                    	// A ClusterCredential will be returned for a successful credential request.
                                    	// +optional
                                    	Credential *ClusterCredential
                                    
                                    	// An error message will be returned for an unsuccessful credential request.
                                    	// +optional
                                    	Message *string
                                    }

                                    func (*TokenCredentialRequestStatus) DeepCopy

                                      DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new TokenCredentialRequestStatus.

                                      func (*TokenCredentialRequestStatus) DeepCopyInto

                                        DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

                                        Directories

                                        Path Synopsis
                                        Package v1alpha1 is the v1alpha1 version of the Pinniped login API.
                                        Package v1alpha1 is the v1alpha1 version of the Pinniped login API.