Documentation ¶
Overview ¶
Package v1 is the v1 version of the API.
Package v1 is a generated protocol buffer package. It is generated from these files: github.com/openshift/origin/pkg/user/api/v1/generated.proto It has these top-level messages: Group GroupList Identity IdentityList OptionalNames User UserIdentityMapping UserList
Index ¶
- Constants
- Variables
- func Convert_api_GroupList_To_v1_GroupList(in *api.GroupList, out *GroupList, s conversion.Scope) error
- func Convert_api_Group_To_v1_Group(in *api.Group, out *Group, s conversion.Scope) error
- func Convert_api_IdentityList_To_v1_IdentityList(in *api.IdentityList, out *IdentityList, s conversion.Scope) error
- func Convert_api_Identity_To_v1_Identity(in *api.Identity, out *Identity, s conversion.Scope) error
- func Convert_api_UserIdentityMapping_To_v1_UserIdentityMapping(in *api.UserIdentityMapping, out *UserIdentityMapping, s conversion.Scope) error
- func Convert_api_UserList_To_v1_UserList(in *api.UserList, out *UserList, s conversion.Scope) error
- func Convert_api_User_To_v1_User(in *api.User, out *User, s conversion.Scope) error
- func Convert_v1_GroupList_To_api_GroupList(in *GroupList, out *api.GroupList, s conversion.Scope) error
- func Convert_v1_Group_To_api_Group(in *Group, out *api.Group, s conversion.Scope) error
- func Convert_v1_IdentityList_To_api_IdentityList(in *IdentityList, out *api.IdentityList, s conversion.Scope) error
- func Convert_v1_Identity_To_api_Identity(in *Identity, out *api.Identity, s conversion.Scope) error
- func Convert_v1_UserIdentityMapping_To_api_UserIdentityMapping(in *UserIdentityMapping, out *api.UserIdentityMapping, s conversion.Scope) error
- func Convert_v1_UserList_To_api_UserList(in *UserList, out *api.UserList, s conversion.Scope) error
- func Convert_v1_User_To_api_User(in *User, out *api.User, s conversion.Scope) error
- func DeepCopy_v1_Group(in interface{}, out interface{}, c *conversion.Cloner) error
- func DeepCopy_v1_GroupList(in interface{}, out interface{}, c *conversion.Cloner) error
- func DeepCopy_v1_Identity(in interface{}, out interface{}, c *conversion.Cloner) error
- func DeepCopy_v1_IdentityList(in interface{}, out interface{}, c *conversion.Cloner) error
- func DeepCopy_v1_User(in interface{}, out interface{}, c *conversion.Cloner) error
- func DeepCopy_v1_UserIdentityMapping(in interface{}, out interface{}, c *conversion.Cloner) error
- func DeepCopy_v1_UserList(in interface{}, out interface{}, c *conversion.Cloner) error
- func RegisterConversions(scheme *runtime.Scheme) error
- func RegisterDeepCopies(scheme *runtime.Scheme) error
- type Group
- func (*Group) Descriptor() ([]byte, []int)
- func (obj *Group) GetObjectKind() unversioned.ObjectKind
- func (m *Group) Marshal() (data []byte, err error)
- func (m *Group) MarshalTo(data []byte) (int, error)
- func (*Group) ProtoMessage()
- func (m *Group) Reset()
- func (m *Group) Size() (n int)
- func (this *Group) String() string
- func (Group) SwaggerDoc() map[string]string
- func (m *Group) Unmarshal(data []byte) error
- type GroupList
- func (*GroupList) Descriptor() ([]byte, []int)
- func (obj *GroupList) GetObjectKind() unversioned.ObjectKind
- func (m *GroupList) Marshal() (data []byte, err error)
- func (m *GroupList) MarshalTo(data []byte) (int, error)
- func (*GroupList) ProtoMessage()
- func (m *GroupList) Reset()
- func (m *GroupList) Size() (n int)
- func (this *GroupList) String() string
- func (GroupList) SwaggerDoc() map[string]string
- func (m *GroupList) Unmarshal(data []byte) error
- type Identity
- func (*Identity) Descriptor() ([]byte, []int)
- func (obj *Identity) GetObjectKind() unversioned.ObjectKind
- func (m *Identity) Marshal() (data []byte, err error)
- func (m *Identity) MarshalTo(data []byte) (int, error)
- func (*Identity) ProtoMessage()
- func (m *Identity) Reset()
- func (m *Identity) Size() (n int)
- func (this *Identity) String() string
- func (Identity) SwaggerDoc() map[string]string
- func (m *Identity) Unmarshal(data []byte) error
- type IdentityList
- func (*IdentityList) Descriptor() ([]byte, []int)
- func (obj *IdentityList) GetObjectKind() unversioned.ObjectKind
- func (m *IdentityList) Marshal() (data []byte, err error)
- func (m *IdentityList) MarshalTo(data []byte) (int, error)
- func (*IdentityList) ProtoMessage()
- func (m *IdentityList) Reset()
- func (m *IdentityList) Size() (n int)
- func (this *IdentityList) String() string
- func (IdentityList) SwaggerDoc() map[string]string
- func (m *IdentityList) Unmarshal(data []byte) error
- type OptionalNames
- func (*OptionalNames) Descriptor() ([]byte, []int)
- func (m OptionalNames) Marshal() (data []byte, err error)
- func (m OptionalNames) MarshalTo(data []byte) (int, error)
- func (*OptionalNames) ProtoMessage()
- func (m *OptionalNames) Reset()
- func (m OptionalNames) Size() (n int)
- func (t OptionalNames) String() string
- func (m *OptionalNames) Unmarshal(data []byte) error
- type User
- func (*User) Descriptor() ([]byte, []int)
- func (obj *User) GetObjectKind() unversioned.ObjectKind
- func (m *User) Marshal() (data []byte, err error)
- func (m *User) MarshalTo(data []byte) (int, error)
- func (*User) ProtoMessage()
- func (m *User) Reset()
- func (m *User) Size() (n int)
- func (this *User) String() string
- func (User) SwaggerDoc() map[string]string
- func (m *User) Unmarshal(data []byte) error
- type UserIdentityMapping
- func (*UserIdentityMapping) Descriptor() ([]byte, []int)
- func (obj *UserIdentityMapping) GetObjectKind() unversioned.ObjectKind
- func (m *UserIdentityMapping) Marshal() (data []byte, err error)
- func (m *UserIdentityMapping) MarshalTo(data []byte) (int, error)
- func (*UserIdentityMapping) ProtoMessage()
- func (m *UserIdentityMapping) Reset()
- func (m *UserIdentityMapping) Size() (n int)
- func (this *UserIdentityMapping) String() string
- func (UserIdentityMapping) SwaggerDoc() map[string]string
- func (m *UserIdentityMapping) Unmarshal(data []byte) error
- type UserList
- func (*UserList) Descriptor() ([]byte, []int)
- func (obj *UserList) GetObjectKind() unversioned.ObjectKind
- func (m *UserList) Marshal() (data []byte, err error)
- func (m *UserList) MarshalTo(data []byte) (int, error)
- func (*UserList) ProtoMessage()
- func (m *UserList) Reset()
- func (m *UserList) Size() (n int)
- func (this *UserList) String() string
- func (UserList) SwaggerDoc() map[string]string
- func (m *UserList) Unmarshal(data []byte) error
Constants ¶
const GroupName = ""
Variables ¶
var ( ErrInvalidLengthGenerated = fmt.Errorf("proto: negative length found during unmarshaling") ErrIntOverflowGenerated = fmt.Errorf("proto: integer overflow") )
var ( SchemeBuilder = runtime.NewSchemeBuilder(addKnownTypes, addConversionFuncs) AddToScheme = SchemeBuilder.AddToScheme )
var SchemeGroupVersion = unversioned.GroupVersion{Group: GroupName, Version: "v1"}
SchemeGroupVersion is group version used to register these objects
Functions ¶
func Convert_api_IdentityList_To_v1_IdentityList ¶
func Convert_api_IdentityList_To_v1_IdentityList(in *api.IdentityList, out *IdentityList, s conversion.Scope) error
func Convert_api_UserIdentityMapping_To_v1_UserIdentityMapping ¶
func Convert_api_UserIdentityMapping_To_v1_UserIdentityMapping(in *api.UserIdentityMapping, out *UserIdentityMapping, s conversion.Scope) error
func Convert_v1_IdentityList_To_api_IdentityList ¶
func Convert_v1_IdentityList_To_api_IdentityList(in *IdentityList, out *api.IdentityList, s conversion.Scope) error
func Convert_v1_UserIdentityMapping_To_api_UserIdentityMapping ¶
func Convert_v1_UserIdentityMapping_To_api_UserIdentityMapping(in *UserIdentityMapping, out *api.UserIdentityMapping, s conversion.Scope) error
func DeepCopy_v1_Group ¶
func DeepCopy_v1_Group(in interface{}, out interface{}, c *conversion.Cloner) error
func DeepCopy_v1_GroupList ¶
func DeepCopy_v1_GroupList(in interface{}, out interface{}, c *conversion.Cloner) error
func DeepCopy_v1_Identity ¶
func DeepCopy_v1_Identity(in interface{}, out interface{}, c *conversion.Cloner) error
func DeepCopy_v1_IdentityList ¶
func DeepCopy_v1_IdentityList(in interface{}, out interface{}, c *conversion.Cloner) error
func DeepCopy_v1_User ¶
func DeepCopy_v1_User(in interface{}, out interface{}, c *conversion.Cloner) error
func DeepCopy_v1_UserIdentityMapping ¶
func DeepCopy_v1_UserIdentityMapping(in interface{}, out interface{}, c *conversion.Cloner) error
func DeepCopy_v1_UserList ¶
func DeepCopy_v1_UserList(in interface{}, out interface{}, c *conversion.Cloner) error
func RegisterConversions ¶
RegisterConversions adds conversion functions to the given scheme. Public to allow building arbitrary schemes.
func RegisterDeepCopies ¶
RegisterDeepCopies adds deep-copy functions to the given scheme. Public to allow building arbitrary schemes.
Types ¶
type Group ¶
type Group struct { unversioned.TypeMeta `json:",inline"` // Standard object's metadata. kapi.ObjectMeta `json:"metadata,omitempty" protobuf:"bytes,1,opt,name=metadata"` // Users is the list of users in this group. Users OptionalNames `json:"users" protobuf:"bytes,2,rep,name=users"` }
Group represents a referenceable set of Users
func (*Group) Descriptor ¶
func (*Group) GetObjectKind ¶
func (obj *Group) GetObjectKind() unversioned.ObjectKind
func (*Group) ProtoMessage ¶
func (*Group) ProtoMessage()
func (Group) SwaggerDoc ¶
type GroupList ¶
type GroupList struct { unversioned.TypeMeta `json:",inline"` // Standard object's metadata. unversioned.ListMeta `json:"metadata,omitempty" protobuf:"bytes,1,opt,name=metadata"` // Items is the list of groups Items []Group `json:"items" protobuf:"bytes,2,rep,name=items"` }
GroupList is a collection of Groups
func (*GroupList) Descriptor ¶
func (*GroupList) GetObjectKind ¶
func (obj *GroupList) GetObjectKind() unversioned.ObjectKind
func (*GroupList) ProtoMessage ¶
func (*GroupList) ProtoMessage()
func (GroupList) SwaggerDoc ¶
type Identity ¶
type Identity struct { unversioned.TypeMeta `json:",inline"` // Standard object's metadata. kapi.ObjectMeta `json:"metadata,omitempty" protobuf:"bytes,1,opt,name=metadata"` // ProviderName is the source of identity information ProviderName string `json:"providerName" protobuf:"bytes,2,opt,name=providerName"` // ProviderUserName uniquely represents this identity in the scope of the provider ProviderUserName string `json:"providerUserName" protobuf:"bytes,3,opt,name=providerUserName"` // User is a reference to the user this identity is associated with // Both Name and UID must be set User kapi.ObjectReference `json:"user" protobuf:"bytes,4,opt,name=user"` // Extra holds extra information about this identity Extra map[string]string `json:"extra,omitempty" protobuf:"bytes,5,rep,name=extra"` }
Identity records a successful authentication of a user with an identity provider. The information about the source of authentication is stored on the identity, and the identity is then associated with a single user object. Multiple identities can reference a single user. Information retrieved from the authentication provider is stored in the extra field using a schema determined by the provider.
func (*Identity) Descriptor ¶
func (*Identity) GetObjectKind ¶
func (obj *Identity) GetObjectKind() unversioned.ObjectKind
func (*Identity) ProtoMessage ¶
func (*Identity) ProtoMessage()
func (Identity) SwaggerDoc ¶
type IdentityList ¶
type IdentityList struct { unversioned.TypeMeta `json:",inline"` // Standard object's metadata. unversioned.ListMeta `json:"metadata,omitempty" protobuf:"bytes,1,opt,name=metadata"` // Items is the list of identities Items []Identity `json:"items" protobuf:"bytes,2,rep,name=items"` }
IdentityList is a collection of Identities
func (*IdentityList) Descriptor ¶
func (*IdentityList) Descriptor() ([]byte, []int)
func (*IdentityList) GetObjectKind ¶
func (obj *IdentityList) GetObjectKind() unversioned.ObjectKind
func (*IdentityList) Marshal ¶
func (m *IdentityList) Marshal() (data []byte, err error)
func (*IdentityList) ProtoMessage ¶
func (*IdentityList) ProtoMessage()
func (*IdentityList) Reset ¶
func (m *IdentityList) Reset()
func (*IdentityList) Size ¶
func (m *IdentityList) Size() (n int)
func (*IdentityList) String ¶
func (this *IdentityList) String() string
func (IdentityList) SwaggerDoc ¶
func (IdentityList) SwaggerDoc() map[string]string
func (*IdentityList) Unmarshal ¶
func (m *IdentityList) Unmarshal(data []byte) error
type OptionalNames ¶
type OptionalNames []string
OptionalNames is an array that may also be left nil to distinguish between set and unset. +protobuf.nullable=true +protobuf.options.(gogoproto.goproto_stringer)=false
func (*OptionalNames) Descriptor ¶
func (*OptionalNames) Descriptor() ([]byte, []int)
func (OptionalNames) Marshal ¶
func (m OptionalNames) Marshal() (data []byte, err error)
func (*OptionalNames) ProtoMessage ¶
func (*OptionalNames) ProtoMessage()
func (*OptionalNames) Reset ¶
func (m *OptionalNames) Reset()
func (OptionalNames) Size ¶
func (m OptionalNames) Size() (n int)
func (OptionalNames) String ¶
func (t OptionalNames) String() string
func (*OptionalNames) Unmarshal ¶
func (m *OptionalNames) Unmarshal(data []byte) error
type User ¶
type User struct { unversioned.TypeMeta `json:",inline"` // Standard object's metadata. kapi.ObjectMeta `json:"metadata,omitempty" protobuf:"bytes,1,opt,name=metadata"` // FullName is the full name of user FullName string `json:"fullName,omitempty" protobuf:"bytes,2,opt,name=fullName"` // Identities are the identities associated with this user Identities []string `json:"identities" protobuf:"bytes,3,rep,name=identities"` // Groups are the groups that this user is a member of Groups []string `json:"groups" protobuf:"bytes,4,rep,name=groups"` }
Upon log in, every user of the system receives a User and Identity resource. Administrators may directly manipulate the attributes of the users for their own tracking, or set groups via the API. The user name is unique and is chosen based on the value provided by the identity provider - if a user already exists with the incoming name, the user name may have a number appended to it depending on the configuration of the system.
func (*User) Descriptor ¶
func (*User) GetObjectKind ¶
func (obj *User) GetObjectKind() unversioned.ObjectKind
func (*User) ProtoMessage ¶
func (*User) ProtoMessage()
func (User) SwaggerDoc ¶
type UserIdentityMapping ¶
type UserIdentityMapping struct { unversioned.TypeMeta `json:",inline"` // Standard object's metadata. kapi.ObjectMeta `json:"metadata,omitempty" protobuf:"bytes,1,opt,name=metadata"` // Identity is a reference to an identity Identity kapi.ObjectReference `json:"identity,omitempty" protobuf:"bytes,2,opt,name=identity"` // User is a reference to a user User kapi.ObjectReference `json:"user,omitempty" protobuf:"bytes,3,opt,name=user"` }
UserIdentityMapping maps a user to an identity
func (*UserIdentityMapping) Descriptor ¶
func (*UserIdentityMapping) Descriptor() ([]byte, []int)
func (*UserIdentityMapping) GetObjectKind ¶
func (obj *UserIdentityMapping) GetObjectKind() unversioned.ObjectKind
func (*UserIdentityMapping) Marshal ¶
func (m *UserIdentityMapping) Marshal() (data []byte, err error)
func (*UserIdentityMapping) MarshalTo ¶
func (m *UserIdentityMapping) MarshalTo(data []byte) (int, error)
func (*UserIdentityMapping) ProtoMessage ¶
func (*UserIdentityMapping) ProtoMessage()
func (*UserIdentityMapping) Reset ¶
func (m *UserIdentityMapping) Reset()
func (*UserIdentityMapping) Size ¶
func (m *UserIdentityMapping) Size() (n int)
func (*UserIdentityMapping) String ¶
func (this *UserIdentityMapping) String() string
func (UserIdentityMapping) SwaggerDoc ¶
func (UserIdentityMapping) SwaggerDoc() map[string]string
func (*UserIdentityMapping) Unmarshal ¶
func (m *UserIdentityMapping) Unmarshal(data []byte) error
type UserList ¶
type UserList struct { unversioned.TypeMeta `json:",inline"` // Standard object's metadata. unversioned.ListMeta `json:"metadata,omitempty" protobuf:"bytes,1,opt,name=metadata"` // Items is the list of users Items []User `json:"items" protobuf:"bytes,2,rep,name=items"` }
UserList is a collection of Users
func (*UserList) Descriptor ¶
func (*UserList) GetObjectKind ¶
func (obj *UserList) GetObjectKind() unversioned.ObjectKind
func (*UserList) ProtoMessage ¶
func (*UserList) ProtoMessage()