userv1beta1

package
v0.0.0-...-6b5d9df Latest Latest
Warning

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

 Go to latest Published: Jul 15, 2020 License: Apache-2.0 Imports: 15 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

View Source 
var File_cs3_identity_user_v1beta1_resources_proto protoreflect.FileDescriptor
View Source 
var File_cs3_identity_user_v1beta1_user_api_proto protoreflect.FileDescriptor

Functions

func RegisterUserAPIHandler 

func RegisterUserAPIHandler(s server.Server, hdlr UserAPIHandler, opts ...server.HandlerOption) error

func RegisterUserAPIServer 

func RegisterUserAPIServer(s *grpc.Server, srv UserAPIServer)

Types

type FindUsersRequest 

type FindUsersRequest struct {

	// OPTIONAL.
	// Opaque information.
	Opaque *v1beta1.Opaque `protobuf:"bytes,1,opt,name=opaque,proto3" json:"opaque,omitempty"`
	// REQUIRED. TODO(labkode): create propper filters for most common searchs.
	// The filter to apply.
	Filter string `protobuf:"bytes,2,opt,name=filter,proto3" json:"filter,omitempty"`
	// contains filtered or unexported fields
}

func (*FindUsersRequest) Descriptor deprecated 

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

Deprecated: Use FindUsersRequest.ProtoReflect.Descriptor instead.

func (*FindUsersRequest) GetFilter 

func (x *FindUsersRequest) GetFilter() string

func (*FindUsersRequest) GetOpaque 

func (x *FindUsersRequest) GetOpaque() *v1beta1.Opaque

func (*FindUsersRequest) ProtoMessage 

func (*FindUsersRequest) ProtoMessage()

func (*FindUsersRequest) ProtoReflect 

func (x *FindUsersRequest) ProtoReflect() protoreflect.Message

func (*FindUsersRequest) Reset 

func (x *FindUsersRequest) Reset()

func (*FindUsersRequest) String 

func (x *FindUsersRequest) String() string

type FindUsersResponse 

type FindUsersResponse struct {

	// REQUIRED.
	// The response status.
	Status *v1beta11.Status `protobuf:"bytes,1,opt,name=status,proto3" json:"status,omitempty"`
	// OPTIONAL.
	// Opaque information.
	Opaque *v1beta1.Opaque `protobuf:"bytes,2,opt,name=opaque,proto3" json:"opaque,omitempty"`
	// REQUIRED.
	// The groups for the user.
	Users []*User `protobuf:"bytes,3,rep,name=users,proto3" json:"users,omitempty"`
	// contains filtered or unexported fields
}

func (*FindUsersResponse) Descriptor deprecated 

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

Deprecated: Use FindUsersResponse.ProtoReflect.Descriptor instead.

func (*FindUsersResponse) GetOpaque 

func (x *FindUsersResponse) GetOpaque() *v1beta1.Opaque

func (*FindUsersResponse) GetStatus 

func (x *FindUsersResponse) GetStatus() *v1beta11.Status

func (*FindUsersResponse) GetUsers 

func (x *FindUsersResponse) GetUsers() []*User

func (*FindUsersResponse) ProtoMessage 

func (*FindUsersResponse) ProtoMessage()

func (*FindUsersResponse) ProtoReflect 

func (x *FindUsersResponse) ProtoReflect() protoreflect.Message

func (*FindUsersResponse) Reset 

func (x *FindUsersResponse) Reset()

func (*FindUsersResponse) String 

func (x *FindUsersResponse) String() string

type GetUserGroupsRequest 

type GetUserGroupsRequest struct {

	// OPTIONAL.
	// Opaque information.
	Opaque *v1beta1.Opaque `protobuf:"bytes,1,opt,name=opaque,proto3" json:"opaque,omitempty"`
	// REQUIRED.
	// The id of the user.
	UserId *UserId `protobuf:"bytes,2,opt,name=user_id,json=userId,proto3" json:"user_id,omitempty"`
	// contains filtered or unexported fields
}

func (*GetUserGroupsRequest) Descriptor deprecated 

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

Deprecated: Use GetUserGroupsRequest.ProtoReflect.Descriptor instead.

func (*GetUserGroupsRequest) GetOpaque 

func (x *GetUserGroupsRequest) GetOpaque() *v1beta1.Opaque

func (*GetUserGroupsRequest) GetUserId 

func (x *GetUserGroupsRequest) GetUserId() *UserId

func (*GetUserGroupsRequest) ProtoMessage 

func (*GetUserGroupsRequest) ProtoMessage()

func (*GetUserGroupsRequest) ProtoReflect 

func (x *GetUserGroupsRequest) ProtoReflect() protoreflect.Message

func (*GetUserGroupsRequest) Reset 

func (x *GetUserGroupsRequest) Reset()

func (*GetUserGroupsRequest) String 

func (x *GetUserGroupsRequest) String() string

type GetUserGroupsResponse 

type GetUserGroupsResponse struct {

	// REQUIRED.
	// The response status.
	Status *v1beta11.Status `protobuf:"bytes,1,opt,name=status,proto3" json:"status,omitempty"`
	// OPTIONAL.
	// Opaque information.
	Opaque *v1beta1.Opaque `protobuf:"bytes,2,opt,name=opaque,proto3" json:"opaque,omitempty"`
	// REQUIRED.
	// The groups for the user.
	Groups []string `protobuf:"bytes,3,rep,name=groups,proto3" json:"groups,omitempty"`
	// contains filtered or unexported fields
}

func (*GetUserGroupsResponse) Descriptor deprecated 

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

Deprecated: Use GetUserGroupsResponse.ProtoReflect.Descriptor instead.

func (*GetUserGroupsResponse) GetGroups 

func (x *GetUserGroupsResponse) GetGroups() []string

func (*GetUserGroupsResponse) GetOpaque 

func (x *GetUserGroupsResponse) GetOpaque() *v1beta1.Opaque

func (*GetUserGroupsResponse) GetStatus 

func (x *GetUserGroupsResponse) GetStatus() *v1beta11.Status

func (*GetUserGroupsResponse) ProtoMessage 

func (*GetUserGroupsResponse) ProtoMessage()

func (*GetUserGroupsResponse) ProtoReflect 

func (x *GetUserGroupsResponse) ProtoReflect() protoreflect.Message

func (*GetUserGroupsResponse) Reset 

func (x *GetUserGroupsResponse) Reset()

func (*GetUserGroupsResponse) String 

func (x *GetUserGroupsResponse) String() string

type GetUserRequest 

type GetUserRequest struct {

	// OPTIONAL.
	// Opaque information.
	Opaque *v1beta1.Opaque `protobuf:"bytes,1,opt,name=opaque,proto3" json:"opaque,omitempty"`
	// REQUIRED.
	// The id of the user.
	UserId *UserId `protobuf:"bytes,2,opt,name=user_id,json=userId,proto3" json:"user_id,omitempty"`
	// contains filtered or unexported fields
}

func (*GetUserRequest) Descriptor deprecated 

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

Deprecated: Use GetUserRequest.ProtoReflect.Descriptor instead.

func (*GetUserRequest) GetOpaque 

func (x *GetUserRequest) GetOpaque() *v1beta1.Opaque

func (*GetUserRequest) GetUserId 

func (x *GetUserRequest) GetUserId() *UserId

func (*GetUserRequest) ProtoMessage 

func (*GetUserRequest) ProtoMessage()

func (*GetUserRequest) ProtoReflect 

func (x *GetUserRequest) ProtoReflect() protoreflect.Message

func (*GetUserRequest) Reset 

func (x *GetUserRequest) Reset()

func (*GetUserRequest) String 

func (x *GetUserRequest) String() string

type GetUserResponse 

type GetUserResponse struct {

	// REQUIRED.
	// The response status.
	Status *v1beta11.Status `protobuf:"bytes,1,opt,name=status,proto3" json:"status,omitempty"`
	// OPTIONAL.
	// Opaque information.
	Opaque *v1beta1.Opaque `protobuf:"bytes,2,opt,name=opaque,proto3" json:"opaque,omitempty"`
	// REQUIRED.
	// The user information.
	User *User `protobuf:"bytes,3,opt,name=user,proto3" json:"user,omitempty"`
	// contains filtered or unexported fields
}

func (*GetUserResponse) Descriptor deprecated 

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

Deprecated: Use GetUserResponse.ProtoReflect.Descriptor instead.

func (*GetUserResponse) GetOpaque 

func (x *GetUserResponse) GetOpaque() *v1beta1.Opaque

func (*GetUserResponse) GetStatus 

func (x *GetUserResponse) GetStatus() *v1beta11.Status

func (*GetUserResponse) GetUser 

func (x *GetUserResponse) GetUser() *User

func (*GetUserResponse) ProtoMessage 

func (*GetUserResponse) ProtoMessage()

func (*GetUserResponse) ProtoReflect 

func (x *GetUserResponse) ProtoReflect() protoreflect.Message

func (*GetUserResponse) Reset 

func (x *GetUserResponse) Reset()

func (*GetUserResponse) String 

func (x *GetUserResponse) String() string

type IsInGroupRequest 

type IsInGroupRequest struct {

	// OPTIONAL.
	// Opaque information.
	Opaque *v1beta1.Opaque `protobuf:"bytes,1,opt,name=opaque,proto3" json:"opaque,omitempty"`
	// REQUIRED.
	// The id of the user.
	UserId *UserId `protobuf:"bytes,2,opt,name=user_id,json=userId,proto3" json:"user_id,omitempty"`
	// REQUIRED.
	// The group to check.
	Group string `protobuf:"bytes,3,opt,name=group,proto3" json:"group,omitempty"`
	// contains filtered or unexported fields
}

func (*IsInGroupRequest) Descriptor deprecated 

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

Deprecated: Use IsInGroupRequest.ProtoReflect.Descriptor instead.

func (*IsInGroupRequest) GetGroup 

func (x *IsInGroupRequest) GetGroup() string

func (*IsInGroupRequest) GetOpaque 

func (x *IsInGroupRequest) GetOpaque() *v1beta1.Opaque

func (*IsInGroupRequest) GetUserId 

func (x *IsInGroupRequest) GetUserId() *UserId

func (*IsInGroupRequest) ProtoMessage 

func (*IsInGroupRequest) ProtoMessage()

func (*IsInGroupRequest) ProtoReflect 

func (x *IsInGroupRequest) ProtoReflect() protoreflect.Message

func (*IsInGroupRequest) Reset 

func (x *IsInGroupRequest) Reset()

func (*IsInGroupRequest) String 

func (x *IsInGroupRequest) String() string

type IsInGroupResponse 

type IsInGroupResponse struct {

	// REQUIRED.
	// The response status.
	Status *v1beta11.Status `protobuf:"bytes,1,opt,name=status,proto3" json:"status,omitempty"`
	// OPTIONAL.
	// Opaque information.
	Opaque *v1beta1.Opaque `protobuf:"bytes,2,opt,name=opaque,proto3" json:"opaque,omitempty"`
	// REQUIRED.
	// Tells if the user belongs to the group.
	Ok bool `protobuf:"varint,3,opt,name=ok,proto3" json:"ok,omitempty"`
	// contains filtered or unexported fields
}

func (*IsInGroupResponse) Descriptor deprecated 

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

Deprecated: Use IsInGroupResponse.ProtoReflect.Descriptor instead.

func (*IsInGroupResponse) GetOk 

func (x *IsInGroupResponse) GetOk() bool

func (*IsInGroupResponse) GetOpaque 

func (x *IsInGroupResponse) GetOpaque() *v1beta1.Opaque

func (*IsInGroupResponse) GetStatus 

func (x *IsInGroupResponse) GetStatus() *v1beta11.Status

func (*IsInGroupResponse) ProtoMessage 

func (*IsInGroupResponse) ProtoMessage()

func (*IsInGroupResponse) ProtoReflect 

func (x *IsInGroupResponse) ProtoReflect() protoreflect.Message

func (*IsInGroupResponse) Reset 

func (x *IsInGroupResponse) Reset()

func (*IsInGroupResponse) String 

func (x *IsInGroupResponse) String() string

type UnimplementedUserAPIServer 

type UnimplementedUserAPIServer struct {
}

UnimplementedUserAPIServer can be embedded to have forward compatible implementations.

func (*UnimplementedUserAPIServer) FindUsers 

func (*UnimplementedUserAPIServer) FindUsers(context.Context, *FindUsersRequest) (*FindUsersResponse, error)

func (*UnimplementedUserAPIServer) GetUser 

func (*UnimplementedUserAPIServer) GetUser(context.Context, *GetUserRequest) (*GetUserResponse, error)

func (*UnimplementedUserAPIServer) GetUserGroups 

func (*UnimplementedUserAPIServer) GetUserGroups(context.Context, *GetUserGroupsRequest) (*GetUserGroupsResponse, error)

func (*UnimplementedUserAPIServer) IsInGroup 

func (*UnimplementedUserAPIServer) IsInGroup(context.Context, *IsInGroupRequest) (*IsInGroupResponse, error)

type User 

type User struct {
	Id           *UserId         `protobuf:"bytes,1,opt,name=id,proto3" json:"id,omitempty"`
	Username     string          `protobuf:"bytes,2,opt,name=username,proto3" json:"username,omitempty"`
	Mail         string          `protobuf:"bytes,3,opt,name=mail,proto3" json:"mail,omitempty"`
	MailVerified bool            `protobuf:"varint,4,opt,name=mail_verified,json=mailVerified,proto3" json:"mail_verified,omitempty"`
	DisplayName  string          `protobuf:"bytes,5,opt,name=display_name,json=displayName,proto3" json:"display_name,omitempty"`
	Groups       []string        `protobuf:"bytes,6,rep,name=groups,proto3" json:"groups,omitempty"`
	Opaque       *v1beta1.Opaque `protobuf:"bytes,7,opt,name=opaque,proto3" json:"opaque,omitempty"`
	// contains filtered or unexported fields
}

Represents an user of the system.

func (*User) Descriptor deprecated 

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

Deprecated: Use User.ProtoReflect.Descriptor instead.

func (*User) GetDisplayName 

func (x *User) GetDisplayName() string

func (*User) GetGroups 

func (x *User) GetGroups() []string

func (*User) GetId 

func (x *User) GetId() *UserId

func (*User) GetMail 

func (x *User) GetMail() string

func (*User) GetMailVerified 

func (x *User) GetMailVerified() bool

func (*User) GetOpaque 

func (x *User) GetOpaque() *v1beta1.Opaque

func (*User) GetUsername 

func (x *User) GetUsername() string

func (*User) ProtoMessage 

func (*User) ProtoMessage()

func (*User) ProtoReflect 

func (x *User) ProtoReflect() protoreflect.Message

func (*User) Reset 

func (x *User) Reset()

func (*User) String 

func (x *User) String() string

type UserAPIClient 

type UserAPIClient interface {
	// Gets the information about an user by its user id.
	GetUser(ctx context.Context, in *GetUserRequest, opts ...grpc.CallOption) (*GetUserResponse, error)
	// Gets the groups of a user.
	GetUserGroups(ctx context.Context, in *GetUserGroupsRequest, opts ...grpc.CallOption) (*GetUserGroupsResponse, error)
	// Tells if the user is in a certain group.
	IsInGroup(ctx context.Context, in *IsInGroupRequest, opts ...grpc.CallOption) (*IsInGroupResponse, error)
	// Finds users by any attribute of the user?
	// TODO(labkode): to define the filters that make more sense.
	FindUsers(ctx context.Context, in *FindUsersRequest, opts ...grpc.CallOption) (*FindUsersResponse, error)
}

UserAPIClient is the client API for UserAPI service.

For semantics around ctx use and closing/ending streaming RPCs, please refer to https://godoc.org/google.golang.org/grpc#ClientConn.NewStream.

func NewUserAPIClient 

func NewUserAPIClient(cc grpc.ClientConnInterface) UserAPIClient

type UserAPIHandler 

type UserAPIHandler interface {
	// Gets the information about an user by its user id.
	GetUser(context.Context, *GetUserRequest, *GetUserResponse) error
	// Gets the groups of a user.
	GetUserGroups(context.Context, *GetUserGroupsRequest, *GetUserGroupsResponse) error
	// Tells if the user is in a certain group.
	IsInGroup(context.Context, *IsInGroupRequest, *IsInGroupResponse) error
	// Finds users by any attribute of the user?
	// TODO(labkode): to define the filters that make more sense.
	FindUsers(context.Context, *FindUsersRequest, *FindUsersResponse) error
}

type UserAPIServer 

type UserAPIServer interface {
	// Gets the information about an user by its user id.
	GetUser(context.Context, *GetUserRequest) (*GetUserResponse, error)
	// Gets the groups of a user.
	GetUserGroups(context.Context, *GetUserGroupsRequest) (*GetUserGroupsResponse, error)
	// Tells if the user is in a certain group.
	IsInGroup(context.Context, *IsInGroupRequest) (*IsInGroupResponse, error)
	// Finds users by any attribute of the user?
	// TODO(labkode): to define the filters that make more sense.
	FindUsers(context.Context, *FindUsersRequest) (*FindUsersResponse, error)
}

UserAPIServer is the server API for UserAPI service.

type UserAPIService 

type UserAPIService interface {
	// Gets the information about an user by its user id.
	GetUser(ctx context.Context, in *GetUserRequest, opts ...client.CallOption) (*GetUserResponse, error)
	// Gets the groups of a user.
	GetUserGroups(ctx context.Context, in *GetUserGroupsRequest, opts ...client.CallOption) (*GetUserGroupsResponse, error)
	// Tells if the user is in a certain group.
	IsInGroup(ctx context.Context, in *IsInGroupRequest, opts ...client.CallOption) (*IsInGroupResponse, error)
	// Finds users by any attribute of the user?
	// TODO(labkode): to define the filters that make more sense.
	FindUsers(ctx context.Context, in *FindUsersRequest, opts ...client.CallOption) (*FindUsersResponse, error)
}

func NewUserAPIService 

func NewUserAPIService(name string, c client.Client) UserAPIService

type UserId 

type UserId struct {

	// REQUIRED.
	// The identity provider for the user.
	Idp string `protobuf:"bytes,1,opt,name=idp,proto3" json:"idp,omitempty"`
	// REQUIRED.
	// the unique identifier for the user in the scope of
	// the identity provider.
	OpaqueId string `protobuf:"bytes,2,opt,name=opaque_id,json=opaqueId,proto3" json:"opaque_id,omitempty"`
	// contains filtered or unexported fields
}

A UserId represents a user.

func (*UserId) Descriptor deprecated 

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

Deprecated: Use UserId.ProtoReflect.Descriptor instead.

func (*UserId) GetIdp 

func (x *UserId) GetIdp() string

func (*UserId) GetOpaqueId 

func (x *UserId) GetOpaqueId() string

func (*UserId) ProtoMessage 

func (*UserId) ProtoMessage()

func (*UserId) ProtoReflect 

func (x *UserId) ProtoReflect() protoreflect.Message

func (*UserId) Reset 

func (x *UserId) Reset()

func (*UserId) String 

func (x *UserId) String() string

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.