v1

package
v3.6.0-alpha.0+incompa... Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Mar 21, 2017 License: Apache-2.0 Imports: 16 Imported by: 0

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

View Source 
const (
	GroupName       = "user.openshift.io"
	LegacyGroupName = ""
)

Variables

View Source 
var (
	ErrInvalidLengthGenerated = fmt.Errorf("proto: negative length found during unmarshaling")
	ErrIntOverflowGenerated   = fmt.Errorf("proto: integer overflow")
)
View Source 
var (
	SchemeGroupVersion       = unversioned.GroupVersion{Group: GroupName, Version: "v1"}
	LegacySchemeGroupVersion = unversioned.GroupVersion{Group: LegacyGroupName, Version: "v1"}

	LegacySchemeBuilder    = runtime.NewSchemeBuilder(addLegacyKnownTypes, addConversionFuncs)
	AddToSchemeInCoreGroup = LegacySchemeBuilder.AddToScheme

	SchemeBuilder = runtime.NewSchemeBuilder(addKnownTypes, addConversionFuncs)
	AddToScheme   = SchemeBuilder.AddToScheme
)

SchemeGroupVersion is group version used to register these objects

Functions

func Convert_api_GroupList_To_v1_GroupList added in v1.3.0 

func Convert_api_GroupList_To_v1_GroupList(in *api.GroupList, out *GroupList, s conversion.Scope) error

func Convert_api_Group_To_v1_Group added in v1.3.0 

func Convert_api_Group_To_v1_Group(in *api.Group, out *Group, s conversion.Scope) error

func Convert_api_IdentityList_To_v1_IdentityList added in v1.3.0 

func Convert_api_IdentityList_To_v1_IdentityList(in *api.IdentityList, out *IdentityList, s conversion.Scope) error

func Convert_api_Identity_To_v1_Identity added in v1.3.0 

func Convert_api_Identity_To_v1_Identity(in *api.Identity, out *Identity, s conversion.Scope) error

func Convert_api_UserIdentityMapping_To_v1_UserIdentityMapping added in v1.3.0 

func Convert_api_UserIdentityMapping_To_v1_UserIdentityMapping(in *api.UserIdentityMapping, out *UserIdentityMapping, s conversion.Scope) error

func Convert_api_UserList_To_v1_UserList added in v1.3.0 

func Convert_api_UserList_To_v1_UserList(in *api.UserList, out *UserList, s conversion.Scope) error

func Convert_api_User_To_v1_User added in v1.3.0 

func Convert_api_User_To_v1_User(in *api.User, out *User, s conversion.Scope) error

func Convert_v1_GroupList_To_api_GroupList added in v1.3.0 

func Convert_v1_GroupList_To_api_GroupList(in *GroupList, out *api.GroupList, s conversion.Scope) error

func Convert_v1_Group_To_api_Group added in v1.3.0 

func Convert_v1_Group_To_api_Group(in *Group, out *api.Group, s conversion.Scope) error

func Convert_v1_IdentityList_To_api_IdentityList added in v1.3.0 

func Convert_v1_IdentityList_To_api_IdentityList(in *IdentityList, out *api.IdentityList, s conversion.Scope) error

func Convert_v1_Identity_To_api_Identity added in v1.3.0 

func Convert_v1_Identity_To_api_Identity(in *Identity, out *api.Identity, s conversion.Scope) error

func Convert_v1_UserIdentityMapping_To_api_UserIdentityMapping added in v1.3.0 

func Convert_v1_UserIdentityMapping_To_api_UserIdentityMapping(in *UserIdentityMapping, out *api.UserIdentityMapping, s conversion.Scope) error

func Convert_v1_UserList_To_api_UserList added in v1.3.0 

func Convert_v1_UserList_To_api_UserList(in *UserList, out *api.UserList, s conversion.Scope) error

func Convert_v1_User_To_api_User added in v1.3.0 

func Convert_v1_User_To_api_User(in *User, out *api.User, s conversion.Scope) error

func DeepCopy_v1_Group added in v1.3.0 

func DeepCopy_v1_Group(in interface{}, out interface{}, c *conversion.Cloner) error

func DeepCopy_v1_GroupList added in v1.3.0 

func DeepCopy_v1_GroupList(in interface{}, out interface{}, c *conversion.Cloner) error

func DeepCopy_v1_Identity added in v1.3.0 

func DeepCopy_v1_Identity(in interface{}, out interface{}, c *conversion.Cloner) error

func DeepCopy_v1_IdentityList added in v1.3.0 

func DeepCopy_v1_IdentityList(in interface{}, out interface{}, c *conversion.Cloner) error

func DeepCopy_v1_User added in v1.3.0 

func DeepCopy_v1_User(in interface{}, out interface{}, c *conversion.Cloner) error

func DeepCopy_v1_UserIdentityMapping added in v1.3.0 

func DeepCopy_v1_UserIdentityMapping(in interface{}, out interface{}, c *conversion.Cloner) error

func DeepCopy_v1_UserList added in v1.3.0 

func DeepCopy_v1_UserList(in interface{}, out interface{}, c *conversion.Cloner) error

func RegisterConversions added in v1.4.0 

func RegisterConversions(scheme *runtime.Scheme) error

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

func RegisterDeepCopies added in v1.4.0 

func RegisterDeepCopies(scheme *runtime.Scheme) error

RegisterDeepCopies adds deep-copy functions to the given scheme. Public to allow building arbitrary schemes.

Types

type Group added in v1.0.4 

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 added in v1.4.0 

func (*Group) Descriptor() ([]byte, []int)

func (*Group) Marshal added in v1.3.0 

func (m *Group) Marshal() (data []byte, err error)

func (*Group) MarshalTo added in v1.3.0 

func (m *Group) MarshalTo(data []byte) (int, error)

func (*Group) ProtoMessage added in v1.3.0 

func (*Group) ProtoMessage()

func (*Group) Reset added in v1.3.0 

func (m *Group) Reset()

func (*Group) Size added in v1.3.0 

func (m *Group) Size() (n int)

func (*Group) String added in v1.3.0 

func (this *Group) String() string

func (Group) SwaggerDoc added in v1.1.4 

func (Group) SwaggerDoc() map[string]string

func (*Group) Unmarshal added in v1.3.0 

func (m *Group) Unmarshal(data []byte) error

type GroupList added in v1.0.4 

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 added in v1.4.0 

func (*GroupList) Descriptor() ([]byte, []int)

func (*GroupList) Marshal added in v1.3.0 

func (m *GroupList) Marshal() (data []byte, err error)

func (*GroupList) MarshalTo added in v1.3.0 

func (m *GroupList) MarshalTo(data []byte) (int, error)

func (*GroupList) ProtoMessage added in v1.3.0 

func (*GroupList) ProtoMessage()

func (*GroupList) Reset added in v1.3.0 

func (m *GroupList) Reset()

func (*GroupList) Size added in v1.3.0 

func (m *GroupList) Size() (n int)

func (*GroupList) String added in v1.3.0 

func (this *GroupList) String() string

func (GroupList) SwaggerDoc added in v1.1.4 

func (GroupList) SwaggerDoc() map[string]string

func (*GroupList) Unmarshal added in v1.3.0 

func (m *GroupList) Unmarshal(data []byte) error

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 added in v1.4.0 

func (*Identity) Descriptor() ([]byte, []int)

func (*Identity) Marshal added in v1.3.0 

func (m *Identity) Marshal() (data []byte, err error)

func (*Identity) MarshalTo added in v1.3.0 

func (m *Identity) MarshalTo(data []byte) (int, error)

func (*Identity) ProtoMessage added in v1.3.0 

func (*Identity) ProtoMessage()

func (*Identity) Reset added in v1.3.0 

func (m *Identity) Reset()

func (*Identity) Size added in v1.3.0 

func (m *Identity) Size() (n int)

func (*Identity) String added in v1.3.0 

func (this *Identity) String() string

func (Identity) SwaggerDoc added in v1.1.4 

func (Identity) SwaggerDoc() map[string]string

func (*Identity) Unmarshal added in v1.3.0 

func (m *Identity) Unmarshal(data []byte) error

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 added in v1.4.0 

func (*IdentityList) Descriptor() ([]byte, []int)

func (*IdentityList) Marshal added in v1.3.0 

func (m *IdentityList) Marshal() (data []byte, err error)

func (*IdentityList) MarshalTo added in v1.3.0 

func (m *IdentityList) MarshalTo(data []byte) (int, error)

func (*IdentityList) ProtoMessage added in v1.3.0 

func (*IdentityList) ProtoMessage()

func (*IdentityList) Reset added in v1.3.0 

func (m *IdentityList) Reset()

func (*IdentityList) Size added in v1.3.0 

func (m *IdentityList) Size() (n int)

func (*IdentityList) String added in v1.3.0 

func (this *IdentityList) String() string

func (IdentityList) SwaggerDoc added in v1.1.4 

func (IdentityList) SwaggerDoc() map[string]string

func (*IdentityList) Unmarshal added in v1.3.0 

func (m *IdentityList) Unmarshal(data []byte) error

type OptionalNames added in v1.3.0 

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 added in v1.4.0 

func (*OptionalNames) Descriptor() ([]byte, []int)

func (OptionalNames) Marshal added in v1.3.0 

func (m OptionalNames) Marshal() (data []byte, err error)

func (OptionalNames) MarshalTo added in v1.3.0 

func (m OptionalNames) MarshalTo(data []byte) (int, error)

func (*OptionalNames) ProtoMessage added in v1.3.0 

func (*OptionalNames) ProtoMessage()

func (*OptionalNames) Reset added in v1.3.0 

func (m *OptionalNames) Reset()

func (OptionalNames) Size added in v1.3.0 

func (m OptionalNames) Size() (n int)

func (OptionalNames) String added in v1.3.0 

func (t OptionalNames) String() string

func (*OptionalNames) Unmarshal added in v1.3.0 

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 specifies group names this user is a member of.
	// This field is deprecated and will be removed in a future release.
	// Instead, create a Group object containing the name of this User.
	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 added in v1.4.0 

func (*User) Descriptor() ([]byte, []int)

func (*User) Marshal added in v1.3.0 

func (m *User) Marshal() (data []byte, err error)

func (*User) MarshalTo added in v1.3.0 

func (m *User) MarshalTo(data []byte) (int, error)

func (*User) ProtoMessage added in v1.3.0 

func (*User) ProtoMessage()

func (*User) Reset added in v1.3.0 

func (m *User) Reset()

func (*User) Size added in v1.3.0 

func (m *User) Size() (n int)

func (*User) String added in v1.3.0 

func (this *User) String() string

func (User) SwaggerDoc added in v1.1.4 

func (User) SwaggerDoc() map[string]string

func (*User) Unmarshal added in v1.3.0 

func (m *User) Unmarshal(data []byte) error

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 added in v1.4.0 

func (*UserIdentityMapping) Descriptor() ([]byte, []int)

func (*UserIdentityMapping) Marshal added in v1.3.0 

func (m *UserIdentityMapping) Marshal() (data []byte, err error)

func (*UserIdentityMapping) MarshalTo added in v1.3.0 

func (m *UserIdentityMapping) MarshalTo(data []byte) (int, error)

func (*UserIdentityMapping) ProtoMessage added in v1.3.0 

func (*UserIdentityMapping) ProtoMessage()

func (*UserIdentityMapping) Reset added in v1.3.0 

func (m *UserIdentityMapping) Reset()

func (*UserIdentityMapping) Size added in v1.3.0 

func (m *UserIdentityMapping) Size() (n int)

func (*UserIdentityMapping) String added in v1.3.0 

func (this *UserIdentityMapping) String() string

func (UserIdentityMapping) SwaggerDoc added in v1.1.4 

func (UserIdentityMapping) SwaggerDoc() map[string]string

func (*UserIdentityMapping) Unmarshal added in v1.3.0 

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 added in v1.4.0 

func (*UserList) Descriptor() ([]byte, []int)

func (*UserList) Marshal added in v1.3.0 

func (m *UserList) Marshal() (data []byte, err error)

func (*UserList) MarshalTo added in v1.3.0 

func (m *UserList) MarshalTo(data []byte) (int, error)

func (*UserList) ProtoMessage added in v1.3.0 

func (*UserList) ProtoMessage()

func (*UserList) Reset added in v1.3.0 

func (m *UserList) Reset()

func (*UserList) Size added in v1.3.0 

func (m *UserList) Size() (n int)

func (*UserList) String added in v1.3.0 

func (this *UserList) String() string

func (UserList) SwaggerDoc added in v1.1.4 

func (UserList) SwaggerDoc() map[string]string

func (*UserList) Unmarshal added in v1.3.0 

func (m *UserList) Unmarshal(data []byte) error

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.