definition

type AuthenticationV1Client interface {
	// Validate and ensure that Authentication details are valid returns information about the user
	Validate(ctx context.Context, in *ValidateRequest, opts ...grpc.CallOption) (*ValidateResponse, error)
	// CreateToken creates a token for the specified user
	CreateToken(ctx context.Context, in *CreateTokenRequest, opts ...grpc.CallOption) (*CreateTokenResponse, error)
	// Identity extracts the identity from the request
	Identity(ctx context.Context, in *definition.Empty, opts ...grpc.CallOption) (*IdentityResponse, error)
	// Login calls /_open/auth endpoint to create JWT Token. Optionally, sets the header.
	Login(ctx context.Context, in *LoginRequest, opts ...grpc.CallOption) (*LoginResponse, error)
	// Logout ensures that credentials and cookies are removed
	Logout(ctx context.Context, in *LogoutRequest, opts ...grpc.CallOption) (*definition.Empty, error)
}

type AuthenticationV1Server interface {
	// Validate and ensure that Authentication details are valid returns information about the user
	Validate(context.Context, *ValidateRequest) (*ValidateResponse, error)
	// CreateToken creates a token for the specified user
	CreateToken(context.Context, *CreateTokenRequest) (*CreateTokenResponse, error)
	// Identity extracts the identity from the request
	Identity(context.Context, *definition.Empty) (*IdentityResponse, error)
	// Login calls /_open/auth endpoint to create JWT Token. Optionally, sets the header.
	Login(context.Context, *LoginRequest) (*LoginResponse, error)
	// Logout ensures that credentials and cookies are removed
	Logout(context.Context, *LogoutRequest) (*definition.Empty, error)
	// contains filtered or unexported methods
}

type CreateTokenRequest struct {

	// lifetime specifies the lifetime of the token as duration. Defaults to 1 hour
	Lifetime *durationpb.Duration `protobuf:"bytes,1,opt,name=lifetime,proto3,oneof" json:"lifetime,omitempty"`
	// user specify the User for which token should be created. By default, the default user is used (root in most cases)
	User *string `protobuf:"bytes,2,opt,name=user,proto3,oneof" json:"user,omitempty"`
	// roles specify list of the roles assigned to the token
	Roles []string `protobuf:"bytes,3,rep,name=roles,proto3" json:"roles,omitempty"`
	// contains filtered or unexported fields
}

type CreateTokenResponse struct {

	// lifetime specify the lifetime of the token as the duration
	Lifetime *durationpb.Duration `protobuf:"bytes,1,opt,name=lifetime,proto3" json:"lifetime,omitempty"`
	// user returns the User used in the Token
	User string `protobuf:"bytes,2,opt,name=user,proto3" json:"user,omitempty"`
	// token returns the Token as a string
	Token string `protobuf:"bytes,3,opt,name=token,proto3" json:"token,omitempty"`
	// roles specify list of the roles assigned to the token
	Roles []string `protobuf:"bytes,4,rep,name=roles,proto3" json:"roles,omitempty"`
	// contains filtered or unexported fields
}

type IdentityResponse struct {

	// user returns the User used in the Token. If a user is not specified, `root` is returned
	User string `protobuf:"bytes,1,opt,name=user,proto3" json:"user,omitempty"`
	// contains filtered or unexported fields
}

type LoginRequest struct {

	// credentials defines the login credentials
	Credentials *LoginRequestCredentials `protobuf:"bytes,1,opt,name=credentials,proto3" json:"credentials,omitempty"`
	// options define the login request options
	Options *LoginRequestOptions `protobuf:"bytes,2,opt,name=options,proto3" json:"options,omitempty"`
	// contains filtered or unexported fields
}

type LoginRequestCredentials struct {

	// username defines user for the authentication
	Username string `protobuf:"bytes,1,opt,name=username,proto3" json:"username,omitempty"`
	// password defines password for the authentication
	Password string `protobuf:"bytes,2,opt,name=password,proto3" json:"password,omitempty"`
	// contains filtered or unexported fields
}

type LoginRequestOptions struct {

	// cookies enables the cookie management
	Cookies *bool `protobuf:"varint,1,opt,name=cookies,proto3,oneof" json:"cookies,omitempty"`
	// contains filtered or unexported fields
}

type LoginResponse struct {

	// token returns the JWT Token
	Token string `protobuf:"bytes,1,opt,name=token,proto3" json:"token,omitempty"`
	// contains filtered or unexported fields
}

type LogoutRequest struct {

	// location defines logout location - defaults to /
	Location *string `protobuf:"bytes,1,opt,name=location,proto3,oneof" json:"location,omitempty"`
	// contains filtered or unexported fields
}

type UnimplementedAuthenticationV1Server struct {
}

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

type ValidateRequest struct {

	// token specifies a token extracted from the request or used currently
	Token string `protobuf:"bytes,1,opt,name=token,proto3" json:"token,omitempty"`
	// contains filtered or unexported fields
}

type ValidateResponse struct {

	// is_valid returns information about the validity of the token
	IsValid bool `protobuf:"varint,1,opt,name=is_valid,json=isValid,proto3" json:"is_valid,omitempty"`
	// message message for the validation phase
	Message string `protobuf:"bytes,2,opt,name=message,proto3" json:"message,omitempty"`
	// details returns token details if the token is valid
	Details *ValidateResponseDetails `protobuf:"bytes,3,opt,name=details,proto3,oneof" json:"details,omitempty"`
	// contains filtered or unexported fields
}

type ValidateResponseDetails struct {

	// lifetime specify the lifetime of the token
	Lifetime *durationpb.Duration `protobuf:"bytes,1,opt,name=lifetime,proto3" json:"lifetime,omitempty"`
	// user returns the User used in the Token. If a user is not specified, `root` is returned
	User string `protobuf:"bytes,2,opt,name=user,proto3" json:"user,omitempty"`
	// roles specify list of the roles assigned to the token
	Roles []string `protobuf:"bytes,3,rep,name=roles,proto3" json:"roles,omitempty"`
	// contains filtered or unexported fields
}