permissionsv1beta1

Documentation

Index

• Constants
• Variables
• func RegisterPermissionsAPIServer(s grpc.ServiceRegistrar, srv PermissionsAPIServer)
• type CheckPermissionRequest
  • func (*CheckPermissionRequest) Descriptor() ([]byte, []int)
  • func (x *CheckPermissionRequest) GetPermission() string
  • func (x *CheckPermissionRequest) GetRef() *v1beta1.Reference
  • func (x *CheckPermissionRequest) GetSubjectRef() *SubjectReference
  • func (*CheckPermissionRequest) ProtoMessage()
  • func (x *CheckPermissionRequest) ProtoReflect() protoreflect.Message
  • func (x *CheckPermissionRequest) Reset()
  • func (x *CheckPermissionRequest) String() string
• type CheckPermissionResponse
  • func (*CheckPermissionResponse) Descriptor() ([]byte, []int)
  • func (x *CheckPermissionResponse) GetStatus() *v1beta11.Status
  • func (*CheckPermissionResponse) ProtoMessage()
  • func (x *CheckPermissionResponse) ProtoReflect() protoreflect.Message
  • func (x *CheckPermissionResponse) Reset()
  • func (x *CheckPermissionResponse) String() string
• type PermissionsAPIClient
  • func NewPermissionsAPIClient(cc grpc.ClientConnInterface) PermissionsAPIClient
• type PermissionsAPIServer
• type SubjectReference
  • func (*SubjectReference) Descriptor() ([]byte, []int)
  • func (x *SubjectReference) GetGroupId() *v1beta11.GroupId
  • func (m *SubjectReference) GetSpec() isSubjectReference_Spec
  • func (x *SubjectReference) GetUserId() *v1beta1.UserId
  • func (*SubjectReference) ProtoMessage()
  • func (x *SubjectReference) ProtoReflect() protoreflect.Message
  • func (x *SubjectReference) Reset()
  • func (x *SubjectReference) String() string
• type SubjectReference_GroupId
• type SubjectReference_UserId
• type UnimplementedPermissionsAPIServer
  • func (UnimplementedPermissionsAPIServer) CheckPermission(context.Context, *CheckPermissionRequest) (*CheckPermissionResponse, error)
• type UnsafePermissionsAPIServer

Constants

const (
	PermissionsAPI_CheckPermission_FullMethodName = "/cs3.permissions.v1beta1.PermissionsAPI/CheckPermission"
)

Variables

var File_cs3_permissions_v1beta1_permissions_api_proto protoreflect.FileDescriptor

var File_cs3_permissions_v1beta1_resources_proto protoreflect.FileDescriptor

var PermissionsAPI_ServiceDesc = grpc.ServiceDesc{
	ServiceName: "cs3.permissions.v1beta1.PermissionsAPI",
	HandlerType: (*PermissionsAPIServer)(nil),
	Methods: []grpc.MethodDesc{
		{
			MethodName: "CheckPermission",
			Handler:    _PermissionsAPI_CheckPermission_Handler,
		},
	},
	Streams:  []grpc.StreamDesc{},
	Metadata: "cs3/permissions/v1beta1/permissions_api.proto",
}

PermissionsAPI_ServiceDesc is the grpc.ServiceDesc for PermissionsAPI service. It's only intended for direct use with grpc.RegisterService, and not to be introspected or modified (even as a copy)

Functions

func RegisterPermissionsAPIServer

func RegisterPermissionsAPIServer(s grpc.ServiceRegistrar, srv PermissionsAPIServer)

Types

type CheckPermissionRequest

type CheckPermissionRequest struct {

	// REQUIRED.
	// The permission to check.
	Permission string `protobuf:"bytes,1,opt,name=permission,proto3" json:"permission,omitempty"`
	// REQUIRED.
	// The subject holding the permission.
	SubjectRef *SubjectReference `protobuf:"bytes,2,opt,name=subject_ref,json=subjectRef,proto3" json:"subject_ref,omitempty"`
	// OPTIONAL.
	// The target resource of the permission.
	Ref *v1beta1.Reference `protobuf:"bytes,3,opt,name=ref,proto3" json:"ref,omitempty"`
	// contains filtered or unexported fields
}

CheckPermissionsRequest is used to check if a user has a certain permission.

func (*CheckPermissionRequest) Descriptor

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

Deprecated: Use CheckPermissionRequest.ProtoReflect.Descriptor instead.

func (*CheckPermissionRequest) GetPermission

func (x *CheckPermissionRequest) GetPermission() string

func (*CheckPermissionRequest) GetRef

func (x *CheckPermissionRequest) GetRef() *v1beta1.Reference

func (*CheckPermissionRequest) GetSubjectRef

func (x *CheckPermissionRequest) GetSubjectRef() *SubjectReference

func (*CheckPermissionRequest) ProtoMessage

func (*CheckPermissionRequest) ProtoMessage()

func (*CheckPermissionRequest) ProtoReflect

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

func (*CheckPermissionRequest) Reset

func (x *CheckPermissionRequest) Reset()

func (*CheckPermissionRequest) String

func (x *CheckPermissionRequest) String() string

type CheckPermissionResponse

type CheckPermissionResponse struct {

	// REQUIRED.
	// The response status.
	Status *v1beta11.Status `protobuf:"bytes,1,opt,name=status,proto3" json:"status,omitempty"`
	// contains filtered or unexported fields
}

CheckPermissionsResponse ...

func (*CheckPermissionResponse) Descriptor

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

Deprecated: Use CheckPermissionResponse.ProtoReflect.Descriptor instead.

func (*CheckPermissionResponse) GetStatus

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

func (*CheckPermissionResponse) ProtoMessage

func (*CheckPermissionResponse) ProtoMessage()

func (*CheckPermissionResponse) ProtoReflect

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

func (*CheckPermissionResponse) Reset

func (x *CheckPermissionResponse) Reset()

func (*CheckPermissionResponse) String

func (x *CheckPermissionResponse) String() string

type PermissionsAPIClient

type PermissionsAPIClient interface {
	// CheckPermission defines a method to check permission/role.
	CheckPermission(ctx context.Context, in *CheckPermissionRequest, opts ...grpc.CallOption) (*CheckPermissionResponse, error)
}

PermissionsAPIClient is the client API for PermissionsAPI service.

For semantics around ctx use and closing/ending streaming RPCs, please refer to https://pkg.go.dev/google.golang.org/grpc/?tab=doc#ClientConn.NewStream.

func NewPermissionsAPIClient

func NewPermissionsAPIClient(cc grpc.ClientConnInterface) PermissionsAPIClient

type PermissionsAPIServer

type PermissionsAPIServer interface {
	// CheckPermission defines a method to check permission/role.
	CheckPermission(context.Context, *CheckPermissionRequest) (*CheckPermissionResponse, error)
}

PermissionsAPIServer is the server API for PermissionsAPI service. All implementations should embed UnimplementedPermissionsAPIServer for forward compatibility

type SubjectReference

type SubjectReference struct {

	// Types that are assignable to Spec:
	//
	//	*SubjectReference_UserId
	//	*SubjectReference_GroupId
	Spec isSubjectReference_Spec `protobuf_oneof:"spec"`
	// contains filtered or unexported fields
}

SubjectReference references either a user or a group by id.

func (*SubjectReference) Descriptor

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

Deprecated: Use SubjectReference.ProtoReflect.Descriptor instead.

func (*SubjectReference) GetGroupId

func (x *SubjectReference) GetGroupId() *v1beta11.GroupId

func (*SubjectReference) GetSpec

func (m *SubjectReference) GetSpec() isSubjectReference_Spec

func (*SubjectReference) GetUserId

func (x *SubjectReference) GetUserId() *v1beta1.UserId

func (*SubjectReference) ProtoMessage

func (*SubjectReference) ProtoMessage()

func (*SubjectReference) ProtoReflect

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

func (*SubjectReference) Reset

func (x *SubjectReference) Reset()

func (*SubjectReference) String

func (x *SubjectReference) String() string

type SubjectReference_GroupId

type SubjectReference_GroupId struct {
	GroupId *v1beta11.GroupId `protobuf:"bytes,2,opt,name=group_id,json=groupId,proto3,oneof"`
}

type SubjectReference_UserId

type SubjectReference_UserId struct {
	UserId *v1beta1.UserId `protobuf:"bytes,1,opt,name=user_id,json=userId,proto3,oneof"`
}

type UnimplementedPermissionsAPIServer

type UnimplementedPermissionsAPIServer struct {
}

UnimplementedPermissionsAPIServer should be embedded to have forward compatible implementations.

func (UnimplementedPermissionsAPIServer) CheckPermission

func (UnimplementedPermissionsAPIServer) CheckPermission(context.Context, *CheckPermissionRequest) (*CheckPermissionResponse, error)

type UnsafePermissionsAPIServer

type UnsafePermissionsAPIServer interface {
	// contains filtered or unexported methods
}

UnsafePermissionsAPIServer may be embedded to opt out of forward compatibility for this service. Use of this interface is not recommended, as added methods to PermissionsAPIServer will result in compilation errors.