applicationsv1beta1

package
v0.0.0-...-3ad35d1 Latest Latest
Warning

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

Go to latest
Published: Nov 5, 2024 License: Apache-2.0 Imports: 12 Imported by: 11

Documentation

Index

Constants

View Source
const (
	ApplicationsAPI_GenerateAppPassword_FullMethodName   = "/cs3.auth.applications.v1beta1.ApplicationsAPI/GenerateAppPassword"
	ApplicationsAPI_ListAppPasswords_FullMethodName      = "/cs3.auth.applications.v1beta1.ApplicationsAPI/ListAppPasswords"
	ApplicationsAPI_InvalidateAppPassword_FullMethodName = "/cs3.auth.applications.v1beta1.ApplicationsAPI/InvalidateAppPassword"
	ApplicationsAPI_GetAppPassword_FullMethodName        = "/cs3.auth.applications.v1beta1.ApplicationsAPI/GetAppPassword"
)

Variables

View Source
var ApplicationsAPI_ServiceDesc = grpc.ServiceDesc{
	ServiceName: "cs3.auth.applications.v1beta1.ApplicationsAPI",
	HandlerType: (*ApplicationsAPIServer)(nil),
	Methods: []grpc.MethodDesc{
		{
			MethodName: "GenerateAppPassword",
			Handler:    _ApplicationsAPI_GenerateAppPassword_Handler,
		},
		{
			MethodName: "ListAppPasswords",
			Handler:    _ApplicationsAPI_ListAppPasswords_Handler,
		},
		{
			MethodName: "InvalidateAppPassword",
			Handler:    _ApplicationsAPI_InvalidateAppPassword_Handler,
		},
		{
			MethodName: "GetAppPassword",
			Handler:    _ApplicationsAPI_GetAppPassword_Handler,
		},
	},
	Streams:  []grpc.StreamDesc{},
	Metadata: "cs3/auth/applications/v1beta1/applications_api.proto",
}

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

View Source
var File_cs3_auth_applications_v1beta1_applications_api_proto protoreflect.FileDescriptor
View Source
var File_cs3_auth_applications_v1beta1_resources_proto protoreflect.FileDescriptor

Functions

func RegisterApplicationsAPIServer

func RegisterApplicationsAPIServer(s grpc.ServiceRegistrar, srv ApplicationsAPIServer)

Types

type AppPassword

type AppPassword struct {

	// REQUIRED.
	// The generated access password.
	Password string `protobuf:"bytes,1,opt,name=password,proto3" json:"password,omitempty"`
	// OPTIONAL.
	// The scope of the token to be issued.
	// This would be a list of resources with corresponding role-based access scope.
	TokenScope map[string]*v1beta1.Scope `` /* 179-byte string literal not displayed */
	// OPTIONAL.
	// A label to be associated with the password.
	Label string `protobuf:"bytes,3,opt,name=label,proto3" json:"label,omitempty"`
	// REQUIRED.
	// The user who created the password.
	User *v1beta11.UserId `protobuf:"bytes,4,opt,name=user,proto3" json:"user,omitempty"`
	// OPTIONAL.
	// The time when the token will expire.
	Expiration *v1beta12.Timestamp `protobuf:"bytes,5,opt,name=expiration,proto3" json:"expiration,omitempty"`
	// REQUIRED.
	// The creation time of the password.
	Ctime *v1beta12.Timestamp `protobuf:"bytes,6,opt,name=ctime,proto3" json:"ctime,omitempty"`
	// REQUIRED.
	// The last time the password was used.
	Utime *v1beta12.Timestamp `protobuf:"bytes,7,opt,name=utime,proto3" json:"utime,omitempty"`
	// contains filtered or unexported fields
}

AppPassword stores information about secondary passwords generated by users to be used with third-party applications.

func (*AppPassword) Descriptor deprecated

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

Deprecated: Use AppPassword.ProtoReflect.Descriptor instead.

func (*AppPassword) GetCtime

func (x *AppPassword) GetCtime() *v1beta12.Timestamp

func (*AppPassword) GetExpiration

func (x *AppPassword) GetExpiration() *v1beta12.Timestamp

func (*AppPassword) GetLabel

func (x *AppPassword) GetLabel() string

func (*AppPassword) GetPassword

func (x *AppPassword) GetPassword() string

func (*AppPassword) GetTokenScope

func (x *AppPassword) GetTokenScope() map[string]*v1beta1.Scope

func (*AppPassword) GetUser

func (x *AppPassword) GetUser() *v1beta11.UserId

func (*AppPassword) GetUtime

func (x *AppPassword) GetUtime() *v1beta12.Timestamp

func (*AppPassword) ProtoMessage

func (*AppPassword) ProtoMessage()

func (*AppPassword) ProtoReflect

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

func (*AppPassword) Reset

func (x *AppPassword) Reset()

func (*AppPassword) String

func (x *AppPassword) String() string

type ApplicationsAPIClient

type ApplicationsAPIClient interface {
	// GenerateAppPassword creates a password with specified scope to be used by
	// third-party applications.
	GenerateAppPassword(ctx context.Context, in *GenerateAppPasswordRequest, opts ...grpc.CallOption) (*GenerateAppPasswordResponse, error)
	// ListAppPasswords lists the application passwords created by a user.
	ListAppPasswords(ctx context.Context, in *ListAppPasswordsRequest, opts ...grpc.CallOption) (*ListAppPasswordsResponse, error)
	// InvalidateAppPassword invalidates a generated password.
	InvalidateAppPassword(ctx context.Context, in *InvalidateAppPasswordRequest, opts ...grpc.CallOption) (*InvalidateAppPasswordResponse, error)
	// GetAppPassword retrieves the password information by the combination of username and password.
	GetAppPassword(ctx context.Context, in *GetAppPasswordRequest, opts ...grpc.CallOption) (*GetAppPasswordResponse, error)
}

ApplicationsAPIClient is the client API for ApplicationsAPI 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.

type ApplicationsAPIServer

type ApplicationsAPIServer interface {
	// GenerateAppPassword creates a password with specified scope to be used by
	// third-party applications.
	GenerateAppPassword(context.Context, *GenerateAppPasswordRequest) (*GenerateAppPasswordResponse, error)
	// ListAppPasswords lists the application passwords created by a user.
	ListAppPasswords(context.Context, *ListAppPasswordsRequest) (*ListAppPasswordsResponse, error)
	// InvalidateAppPassword invalidates a generated password.
	InvalidateAppPassword(context.Context, *InvalidateAppPasswordRequest) (*InvalidateAppPasswordResponse, error)
	// GetAppPassword retrieves the password information by the combination of username and password.
	GetAppPassword(context.Context, *GetAppPasswordRequest) (*GetAppPasswordResponse, error)
}

ApplicationsAPIServer is the server API for ApplicationsAPI service. All implementations should embed UnimplementedApplicationsAPIServer for forward compatibility

type GenerateAppPasswordRequest

type GenerateAppPasswordRequest struct {

	// OPTIONAL.
	// Opaque information.
	Opaque *v1beta1.Opaque `protobuf:"bytes,1,opt,name=opaque,proto3" json:"opaque,omitempty"`
	// OPTIONAL.
	// The scope of the token to be issued.
	// This would be a list of resources with corresponding role-based access scope.
	TokenScope map[string]*v1beta11.Scope `` /* 179-byte string literal not displayed */
	// OPTIONAL.
	// A label to be associated with the password.
	Label string `protobuf:"bytes,3,opt,name=label,proto3" json:"label,omitempty"`
	// OPTIONAL.
	// The time when the token will expire.
	Expiration *v1beta1.Timestamp `protobuf:"bytes,4,opt,name=expiration,proto3" json:"expiration,omitempty"`
	// contains filtered or unexported fields
}

func (*GenerateAppPasswordRequest) Descriptor deprecated

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

Deprecated: Use GenerateAppPasswordRequest.ProtoReflect.Descriptor instead.

func (*GenerateAppPasswordRequest) GetExpiration

func (x *GenerateAppPasswordRequest) GetExpiration() *v1beta1.Timestamp

func (*GenerateAppPasswordRequest) GetLabel

func (x *GenerateAppPasswordRequest) GetLabel() string

func (*GenerateAppPasswordRequest) GetOpaque

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

func (*GenerateAppPasswordRequest) GetTokenScope

func (x *GenerateAppPasswordRequest) GetTokenScope() map[string]*v1beta11.Scope

func (*GenerateAppPasswordRequest) ProtoMessage

func (*GenerateAppPasswordRequest) ProtoMessage()

func (*GenerateAppPasswordRequest) ProtoReflect

func (*GenerateAppPasswordRequest) Reset

func (x *GenerateAppPasswordRequest) Reset()

func (*GenerateAppPasswordRequest) String

func (x *GenerateAppPasswordRequest) String() string

type GenerateAppPasswordResponse

type GenerateAppPasswordResponse struct {

	// REQUIRED.
	// The response status.
	Status *v1beta12.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 generated access password.
	AppPassword *AppPassword `protobuf:"bytes,3,opt,name=app_password,json=appPassword,proto3" json:"app_password,omitempty"`
	// contains filtered or unexported fields
}

func (*GenerateAppPasswordResponse) Descriptor deprecated

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

Deprecated: Use GenerateAppPasswordResponse.ProtoReflect.Descriptor instead.

func (*GenerateAppPasswordResponse) GetAppPassword

func (x *GenerateAppPasswordResponse) GetAppPassword() *AppPassword

func (*GenerateAppPasswordResponse) GetOpaque

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

func (*GenerateAppPasswordResponse) GetStatus

func (*GenerateAppPasswordResponse) ProtoMessage

func (*GenerateAppPasswordResponse) ProtoMessage()

func (*GenerateAppPasswordResponse) ProtoReflect

func (*GenerateAppPasswordResponse) Reset

func (x *GenerateAppPasswordResponse) Reset()

func (*GenerateAppPasswordResponse) String

func (x *GenerateAppPasswordResponse) String() string

type GetAppPasswordRequest

type GetAppPasswordRequest struct {

	// OPTIONAL.
	// Opaque information.
	Opaque *v1beta1.Opaque `protobuf:"bytes,1,opt,name=opaque,proto3" json:"opaque,omitempty"`
	// REQUIRED.
	// The user who created the app password.
	User *v1beta13.UserId `protobuf:"bytes,2,opt,name=user,proto3" json:"user,omitempty"`
	// REQUIRED.
	// The password which has to be retrieved.
	Password string `protobuf:"bytes,3,opt,name=password,proto3" json:"password,omitempty"`
	// contains filtered or unexported fields
}

func (*GetAppPasswordRequest) Descriptor deprecated

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

Deprecated: Use GetAppPasswordRequest.ProtoReflect.Descriptor instead.

func (*GetAppPasswordRequest) GetOpaque

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

func (*GetAppPasswordRequest) GetPassword

func (x *GetAppPasswordRequest) GetPassword() string

func (*GetAppPasswordRequest) GetUser

func (x *GetAppPasswordRequest) GetUser() *v1beta13.UserId

func (*GetAppPasswordRequest) ProtoMessage

func (*GetAppPasswordRequest) ProtoMessage()

func (*GetAppPasswordRequest) ProtoReflect

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

func (*GetAppPasswordRequest) Reset

func (x *GetAppPasswordRequest) Reset()

func (*GetAppPasswordRequest) String

func (x *GetAppPasswordRequest) String() string

type GetAppPasswordResponse

type GetAppPasswordResponse struct {

	// REQUIRED.
	// The response status.
	Status *v1beta12.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 generated access password.
	AppPassword *AppPassword `protobuf:"bytes,3,opt,name=app_password,json=appPassword,proto3" json:"app_password,omitempty"`
	// contains filtered or unexported fields
}

func (*GetAppPasswordResponse) Descriptor deprecated

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

Deprecated: Use GetAppPasswordResponse.ProtoReflect.Descriptor instead.

func (*GetAppPasswordResponse) GetAppPassword

func (x *GetAppPasswordResponse) GetAppPassword() *AppPassword

func (*GetAppPasswordResponse) GetOpaque

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

func (*GetAppPasswordResponse) GetStatus

func (x *GetAppPasswordResponse) GetStatus() *v1beta12.Status

func (*GetAppPasswordResponse) ProtoMessage

func (*GetAppPasswordResponse) ProtoMessage()

func (*GetAppPasswordResponse) ProtoReflect

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

func (*GetAppPasswordResponse) Reset

func (x *GetAppPasswordResponse) Reset()

func (*GetAppPasswordResponse) String

func (x *GetAppPasswordResponse) String() string

type InvalidateAppPasswordRequest

type InvalidateAppPasswordRequest struct {

	// OPTIONAL.
	// Opaque information.
	Opaque *v1beta1.Opaque `protobuf:"bytes,1,opt,name=opaque,proto3" json:"opaque,omitempty"`
	// REQUIRED.
	// The password which has to be invalidated.
	Password string `protobuf:"bytes,2,opt,name=password,proto3" json:"password,omitempty"`
	// contains filtered or unexported fields
}

func (*InvalidateAppPasswordRequest) Descriptor deprecated

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

Deprecated: Use InvalidateAppPasswordRequest.ProtoReflect.Descriptor instead.

func (*InvalidateAppPasswordRequest) GetOpaque

func (*InvalidateAppPasswordRequest) GetPassword

func (x *InvalidateAppPasswordRequest) GetPassword() string

func (*InvalidateAppPasswordRequest) ProtoMessage

func (*InvalidateAppPasswordRequest) ProtoMessage()

func (*InvalidateAppPasswordRequest) ProtoReflect

func (*InvalidateAppPasswordRequest) Reset

func (x *InvalidateAppPasswordRequest) Reset()

func (*InvalidateAppPasswordRequest) String

type InvalidateAppPasswordResponse

type InvalidateAppPasswordResponse struct {

	// REQUIRED.
	// The response status.
	Status *v1beta12.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"`
	// contains filtered or unexported fields
}

func (*InvalidateAppPasswordResponse) Descriptor deprecated

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

Deprecated: Use InvalidateAppPasswordResponse.ProtoReflect.Descriptor instead.

func (*InvalidateAppPasswordResponse) GetOpaque

func (*InvalidateAppPasswordResponse) GetStatus

func (*InvalidateAppPasswordResponse) ProtoMessage

func (*InvalidateAppPasswordResponse) ProtoMessage()

func (*InvalidateAppPasswordResponse) ProtoReflect

func (*InvalidateAppPasswordResponse) Reset

func (x *InvalidateAppPasswordResponse) Reset()

func (*InvalidateAppPasswordResponse) String

type ListAppPasswordsRequest

type ListAppPasswordsRequest struct {

	// OPTIONAL.
	// Opaque information.
	Opaque *v1beta1.Opaque `protobuf:"bytes,1,opt,name=opaque,proto3" json:"opaque,omitempty"`
	// contains filtered or unexported fields
}

func (*ListAppPasswordsRequest) Descriptor deprecated

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

Deprecated: Use ListAppPasswordsRequest.ProtoReflect.Descriptor instead.

func (*ListAppPasswordsRequest) GetOpaque

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

func (*ListAppPasswordsRequest) ProtoMessage

func (*ListAppPasswordsRequest) ProtoMessage()

func (*ListAppPasswordsRequest) ProtoReflect

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

func (*ListAppPasswordsRequest) Reset

func (x *ListAppPasswordsRequest) Reset()

func (*ListAppPasswordsRequest) String

func (x *ListAppPasswordsRequest) String() string

type ListAppPasswordsResponse

type ListAppPasswordsResponse struct {

	// REQUIRED.
	// The response status.
	Status *v1beta12.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 generated access password.
	AppPasswords []*AppPassword `protobuf:"bytes,3,rep,name=app_passwords,json=appPasswords,proto3" json:"app_passwords,omitempty"`
	// contains filtered or unexported fields
}

func (*ListAppPasswordsResponse) Descriptor deprecated

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

Deprecated: Use ListAppPasswordsResponse.ProtoReflect.Descriptor instead.

func (*ListAppPasswordsResponse) GetAppPasswords

func (x *ListAppPasswordsResponse) GetAppPasswords() []*AppPassword

func (*ListAppPasswordsResponse) GetOpaque

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

func (*ListAppPasswordsResponse) GetStatus

func (x *ListAppPasswordsResponse) GetStatus() *v1beta12.Status

func (*ListAppPasswordsResponse) ProtoMessage

func (*ListAppPasswordsResponse) ProtoMessage()

func (*ListAppPasswordsResponse) ProtoReflect

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

func (*ListAppPasswordsResponse) Reset

func (x *ListAppPasswordsResponse) Reset()

func (*ListAppPasswordsResponse) String

func (x *ListAppPasswordsResponse) String() string

type UnimplementedApplicationsAPIServer

type UnimplementedApplicationsAPIServer struct {
}

UnimplementedApplicationsAPIServer should be embedded to have forward compatible implementations.

func (UnimplementedApplicationsAPIServer) GenerateAppPassword

func (UnimplementedApplicationsAPIServer) GetAppPassword

func (UnimplementedApplicationsAPIServer) ListAppPasswords

type UnsafeApplicationsAPIServer

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

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

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL