k8c.io/api/v3@v3.0.0-20230904060738-b0a93889c0b6/pkg/apis/ee.kubermatic/v1/user_project_binding.go (about)

     1  /*
     2  Copyright 2023 The Kubermatic Kubernetes Platform contributors.
     3  
     4  Licensed under the Apache License, Version 2.0 (the "License");
     5  you may not use this file except in compliance with the License.
     6  You may obtain a copy of the License at
     7  
     8      http://www.apache.org/licenses/LICENSE-2.0
     9  
    10  Unless required by applicable law or agreed to in writing, software
    11  distributed under the License is distributed on an "AS IS" BASIS,
    12  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
    13  See the License for the specific language governing permissions and
    14  limitations under the License.
    15  */
    16  
    17  package v1
    18  
    19  import (
    20  	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
    21  )
    22  
    23  // +genclient
    24  // +kubebuilder:resource:scope=Cluster
    25  // +kubebuilder:object:generate=true
    26  // +kubebuilder:object:root=true
    27  // +kubebuilder:printcolumn:JSONPath=".spec.projectID",name="ProjectID",type="string"
    28  // +kubebuilder:printcolumn:JSONPath=".spec.group",name="Group",type="string"
    29  // +kubebuilder:printcolumn:JSONPath=".spec.userEmail",name="UserEmail",type="string"
    30  // +kubebuilder:printcolumn:JSONPath=".metadata.creationTimestamp",name="Age",type="date"
    31  
    32  // UserProjectBinding specifies a binding between a user and a project
    33  // This resource is used by the user management to manipulate members of the given project.
    34  type UserProjectBinding struct {
    35  	metav1.TypeMeta   `json:",inline"`
    36  	metav1.ObjectMeta `json:"metadata,omitempty"`
    37  
    38  	Spec UserProjectBindingSpec `json:"spec,omitempty"`
    39  }
    40  
    41  // UserProjectBindingSpec specifies a user.
    42  type UserProjectBindingSpec struct {
    43  	// UserEmail is the email of the user that is bound to the given project.
    44  	UserEmail string `json:"userEmail"`
    45  	// ProjectID is the name of the target project.
    46  	ProjectID string `json:"projectID"`
    47  
    48  	// TODO: add "Role" field and deprecate "Group" in favour of it to be in line with GroupProjectBinding resource.
    49  
    50  	// Group is the user's group, determining their permissions within the project.
    51  	// Must be one of `owners`, `editors`, `viewers` or `projectmanagers`.
    52  	Group string `json:"group"`
    53  }
    54  
    55  // +kubebuilder:object:generate=true
    56  // +kubebuilder:object:root=true
    57  
    58  // UserProjectBindingList is a list of users.
    59  type UserProjectBindingList struct {
    60  	metav1.TypeMeta `json:",inline"`
    61  	metav1.ListMeta `json:"metadata,omitempty"`
    62  
    63  	Items []UserProjectBinding `json:"items"`
    64  }