v1

package
Version: v3.9.0+incompatible Latest Latest
Warning

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

Go to latest
Published: Jan 19, 2018 License: Apache-2.0 Imports: 12 Imported by: 0

Documentation

Overview

+groupName=user.openshift.io 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/api/user/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       = schema.GroupVersion{Group: GroupName, Version: "v1"}
	LegacySchemeGroupVersion = schema.GroupVersion{Group: LegacyGroupName, Version: "v1"}

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

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

SchemeGroupVersion is group version used to register these objects

Functions

func Resource

func Resource(resource string) schema.GroupResource

Types

type Group

type Group struct {
	metav1.TypeMeta `json:",inline"`
	// Standard object's metadata.
	metav1.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) DeepCopy

func (in *Group) DeepCopy() *Group

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

func (*Group) DeepCopyInto

func (in *Group) DeepCopyInto(out *Group)

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

func (*Group) DeepCopyObject

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

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

func (*Group) Descriptor

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

func (*Group) Marshal

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

func (*Group) MarshalTo

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

func (*Group) ProtoMessage

func (*Group) ProtoMessage()

func (*Group) Reset

func (m *Group) Reset()

func (*Group) Size

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

func (*Group) String

func (this *Group) String() string

func (Group) SwaggerDoc

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

func (*Group) Unmarshal

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

type GroupList

type GroupList struct {
	metav1.TypeMeta `json:",inline"`
	// Standard object's metadata.
	metav1.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) DeepCopy

func (in *GroupList) DeepCopy() *GroupList

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

func (*GroupList) DeepCopyInto

func (in *GroupList) DeepCopyInto(out *GroupList)

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

func (*GroupList) DeepCopyObject

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

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

func (*GroupList) Descriptor

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

func (*GroupList) Marshal

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

func (*GroupList) MarshalTo

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

func (*GroupList) ProtoMessage

func (*GroupList) ProtoMessage()

func (*GroupList) Reset

func (m *GroupList) Reset()

func (*GroupList) Size

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

func (*GroupList) String

func (this *GroupList) String() string

func (GroupList) SwaggerDoc

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

func (*GroupList) Unmarshal

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

type Identity

type Identity struct {
	metav1.TypeMeta `json:",inline"`
	// Standard object's metadata.
	metav1.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 corev1.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) DeepCopy

func (in *Identity) DeepCopy() *Identity

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

func (*Identity) DeepCopyInto

func (in *Identity) DeepCopyInto(out *Identity)

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

func (*Identity) DeepCopyObject

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

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

func (*Identity) Descriptor

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

func (*Identity) Marshal

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

func (*Identity) MarshalTo

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

func (*Identity) ProtoMessage

func (*Identity) ProtoMessage()

func (*Identity) Reset

func (m *Identity) Reset()

func (*Identity) Size

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

func (*Identity) String

func (this *Identity) String() string

func (Identity) SwaggerDoc

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

func (*Identity) Unmarshal

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

type IdentityList

type IdentityList struct {
	metav1.TypeMeta `json:",inline"`
	// Standard object's metadata.
	metav1.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) DeepCopy

func (in *IdentityList) DeepCopy() *IdentityList

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

func (*IdentityList) DeepCopyInto

func (in *IdentityList) DeepCopyInto(out *IdentityList)

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

func (*IdentityList) DeepCopyObject

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

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

func (*IdentityList) Descriptor

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

func (*IdentityList) Marshal

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

func (*IdentityList) MarshalTo

func (m *IdentityList) MarshalTo(dAtA []byte) (int, 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) DeepCopy

func (in *OptionalNames) DeepCopy() *OptionalNames

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

func (*OptionalNames) DeepCopyInto

func (in *OptionalNames) DeepCopyInto(out *OptionalNames)

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

func (*OptionalNames) Descriptor

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

func (OptionalNames) Marshal

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

func (OptionalNames) MarshalTo

func (m OptionalNames) MarshalTo(dAtA []byte) (int, 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 {
	metav1.TypeMeta `json:",inline"`
	// Standard object's metadata.
	metav1.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) DeepCopy

func (in *User) DeepCopy() *User

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

func (*User) DeepCopyInto

func (in *User) DeepCopyInto(out *User)

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

func (*User) DeepCopyObject

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

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

func (*User) Descriptor

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

func (*User) Marshal

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

func (*User) MarshalTo

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

func (*User) ProtoMessage

func (*User) ProtoMessage()

func (*User) Reset

func (m *User) Reset()

func (*User) Size

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

func (*User) String

func (this *User) String() string

func (User) SwaggerDoc

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

func (*User) Unmarshal

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

type UserIdentityMapping

type UserIdentityMapping struct {
	metav1.TypeMeta `json:",inline"`
	// Standard object's metadata.
	metav1.ObjectMeta `json:"metadata,omitempty" protobuf:"bytes,1,opt,name=metadata"`

	// Identity is a reference to an identity
	Identity corev1.ObjectReference `json:"identity,omitempty" protobuf:"bytes,2,opt,name=identity"`
	// User is a reference to a user
	User corev1.ObjectReference `json:"user,omitempty" protobuf:"bytes,3,opt,name=user"`
}

UserIdentityMapping maps a user to an identity

func (*UserIdentityMapping) DeepCopy

func (in *UserIdentityMapping) DeepCopy() *UserIdentityMapping

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

func (*UserIdentityMapping) DeepCopyInto

func (in *UserIdentityMapping) DeepCopyInto(out *UserIdentityMapping)

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

func (*UserIdentityMapping) DeepCopyObject

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

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

func (*UserIdentityMapping) Descriptor

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

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 {
	metav1.TypeMeta `json:",inline"`
	// Standard object's metadata.
	metav1.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) DeepCopy

func (in *UserList) DeepCopy() *UserList

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

func (*UserList) DeepCopyInto

func (in *UserList) DeepCopyInto(out *UserList)

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

func (*UserList) DeepCopyObject

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

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

func (*UserList) Descriptor

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

func (*UserList) Marshal

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

func (*UserList) MarshalTo

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

func (*UserList) ProtoMessage

func (*UserList) ProtoMessage()

func (*UserList) Reset

func (m *UserList) Reset()

func (*UserList) Size

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

func (*UserList) String

func (this *UserList) String() string

func (UserList) SwaggerDoc

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

func (*UserList) Unmarshal

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

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
t or T : Toggle theme light dark auto
y or Y : Canonical URL