Documentation

Overview

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

    Index

    Constants

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

    Variables

    View Source
    var (
    	SchemeBuilder runtime.SchemeBuilder
    
    	AddToScheme = localSchemeBuilder.AddToScheme
    )
    View Source
    var SchemeGroupVersion = schema.GroupVersion{Group: GroupName, Version: "v1alpha1"}

      SchemeGroupVersion is group version used to register these objects.

      Functions

      func Convert_login_ClusterCredential_To_v1alpha1_ClusterCredential

      func Convert_login_ClusterCredential_To_v1alpha1_ClusterCredential(in *login.ClusterCredential, out *ClusterCredential, s conversion.Scope) error

        Convert_login_ClusterCredential_To_v1alpha1_ClusterCredential is an autogenerated conversion function.

        func Convert_login_TokenCredentialRequestList_To_v1alpha1_TokenCredentialRequestList

        func Convert_login_TokenCredentialRequestList_To_v1alpha1_TokenCredentialRequestList(in *login.TokenCredentialRequestList, out *TokenCredentialRequestList, s conversion.Scope) error

          Convert_login_TokenCredentialRequestList_To_v1alpha1_TokenCredentialRequestList is an autogenerated conversion function.

          func Convert_login_TokenCredentialRequestSpec_To_v1alpha1_TokenCredentialRequestSpec

          func Convert_login_TokenCredentialRequestSpec_To_v1alpha1_TokenCredentialRequestSpec(in *login.TokenCredentialRequestSpec, out *TokenCredentialRequestSpec, s conversion.Scope) error

            Convert_login_TokenCredentialRequestSpec_To_v1alpha1_TokenCredentialRequestSpec is an autogenerated conversion function.

            func Convert_login_TokenCredentialRequestStatus_To_v1alpha1_TokenCredentialRequestStatus

            func Convert_login_TokenCredentialRequestStatus_To_v1alpha1_TokenCredentialRequestStatus(in *login.TokenCredentialRequestStatus, out *TokenCredentialRequestStatus, s conversion.Scope) error

              Convert_login_TokenCredentialRequestStatus_To_v1alpha1_TokenCredentialRequestStatus is an autogenerated conversion function.

              func Convert_login_TokenCredentialRequest_To_v1alpha1_TokenCredentialRequest

              func Convert_login_TokenCredentialRequest_To_v1alpha1_TokenCredentialRequest(in *login.TokenCredentialRequest, out *TokenCredentialRequest, s conversion.Scope) error

                Convert_login_TokenCredentialRequest_To_v1alpha1_TokenCredentialRequest is an autogenerated conversion function.

                func Convert_v1alpha1_ClusterCredential_To_login_ClusterCredential

                func Convert_v1alpha1_ClusterCredential_To_login_ClusterCredential(in *ClusterCredential, out *login.ClusterCredential, s conversion.Scope) error

                  Convert_v1alpha1_ClusterCredential_To_login_ClusterCredential is an autogenerated conversion function.

                  func Convert_v1alpha1_TokenCredentialRequestList_To_login_TokenCredentialRequestList

                  func Convert_v1alpha1_TokenCredentialRequestList_To_login_TokenCredentialRequestList(in *TokenCredentialRequestList, out *login.TokenCredentialRequestList, s conversion.Scope) error

                    Convert_v1alpha1_TokenCredentialRequestList_To_login_TokenCredentialRequestList is an autogenerated conversion function.

                    func Convert_v1alpha1_TokenCredentialRequestSpec_To_login_TokenCredentialRequestSpec

                    func Convert_v1alpha1_TokenCredentialRequestSpec_To_login_TokenCredentialRequestSpec(in *TokenCredentialRequestSpec, out *login.TokenCredentialRequestSpec, s conversion.Scope) error

                      Convert_v1alpha1_TokenCredentialRequestSpec_To_login_TokenCredentialRequestSpec is an autogenerated conversion function.

                      func Convert_v1alpha1_TokenCredentialRequestStatus_To_login_TokenCredentialRequestStatus

                      func Convert_v1alpha1_TokenCredentialRequestStatus_To_login_TokenCredentialRequestStatus(in *TokenCredentialRequestStatus, out *login.TokenCredentialRequestStatus, s conversion.Scope) error

                        Convert_v1alpha1_TokenCredentialRequestStatus_To_login_TokenCredentialRequestStatus is an autogenerated conversion function.

                        func Convert_v1alpha1_TokenCredentialRequest_To_login_TokenCredentialRequest

                        func Convert_v1alpha1_TokenCredentialRequest_To_login_TokenCredentialRequest(in *TokenCredentialRequest, out *login.TokenCredentialRequest, s conversion.Scope) error

                          Convert_v1alpha1_TokenCredentialRequest_To_login_TokenCredentialRequest is an autogenerated conversion function.

                          func RegisterConversions

                          func RegisterConversions(s *runtime.Scheme) error

                            RegisterConversions adds conversion functions to the given scheme. Public to allow building arbitrary schemes.

                            func RegisterDefaults

                            func RegisterDefaults(scheme *runtime.Scheme) error

                              RegisterDefaults adds defaulters functions to the given scheme. Public to allow building arbitrary schemes. All generated defaulters are covering - they call all nested defaulters.

                              func Resource

                              func Resource(resource string) schema.GroupResource

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

                                Types

                                type ClusterCredential

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

                                  ClusterCredential is the cluster-specific credential returned on a successful credential request. It contains either a valid bearer token or a valid TLS certificate and corresponding private key for the 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   `json:",inline"`
                                      	metav1.ObjectMeta `json:"metadata,omitempty"`
                                      
                                      	Spec   TokenCredentialRequestSpec   `json:"spec,omitempty"`
                                      	Status TokenCredentialRequestStatus `json:"status,omitempty"`
                                      }

                                        TokenCredentialRequest submits an IDP-specific credential to Pinniped in exchange for a cluster-specific credential. +genclient +genclient:nonNamespaced +genclient:onlyVerbs=create +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 `json:",inline"`
                                              	metav1.ListMeta `json:"metadata,omitempty"`
                                              
                                              	Items []TokenCredentialRequest `json:"items"`
                                              }

                                                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 `json:"token,omitempty"`
                                                      
                                                      	// Reference to an authenticator which can validate this credential request.
                                                      	Authenticator corev1.TypedLocalObjectReference `json:"authenticator"`
                                                      }

                                                        TokenCredentialRequestSpec is the specification of a TokenCredentialRequest, expected on requests to the Pinniped API.

                                                        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 Credential will be returned for a successful credential request.
                                                            	// +optional
                                                            	Credential *ClusterCredential `json:"credential,omitempty"`
                                                            
                                                            	// An error message will be returned for an unsuccessful credential request.
                                                            	// +optional
                                                            	Message *string `json:"message,omitempty"`
                                                            }

                                                              TokenCredentialRequestStatus is the status of a TokenCredentialRequest, returned on responses to the Pinniped API.

                                                              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.