userv1

package
v0.0.0-...-94cd6a6 Latest Latest
Warning

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

Go to latest
Published: Apr 17, 2025 License: Apache-2.0 Imports: 12 Imported by: 0

Documentation

Index

Constants

View Source
const (
	UserService_CreateUser_FullMethodName  = "/cloudstack.management.user.v1.UserService/CreateUser"
	UserService_DeleteUser_FullMethodName  = "/cloudstack.management.user.v1.UserService/DeleteUser"
	UserService_DisableUser_FullMethodName = "/cloudstack.management.user.v1.UserService/DisableUser"
	UserService_EnableUser_FullMethodName  = "/cloudstack.management.user.v1.UserService/EnableUser"
	UserService_GetUser_FullMethodName     = "/cloudstack.management.user.v1.UserService/GetUser"
	UserService_GetUserKeys_FullMethodName = "/cloudstack.management.user.v1.UserService/GetUserKeys"
	UserService_ListUsers_FullMethodName   = "/cloudstack.management.user.v1.UserService/ListUsers"
	UserService_LockUser_FullMethodName    = "/cloudstack.management.user.v1.UserService/LockUser"
	UserService_MoveUser_FullMethodName    = "/cloudstack.management.user.v1.UserService/MoveUser"
	UserService_Register_FullMethodName    = "/cloudstack.management.user.v1.UserService/Register"
	UserService_UpdateUser_FullMethodName  = "/cloudstack.management.user.v1.UserService/UpdateUser"
)

Variables

View Source
var (
	UserSourceType_name = map[int32]string{
		0: "USER_SOURCE_TYPE_UNSPECIFIED",
		1: "USER_SOURCE_TYPE_LDAP",
	}
	UserSourceType_value = map[string]int32{
		"USER_SOURCE_TYPE_UNSPECIFIED": 0,
		"USER_SOURCE_TYPE_LDAP":        1,
	}
)

Enum value maps for UserSourceType.

View Source
var File_cloudstack_management_user_v1_user_gen_proto protoreflect.FileDescriptor
View Source
var UserService_ServiceDesc = grpc.ServiceDesc{
	ServiceName: "cloudstack.management.user.v1.UserService",
	HandlerType: (*UserServiceServer)(nil),
	Methods: []grpc.MethodDesc{
		{
			MethodName: "CreateUser",
			Handler:    _UserService_CreateUser_Handler,
		},
		{
			MethodName: "DeleteUser",
			Handler:    _UserService_DeleteUser_Handler,
		},
		{
			MethodName: "DisableUser",
			Handler:    _UserService_DisableUser_Handler,
		},
		{
			MethodName: "EnableUser",
			Handler:    _UserService_EnableUser_Handler,
		},
		{
			MethodName: "GetUser",
			Handler:    _UserService_GetUser_Handler,
		},
		{
			MethodName: "GetUserKeys",
			Handler:    _UserService_GetUserKeys_Handler,
		},
		{
			MethodName: "ListUsers",
			Handler:    _UserService_ListUsers_Handler,
		},
		{
			MethodName: "LockUser",
			Handler:    _UserService_LockUser_Handler,
		},
		{
			MethodName: "MoveUser",
			Handler:    _UserService_MoveUser_Handler,
		},
		{
			MethodName: "Register",
			Handler:    _UserService_Register_Handler,
		},
		{
			MethodName: "UpdateUser",
			Handler:    _UserService_UpdateUser_Handler,
		},
	},
	Streams:  []grpc.StreamDesc{},
	Metadata: "cloudstack/management/user/v1/user.gen.proto",
}

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

Functions

func RegisterUserServiceServer

func RegisterUserServiceServer(s grpc.ServiceRegistrar, srv UserServiceServer)

Types

type CreateUserRequest

type CreateUserRequest struct {

	// Creates the user under the specified account. If no account is specified, the username will be used as the account name.
	AccountName *string `protobuf:"bytes,1,opt,name=account_name,json=accountName" json:"account_name,omitempty"`
	// Creates the user under the specified domain. Has to be accompanied with the account parameter
	DomainId *int64 `protobuf:"varint,2,opt,name=domain_id,json=domainId" json:"domain_id,omitempty"`
	// email
	Email *string `protobuf:"bytes,3,opt,name=email" json:"email,omitempty"`
	// firstname
	Firstname *string `protobuf:"bytes,4,opt,name=firstname" json:"firstname,omitempty"`
	// lastname
	Lastname *string `protobuf:"bytes,5,opt,name=lastname" json:"lastname,omitempty"`
	// Clear text password (Default hashed to SHA256SALT). If you wish to use any other hashing algorithm, you would need to write a custom authentication adapter See Docs section.
	Password *string `protobuf:"bytes,6,opt,name=password" json:"password,omitempty"`
	// Specifies a timezone for this command. For more information on the timezone parameter, see Time Zone Format.
	Timezone *string `protobuf:"bytes,7,opt,name=timezone" json:"timezone,omitempty"`
	// Unique username.
	Username *string `protobuf:"bytes,8,opt,name=username" json:"username,omitempty"`
	// User UUID, required for adding account from external provisioning system
	UserUUId     *string `protobuf:"bytes,9,opt,name=user_u_u_id,json=userUUId" json:"user_u_u_id,omitempty"`
	ResponseType *string `protobuf:"bytes,10,opt,name=response_type,json=responseType" json:"response_type,omitempty"`
	// contains filtered or unexported fields
}

CreateUserRequest represents the parameters for creates a user for an account that already exists

func (*CreateUserRequest) Descriptor deprecated

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

Deprecated: Use CreateUserRequest.ProtoReflect.Descriptor instead.

func (*CreateUserRequest) GetAccountName

func (x *CreateUserRequest) GetAccountName() string

func (*CreateUserRequest) GetDomainId

func (x *CreateUserRequest) GetDomainId() int64

func (*CreateUserRequest) GetEmail

func (x *CreateUserRequest) GetEmail() string

func (*CreateUserRequest) GetFirstname

func (x *CreateUserRequest) GetFirstname() string

func (*CreateUserRequest) GetLastname

func (x *CreateUserRequest) GetLastname() string

func (*CreateUserRequest) GetPassword

func (x *CreateUserRequest) GetPassword() string

func (*CreateUserRequest) GetResponseType

func (x *CreateUserRequest) GetResponseType() string

func (*CreateUserRequest) GetTimezone

func (x *CreateUserRequest) GetTimezone() string

func (*CreateUserRequest) GetUserUUId

func (x *CreateUserRequest) GetUserUUId() string

func (*CreateUserRequest) GetUsername

func (x *CreateUserRequest) GetUsername() string

func (*CreateUserRequest) ProtoMessage

func (*CreateUserRequest) ProtoMessage()

func (*CreateUserRequest) ProtoReflect

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

func (*CreateUserRequest) Reset

func (x *CreateUserRequest) Reset()

func (*CreateUserRequest) String

func (x *CreateUserRequest) String() string

type CreateUserResponse

type CreateUserResponse struct {

	// The Result
	Result *Result `protobuf:"bytes,1,opt,name=result" json:"result,omitempty"`
	// contains filtered or unexported fields
}

CreateUserResponse represents the response from creates a user for an account that already exists

func (*CreateUserResponse) Descriptor deprecated

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

Deprecated: Use CreateUserResponse.ProtoReflect.Descriptor instead.

func (*CreateUserResponse) GetResult

func (x *CreateUserResponse) GetResult() *Result

func (*CreateUserResponse) ProtoMessage

func (*CreateUserResponse) ProtoMessage()

func (*CreateUserResponse) ProtoReflect

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

func (*CreateUserResponse) Reset

func (x *CreateUserResponse) Reset()

func (*CreateUserResponse) String

func (x *CreateUserResponse) String() string

type DeleteUserRequest

type DeleteUserRequest struct {

	// id of the user to be deleted
	Id           *int64  `protobuf:"varint,1,opt,name=id" json:"id,omitempty"`
	ResponseType *string `protobuf:"bytes,2,opt,name=response_type,json=responseType" json:"response_type,omitempty"`
	// contains filtered or unexported fields
}

DeleteUserRequest represents the parameters for deletes a user for an account

func (*DeleteUserRequest) Descriptor deprecated

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

Deprecated: Use DeleteUserRequest.ProtoReflect.Descriptor instead.

func (*DeleteUserRequest) GetId

func (x *DeleteUserRequest) GetId() int64

func (*DeleteUserRequest) GetResponseType

func (x *DeleteUserRequest) GetResponseType() string

func (*DeleteUserRequest) ProtoMessage

func (*DeleteUserRequest) ProtoMessage()

func (*DeleteUserRequest) ProtoReflect

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

func (*DeleteUserRequest) Reset

func (x *DeleteUserRequest) Reset()

func (*DeleteUserRequest) String

func (x *DeleteUserRequest) String() string

type DeleteUserResponse

type DeleteUserResponse struct {

	// The Result
	Result *Result `protobuf:"bytes,1,opt,name=result" json:"result,omitempty"`
	// contains filtered or unexported fields
}

DeleteUserResponse represents the response from deletes a user for an account

func (*DeleteUserResponse) Descriptor deprecated

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

Deprecated: Use DeleteUserResponse.ProtoReflect.Descriptor instead.

func (*DeleteUserResponse) GetResult

func (x *DeleteUserResponse) GetResult() *Result

func (*DeleteUserResponse) ProtoMessage

func (*DeleteUserResponse) ProtoMessage()

func (*DeleteUserResponse) ProtoReflect

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

func (*DeleteUserResponse) Reset

func (x *DeleteUserResponse) Reset()

func (*DeleteUserResponse) String

func (x *DeleteUserResponse) String() string

type DisableUserRequest

type DisableUserRequest struct {

	// Disables user by user ID.
	Id            *int64  `protobuf:"varint,1,opt,name=id" json:"id,omitempty"`
	StartEventId  *int64  `protobuf:"varint,2,opt,name=start_event_id,json=startEventId" json:"start_event_id,omitempty"`
	InjectedJobId *string `protobuf:"bytes,3,opt,name=injected_job_id,json=injectedJobId" json:"injected_job_id,omitempty"`
	ResponseType  *string `protobuf:"bytes,4,opt,name=response_type,json=responseType" json:"response_type,omitempty"`
	// contains filtered or unexported fields
}

DisableUserRequest represents the parameters for disables a user account

func (*DisableUserRequest) Descriptor deprecated

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

Deprecated: Use DisableUserRequest.ProtoReflect.Descriptor instead.

func (*DisableUserRequest) GetId

func (x *DisableUserRequest) GetId() int64

func (*DisableUserRequest) GetInjectedJobId

func (x *DisableUserRequest) GetInjectedJobId() string

func (*DisableUserRequest) GetResponseType

func (x *DisableUserRequest) GetResponseType() string

func (*DisableUserRequest) GetStartEventId

func (x *DisableUserRequest) GetStartEventId() int64

func (*DisableUserRequest) ProtoMessage

func (*DisableUserRequest) ProtoMessage()

func (*DisableUserRequest) ProtoReflect

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

func (*DisableUserRequest) Reset

func (x *DisableUserRequest) Reset()

func (*DisableUserRequest) String

func (x *DisableUserRequest) String() string

type DisableUserResponse

type DisableUserResponse struct {

	// The Result
	Result *Result `protobuf:"bytes,1,opt,name=result" json:"result,omitempty"`
	// contains filtered or unexported fields
}

DisableUserResponse represents the response from disables a user account

func (*DisableUserResponse) Descriptor deprecated

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

Deprecated: Use DisableUserResponse.ProtoReflect.Descriptor instead.

func (*DisableUserResponse) GetResult

func (x *DisableUserResponse) GetResult() *Result

func (*DisableUserResponse) ProtoMessage

func (*DisableUserResponse) ProtoMessage()

func (*DisableUserResponse) ProtoReflect

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

func (*DisableUserResponse) Reset

func (x *DisableUserResponse) Reset()

func (*DisableUserResponse) String

func (x *DisableUserResponse) String() string

type EnableUserRequest

type EnableUserRequest struct {

	// Enables user by user ID.
	Id           *int64  `protobuf:"varint,1,opt,name=id" json:"id,omitempty"`
	ResponseType *string `protobuf:"bytes,2,opt,name=response_type,json=responseType" json:"response_type,omitempty"`
	// contains filtered or unexported fields
}

EnableUserRequest represents the parameters for enables a user account

func (*EnableUserRequest) Descriptor deprecated

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

Deprecated: Use EnableUserRequest.ProtoReflect.Descriptor instead.

func (*EnableUserRequest) GetId

func (x *EnableUserRequest) GetId() int64

func (*EnableUserRequest) GetResponseType

func (x *EnableUserRequest) GetResponseType() string

func (*EnableUserRequest) ProtoMessage

func (*EnableUserRequest) ProtoMessage()

func (*EnableUserRequest) ProtoReflect

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

func (*EnableUserRequest) Reset

func (x *EnableUserRequest) Reset()

func (*EnableUserRequest) String

func (x *EnableUserRequest) String() string

type EnableUserResponse

type EnableUserResponse struct {

	// The Result
	Result *Result `protobuf:"bytes,1,opt,name=result" json:"result,omitempty"`
	// contains filtered or unexported fields
}

EnableUserResponse represents the response from enables a user account

func (*EnableUserResponse) Descriptor deprecated

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

Deprecated: Use EnableUserResponse.ProtoReflect.Descriptor instead.

func (*EnableUserResponse) GetResult

func (x *EnableUserResponse) GetResult() *Result

func (*EnableUserResponse) ProtoMessage

func (*EnableUserResponse) ProtoMessage()

func (*EnableUserResponse) ProtoReflect

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

func (*EnableUserResponse) Reset

func (x *EnableUserResponse) Reset()

func (*EnableUserResponse) String

func (x *EnableUserResponse) String() string

type GetUserKeysRequest

type GetUserKeysRequest struct {

	// ID of the user whose keys are required
	Id           *int64  `protobuf:"varint,1,opt,name=id" json:"id,omitempty"`
	ResponseType *string `protobuf:"bytes,2,opt,name=response_type,json=responseType" json:"response_type,omitempty"`
	// contains filtered or unexported fields
}

GetUserKeysRequest represents the parameters for this command allows the user to query the seceret and api keys for the account

func (*GetUserKeysRequest) Descriptor deprecated

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

Deprecated: Use GetUserKeysRequest.ProtoReflect.Descriptor instead.

func (*GetUserKeysRequest) GetId

func (x *GetUserKeysRequest) GetId() int64

func (*GetUserKeysRequest) GetResponseType

func (x *GetUserKeysRequest) GetResponseType() string

func (*GetUserKeysRequest) ProtoMessage

func (*GetUserKeysRequest) ProtoMessage()

func (*GetUserKeysRequest) ProtoReflect

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

func (*GetUserKeysRequest) Reset

func (x *GetUserKeysRequest) Reset()

func (*GetUserKeysRequest) String

func (x *GetUserKeysRequest) String() string

type GetUserKeysResponse

type GetUserKeysResponse struct {

	// The Result
	Result *Result `protobuf:"bytes,1,opt,name=result" json:"result,omitempty"`
	// contains filtered or unexported fields
}

GetUserKeysResponse represents the response from this command allows the user to query the seceret and api keys for the account

func (*GetUserKeysResponse) Descriptor deprecated

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

Deprecated: Use GetUserKeysResponse.ProtoReflect.Descriptor instead.

func (*GetUserKeysResponse) GetResult

func (x *GetUserKeysResponse) GetResult() *Result

func (*GetUserKeysResponse) ProtoMessage

func (*GetUserKeysResponse) ProtoMessage()

func (*GetUserKeysResponse) ProtoReflect

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

func (*GetUserKeysResponse) Reset

func (x *GetUserKeysResponse) Reset()

func (*GetUserKeysResponse) String

func (x *GetUserKeysResponse) String() string

type GetUserRequest

type GetUserRequest struct {

	// API key of the user
	ApiKey       *string `protobuf:"bytes,1,opt,name=api_key,json=apiKey" json:"api_key,omitempty"`
	ResponseType *string `protobuf:"bytes,2,opt,name=response_type,json=responseType" json:"response_type,omitempty"`
	// contains filtered or unexported fields
}

GetUserRequest represents the parameters for find user account by api key

func (*GetUserRequest) Descriptor deprecated

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

Deprecated: Use GetUserRequest.ProtoReflect.Descriptor instead.

func (*GetUserRequest) GetApiKey

func (x *GetUserRequest) GetApiKey() string

func (*GetUserRequest) GetResponseType

func (x *GetUserRequest) GetResponseType() string

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 {

	// The Result
	Result *Result `protobuf:"bytes,1,opt,name=result" json:"result,omitempty"`
	// contains filtered or unexported fields
}

GetUserResponse represents the response from find user account by api key

func (*GetUserResponse) Descriptor deprecated

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

Deprecated: Use GetUserResponse.ProtoReflect.Descriptor instead.

func (*GetUserResponse) GetResult

func (x *GetUserResponse) GetResult() *Result

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 ListUsersRequest

type ListUsersRequest struct {

	// List users by account type. Valid types include admin, domain-admin, read-only-admin, or user.
	AccountType *int32 `protobuf:"varint,1,opt,name=account_type,json=accountType" json:"account_type,omitempty"`
	// List user by ID.
	Id *int64 `protobuf:"varint,2,opt,name=id" json:"id,omitempty"`
	// List users by state of the user account.
	State *string `protobuf:"bytes,3,opt,name=state" json:"state,omitempty"`
	// List user by the username
	Username *string `protobuf:"bytes,4,opt,name=username" json:"username,omitempty"`
	// List users by the Api key access value
	ApiKeyAccess *string `protobuf:"bytes,5,opt,name=api_key_access,json=apiKeyAccess" json:"api_key_access,omitempty"`
	// flag to display the resource icon for users
	ShowIcon *bool `protobuf:"varint,6,opt,name=show_icon,json=showIcon" json:"show_icon,omitempty"`
	// List users by their authentication source. Valid values are: native, ldap, saml2 and saml2disabled.
	UserSource *string `protobuf:"bytes,7,opt,name=user_source,json=userSource" json:"user_source,omitempty"`
	// list resources by account. Must be used with the domainId parameter.
	AccountName *string `protobuf:"bytes,8,opt,name=account_name,json=accountName" json:"account_name,omitempty"`
	// If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.
	ListAll *bool `protobuf:"varint,9,opt,name=list_all,json=listAll" json:"list_all,omitempty"`
	// list only resources belonging to the domain specified
	DomainId *int64 `protobuf:"varint,10,opt,name=domain_id,json=domainId" json:"domain_id,omitempty"`
	// defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.
	Recursive *bool `protobuf:"varint,11,opt,name=recursive" json:"recursive,omitempty"`
	// List by keyword
	Keyword      *string `protobuf:"bytes,12,opt,name=keyword" json:"keyword,omitempty"`
	Page         *int32  `protobuf:"varint,13,opt,name=page" json:"page,omitempty"`
	PageSize     *int32  `protobuf:"varint,14,opt,name=page_size,json=pageSize" json:"page_size,omitempty"`
	ResponseType *string `protobuf:"bytes,15,opt,name=response_type,json=responseType" json:"response_type,omitempty"`
	// contains filtered or unexported fields
}

ListUsersRequest represents the parameters for lists user accounts

func (*ListUsersRequest) Descriptor deprecated

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

Deprecated: Use ListUsersRequest.ProtoReflect.Descriptor instead.

func (*ListUsersRequest) GetAccountName

func (x *ListUsersRequest) GetAccountName() string

func (*ListUsersRequest) GetAccountType

func (x *ListUsersRequest) GetAccountType() int32

func (*ListUsersRequest) GetApiKeyAccess

func (x *ListUsersRequest) GetApiKeyAccess() string

func (*ListUsersRequest) GetDomainId

func (x *ListUsersRequest) GetDomainId() int64

func (*ListUsersRequest) GetId

func (x *ListUsersRequest) GetId() int64

func (*ListUsersRequest) GetKeyword

func (x *ListUsersRequest) GetKeyword() string

func (*ListUsersRequest) GetListAll

func (x *ListUsersRequest) GetListAll() bool

func (*ListUsersRequest) GetPage

func (x *ListUsersRequest) GetPage() int32

func (*ListUsersRequest) GetPageSize

func (x *ListUsersRequest) GetPageSize() int32

func (*ListUsersRequest) GetRecursive

func (x *ListUsersRequest) GetRecursive() bool

func (*ListUsersRequest) GetResponseType

func (x *ListUsersRequest) GetResponseType() string

func (*ListUsersRequest) GetShowIcon

func (x *ListUsersRequest) GetShowIcon() bool

func (*ListUsersRequest) GetState

func (x *ListUsersRequest) GetState() string

func (*ListUsersRequest) GetUserSource

func (x *ListUsersRequest) GetUserSource() string

func (*ListUsersRequest) GetUsername

func (x *ListUsersRequest) GetUsername() string

func (*ListUsersRequest) ProtoMessage

func (*ListUsersRequest) ProtoMessage()

func (*ListUsersRequest) ProtoReflect

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

func (*ListUsersRequest) Reset

func (x *ListUsersRequest) Reset()

func (*ListUsersRequest) String

func (x *ListUsersRequest) String() string

type ListUsersResponse

type ListUsersResponse struct {

	// The list of Users
	Items []*User `protobuf:"bytes,1,rep,name=items" json:"items,omitempty"`
	// The total count of Users
	TotalCount *int32 `protobuf:"varint,2,opt,name=total_count,json=totalCount" json:"total_count,omitempty"`
	// contains filtered or unexported fields
}

ListUsersResponse represents the response from lists user accounts

func (*ListUsersResponse) Descriptor deprecated

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

Deprecated: Use ListUsersResponse.ProtoReflect.Descriptor instead.

func (*ListUsersResponse) GetItems

func (x *ListUsersResponse) GetItems() []*User

func (*ListUsersResponse) GetTotalCount

func (x *ListUsersResponse) GetTotalCount() int32

func (*ListUsersResponse) ProtoMessage

func (*ListUsersResponse) ProtoMessage()

func (*ListUsersResponse) ProtoReflect

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

func (*ListUsersResponse) Reset

func (x *ListUsersResponse) Reset()

func (*ListUsersResponse) String

func (x *ListUsersResponse) String() string

type LockUserRequest

type LockUserRequest struct {

	// Locks user by user ID.
	Id           *int64  `protobuf:"varint,1,opt,name=id" json:"id,omitempty"`
	ResponseType *string `protobuf:"bytes,2,opt,name=response_type,json=responseType" json:"response_type,omitempty"`
	// contains filtered or unexported fields
}

LockUserRequest represents the parameters for locks a user account

func (*LockUserRequest) Descriptor deprecated

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

Deprecated: Use LockUserRequest.ProtoReflect.Descriptor instead.

func (*LockUserRequest) GetId

func (x *LockUserRequest) GetId() int64

func (*LockUserRequest) GetResponseType

func (x *LockUserRequest) GetResponseType() string

func (*LockUserRequest) ProtoMessage

func (*LockUserRequest) ProtoMessage()

func (*LockUserRequest) ProtoReflect

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

func (*LockUserRequest) Reset

func (x *LockUserRequest) Reset()

func (*LockUserRequest) String

func (x *LockUserRequest) String() string

type LockUserResponse

type LockUserResponse struct {

	// The Result
	Result *Result `protobuf:"bytes,1,opt,name=result" json:"result,omitempty"`
	// contains filtered or unexported fields
}

LockUserResponse represents the response from locks a user account

func (*LockUserResponse) Descriptor deprecated

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

Deprecated: Use LockUserResponse.ProtoReflect.Descriptor instead.

func (*LockUserResponse) GetResult

func (x *LockUserResponse) GetResult() *Result

func (*LockUserResponse) ProtoMessage

func (*LockUserResponse) ProtoMessage()

func (*LockUserResponse) ProtoReflect

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

func (*LockUserResponse) Reset

func (x *LockUserResponse) Reset()

func (*LockUserResponse) String

func (x *LockUserResponse) String() string

type MoveUserRequest

type MoveUserRequest struct {

	// id of the user to be moved.
	Id *int64 `protobuf:"varint,1,opt,name=id" json:"id,omitempty"`
	// Moves the user under the specified account. If no account name is specified, it is necessary to provide an account id.
	AccountName *string `protobuf:"bytes,2,opt,name=account_name,json=accountName" json:"account_name,omitempty"`
	// Moves the user under the specified account. If no account id is specified, it is necessary to provide an account name.
	AccountId    *int64  `protobuf:"varint,3,opt,name=account_id,json=accountId" json:"account_id,omitempty"`
	ResponseType *string `protobuf:"bytes,4,opt,name=response_type,json=responseType" json:"response_type,omitempty"`
	// contains filtered or unexported fields
}

MoveUserRequest represents the parameters for moves a user to another account in the same domain.

func (*MoveUserRequest) Descriptor deprecated

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

Deprecated: Use MoveUserRequest.ProtoReflect.Descriptor instead.

func (*MoveUserRequest) GetAccountId

func (x *MoveUserRequest) GetAccountId() int64

func (*MoveUserRequest) GetAccountName

func (x *MoveUserRequest) GetAccountName() string

func (*MoveUserRequest) GetId

func (x *MoveUserRequest) GetId() int64

func (*MoveUserRequest) GetResponseType

func (x *MoveUserRequest) GetResponseType() string

func (*MoveUserRequest) ProtoMessage

func (*MoveUserRequest) ProtoMessage()

func (*MoveUserRequest) ProtoReflect

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

func (*MoveUserRequest) Reset

func (x *MoveUserRequest) Reset()

func (*MoveUserRequest) String

func (x *MoveUserRequest) String() string

type MoveUserResponse

type MoveUserResponse struct {

	// The Result
	Result *Result `protobuf:"bytes,1,opt,name=result" json:"result,omitempty"`
	// contains filtered or unexported fields
}

MoveUserResponse represents the response from moves a user to another account in the same domain.

func (*MoveUserResponse) Descriptor deprecated

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

Deprecated: Use MoveUserResponse.ProtoReflect.Descriptor instead.

func (*MoveUserResponse) GetResult

func (x *MoveUserResponse) GetResult() *Result

func (*MoveUserResponse) ProtoMessage

func (*MoveUserResponse) ProtoMessage()

func (*MoveUserResponse) ProtoReflect

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

func (*MoveUserResponse) Reset

func (x *MoveUserResponse) Reset()

func (*MoveUserResponse) String

func (x *MoveUserResponse) String() string

type RegisterRequest

type RegisterRequest struct {

	// User id
	Id           *int64  `protobuf:"varint,1,opt,name=id" json:"id,omitempty"`
	ResponseType *string `protobuf:"bytes,2,opt,name=response_type,json=responseType" json:"response_type,omitempty"`
	// contains filtered or unexported fields
}

RegisterRequest represents the parameters for this command allows a user to register for the developer api, returning a secret key and an api key. this request is made through the integration api port, so it is a privileged command and must be made on behalf of a user. it is up to the implementer just how the username and password are entered, and then how that translates to an integration api request. both secret key and api key should be returned to the user

func (*RegisterRequest) Descriptor deprecated

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

Deprecated: Use RegisterRequest.ProtoReflect.Descriptor instead.

func (*RegisterRequest) GetId

func (x *RegisterRequest) GetId() int64

func (*RegisterRequest) GetResponseType

func (x *RegisterRequest) GetResponseType() string

func (*RegisterRequest) ProtoMessage

func (*RegisterRequest) ProtoMessage()

func (*RegisterRequest) ProtoReflect

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

func (*RegisterRequest) Reset

func (x *RegisterRequest) Reset()

func (*RegisterRequest) String

func (x *RegisterRequest) String() string

type RegisterResponse

type RegisterResponse struct {

	// The Result
	Result *Result `protobuf:"bytes,1,opt,name=result" json:"result,omitempty"`
	// contains filtered or unexported fields
}

RegisterResponse represents the response from this command allows a user to register for the developer api, returning a secret key and an api key. this request is made through the integration api port, so it is a privileged command and must be made on behalf of a user. it is up to the implementer just how the username and password are entered, and then how that translates to an integration api request. both secret key and api key should be returned to the user

func (*RegisterResponse) Descriptor deprecated

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

Deprecated: Use RegisterResponse.ProtoReflect.Descriptor instead.

func (*RegisterResponse) GetResult

func (x *RegisterResponse) GetResult() *Result

func (*RegisterResponse) ProtoMessage

func (*RegisterResponse) ProtoMessage()

func (*RegisterResponse) ProtoReflect

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

func (*RegisterResponse) Reset

func (x *RegisterResponse) Reset()

func (*RegisterResponse) String

func (x *RegisterResponse) String() string

type Result

type Result struct {

	// Whether the operation was successful
	Success *bool `protobuf:"varint,1,opt,name=success" json:"success,omitempty"`
	// Any text associated with the success or failure
	DisplayText *string `protobuf:"bytes,2,opt,name=display_text,json=displayText" json:"display_text,omitempty"`
	// The ID of the resource affected by the operation
	Id *string `protobuf:"bytes,3,opt,name=id" json:"id,omitempty"`
	// The job ID for an async operation
	JobId *string `protobuf:"bytes,4,opt,name=job_id,json=jobId" json:"job_id,omitempty"`
	// The status of the job
	JobStatus *string `protobuf:"bytes,5,opt,name=job_status,json=jobStatus" json:"job_status,omitempty"`
	// contains filtered or unexported fields
}

Result represents a generic operation result

func (*Result) Descriptor deprecated

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

Deprecated: Use Result.ProtoReflect.Descriptor instead.

func (*Result) GetDisplayText

func (x *Result) GetDisplayText() string

func (*Result) GetId

func (x *Result) GetId() string

func (*Result) GetJobId

func (x *Result) GetJobId() string

func (*Result) GetJobStatus

func (x *Result) GetJobStatus() string

func (*Result) GetSuccess

func (x *Result) GetSuccess() bool

func (*Result) ProtoMessage

func (*Result) ProtoMessage()

func (*Result) ProtoReflect

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

func (*Result) Reset

func (x *Result) Reset()

func (*Result) String

func (x *Result) String() string

type Success

type Success struct {

	// true if operation is executed successfully
	Success *bool `protobuf:"varint,1,opt,name=success" json:"success,omitempty"`
	// any text associated with the success or failure
	DisplayText *string `protobuf:"bytes,2,opt,name=display_text,json=displayText" json:"display_text,omitempty"`
	// contains filtered or unexported fields
}

Success represents a Success Operation Response

func (*Success) Descriptor deprecated

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

Deprecated: Use Success.ProtoReflect.Descriptor instead.

func (*Success) GetDisplayText

func (x *Success) GetDisplayText() string

func (*Success) GetSuccess

func (x *Success) GetSuccess() bool

func (*Success) ProtoMessage

func (*Success) ProtoMessage()

func (*Success) ProtoReflect

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

func (*Success) Reset

func (x *Success) Reset()

func (*Success) String

func (x *Success) String() string

type UnimplementedUserServiceServer

type UnimplementedUserServiceServer struct{}

UnimplementedUserServiceServer must be embedded to have forward compatible implementations.

NOTE: this should be embedded by value instead of pointer to avoid a nil pointer dereference when methods are called.

func (UnimplementedUserServiceServer) CreateUser

func (UnimplementedUserServiceServer) DeleteUser

func (UnimplementedUserServiceServer) DisableUser

func (UnimplementedUserServiceServer) EnableUser

func (UnimplementedUserServiceServer) GetUser

func (UnimplementedUserServiceServer) GetUserKeys

func (UnimplementedUserServiceServer) ListUsers

func (UnimplementedUserServiceServer) LockUser

func (UnimplementedUserServiceServer) MoveUser

func (UnimplementedUserServiceServer) Register

func (UnimplementedUserServiceServer) UpdateUser

type UnsafeUserServiceServer

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

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

type UpdateUserRequest

type UpdateUserRequest struct {

	// The API key for the user. Must be specified with userSecretKey
	ApiKey *string `protobuf:"bytes,1,opt,name=api_key,json=apiKey" json:"api_key,omitempty"`
	// email
	Email *string `protobuf:"bytes,2,opt,name=email" json:"email,omitempty"`
	// first name
	Firstname *string `protobuf:"bytes,3,opt,name=firstname" json:"firstname,omitempty"`
	// User uuid
	Id *int64 `protobuf:"varint,4,opt,name=id" json:"id,omitempty"`
	// last name
	Lastname *string `protobuf:"bytes,5,opt,name=lastname" json:"lastname,omitempty"`
	// Clear text password (default hashed to SHA256SALT). If you wish to use any other hashing algorithm, you would need to write a custom authentication adapter. Can't be passed when command is executed via integration.api.port
	Password *string `protobuf:"bytes,6,opt,name=password" json:"password,omitempty"`
	// Current password that was being used by the user. You must inform the current password when updating the password.
	CurrentPassword *string `protobuf:"bytes,7,opt,name=current_password,json=currentPassword" json:"current_password,omitempty"`
	// The secret key for the user. Must be specified with userApiKey
	SecretKey *string `protobuf:"bytes,8,opt,name=secret_key,json=secretKey" json:"secret_key,omitempty"`
	// Determines if Api key access for this user is enabled, disabled or inherits the value from its parent, the owning account
	ApiKeyAccess *string `protobuf:"bytes,9,opt,name=api_key_access,json=apiKeyAccess" json:"api_key_access,omitempty"`
	// Specifies a timezone for this command. For more information on the timezone parameter, see Time Zone Format.
	Timezone *string `protobuf:"bytes,10,opt,name=timezone" json:"timezone,omitempty"`
	// Unique username
	Username *string `protobuf:"bytes,11,opt,name=username" json:"username,omitempty"`
	// Provide true to mandate the user to use two factor authentication has to be enabled.This parameter is only used to mandate 2FA, not to disable 2FA
	Mandate2FA   *bool   `protobuf:"varint,12,opt,name=mandate2_f_a,json=mandate2FA" json:"mandate2_f_a,omitempty"`
	ResponseType *string `protobuf:"bytes,13,opt,name=response_type,json=responseType" json:"response_type,omitempty"`
	// contains filtered or unexported fields
}

UpdateUserRequest represents the parameters for updates a user account

func (*UpdateUserRequest) Descriptor deprecated

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

Deprecated: Use UpdateUserRequest.ProtoReflect.Descriptor instead.

func (*UpdateUserRequest) GetApiKey

func (x *UpdateUserRequest) GetApiKey() string

func (*UpdateUserRequest) GetApiKeyAccess

func (x *UpdateUserRequest) GetApiKeyAccess() string

func (*UpdateUserRequest) GetCurrentPassword

func (x *UpdateUserRequest) GetCurrentPassword() string

func (*UpdateUserRequest) GetEmail

func (x *UpdateUserRequest) GetEmail() string

func (*UpdateUserRequest) GetFirstname

func (x *UpdateUserRequest) GetFirstname() string

func (*UpdateUserRequest) GetId

func (x *UpdateUserRequest) GetId() int64

func (*UpdateUserRequest) GetLastname

func (x *UpdateUserRequest) GetLastname() string

func (*UpdateUserRequest) GetMandate2FA

func (x *UpdateUserRequest) GetMandate2FA() bool

func (*UpdateUserRequest) GetPassword

func (x *UpdateUserRequest) GetPassword() string

func (*UpdateUserRequest) GetResponseType

func (x *UpdateUserRequest) GetResponseType() string

func (*UpdateUserRequest) GetSecretKey

func (x *UpdateUserRequest) GetSecretKey() string

func (*UpdateUserRequest) GetTimezone

func (x *UpdateUserRequest) GetTimezone() string

func (*UpdateUserRequest) GetUsername

func (x *UpdateUserRequest) GetUsername() string

func (*UpdateUserRequest) ProtoMessage

func (*UpdateUserRequest) ProtoMessage()

func (*UpdateUserRequest) ProtoReflect

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

func (*UpdateUserRequest) Reset

func (x *UpdateUserRequest) Reset()

func (*UpdateUserRequest) String

func (x *UpdateUserRequest) String() string

type UpdateUserResponse

type UpdateUserResponse struct {

	// The Result
	Result *Result `protobuf:"bytes,1,opt,name=result" json:"result,omitempty"`
	// contains filtered or unexported fields
}

UpdateUserResponse represents the response from updates a user account

func (*UpdateUserResponse) Descriptor deprecated

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

Deprecated: Use UpdateUserResponse.ProtoReflect.Descriptor instead.

func (*UpdateUserResponse) GetResult

func (x *UpdateUserResponse) GetResult() *Result

func (*UpdateUserResponse) ProtoMessage

func (*UpdateUserResponse) ProtoMessage()

func (*UpdateUserResponse) ProtoReflect

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

func (*UpdateUserResponse) Reset

func (x *UpdateUserResponse) Reset()

func (*UpdateUserResponse) String

func (x *UpdateUserResponse) String() string

type User

type User struct {

	// The ID of the User
	Id *string `protobuf:"bytes,1,opt,name=id" json:"id,omitempty"`
	// The name of the User
	Name *string `protobuf:"bytes,2,opt,name=name" json:"name,omitempty"`
	// The display name of the User
	DisplayName *string `protobuf:"bytes,3,opt,name=display_name,json=displayName" json:"display_name,omitempty"`
	// The description of the User
	Description *string `protobuf:"bytes,4,opt,name=description" json:"description,omitempty"`
	// The date this entity was created
	Created *string `protobuf:"bytes,5,opt,name=created" json:"created,omitempty"`
	// contains filtered or unexported fields
}

User represents a User Item

func (*User) Descriptor deprecated

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

Deprecated: Use User.ProtoReflect.Descriptor instead.

func (*User) GetCreated

func (x *User) GetCreated() string

func (*User) GetDescription

func (x *User) GetDescription() string

func (*User) GetDisplayName

func (x *User) GetDisplayName() string

func (*User) GetId

func (x *User) GetId() string

func (*User) GetName

func (x *User) GetName() 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 UserServiceClient

type UserServiceClient interface {
	// CreateUser Creates a user for an account that already exists
	CreateUser(ctx context.Context, in *CreateUserRequest, opts ...grpc.CallOption) (*CreateUserResponse, error)
	// DeleteUser Deletes a user for an account
	DeleteUser(ctx context.Context, in *DeleteUserRequest, opts ...grpc.CallOption) (*DeleteUserResponse, error)
	// DisableUser Disables a user account
	DisableUser(ctx context.Context, in *DisableUserRequest, opts ...grpc.CallOption) (*DisableUserResponse, error)
	// EnableUser Enables a user account
	EnableUser(ctx context.Context, in *EnableUserRequest, opts ...grpc.CallOption) (*EnableUserResponse, error)
	// GetUser Find user account by API key
	GetUser(ctx context.Context, in *GetUserRequest, opts ...grpc.CallOption) (*GetUserResponse, error)
	// GetUserKeys This command allows the user to query the seceret and API keys for the account
	GetUserKeys(ctx context.Context, in *GetUserKeysRequest, opts ...grpc.CallOption) (*GetUserKeysResponse, error)
	// ListUsers Lists user accounts
	ListUsers(ctx context.Context, in *ListUsersRequest, opts ...grpc.CallOption) (*ListUsersResponse, error)
	// LockUser Locks a user account
	LockUser(ctx context.Context, in *LockUserRequest, opts ...grpc.CallOption) (*LockUserResponse, error)
	// MoveUser Moves a user to another account in the same domain.
	MoveUser(ctx context.Context, in *MoveUserRequest, opts ...grpc.CallOption) (*MoveUserResponse, error)
	// Register This command allows a user to register for the developer API, returning a secret key and an API key. This request is made through the integration API port, so it is a privileged command and must be made on behalf of a user. It is up to the implementer just how the username and password are entered, and then how that translates to an integration API request. Both secret key and API key should be returned to the user
	Register(ctx context.Context, in *RegisterRequest, opts ...grpc.CallOption) (*RegisterResponse, error)
	// UpdateUser Updates a user account
	UpdateUser(ctx context.Context, in *UpdateUserRequest, opts ...grpc.CallOption) (*UpdateUserResponse, error)
}

UserServiceClient is the client API for UserService 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.

UserService provides operations for managing Users

type UserServiceServer

type UserServiceServer interface {
	// CreateUser Creates a user for an account that already exists
	CreateUser(context.Context, *CreateUserRequest) (*CreateUserResponse, error)
	// DeleteUser Deletes a user for an account
	DeleteUser(context.Context, *DeleteUserRequest) (*DeleteUserResponse, error)
	// DisableUser Disables a user account
	DisableUser(context.Context, *DisableUserRequest) (*DisableUserResponse, error)
	// EnableUser Enables a user account
	EnableUser(context.Context, *EnableUserRequest) (*EnableUserResponse, error)
	// GetUser Find user account by API key
	GetUser(context.Context, *GetUserRequest) (*GetUserResponse, error)
	// GetUserKeys This command allows the user to query the seceret and API keys for the account
	GetUserKeys(context.Context, *GetUserKeysRequest) (*GetUserKeysResponse, error)
	// ListUsers Lists user accounts
	ListUsers(context.Context, *ListUsersRequest) (*ListUsersResponse, error)
	// LockUser Locks a user account
	LockUser(context.Context, *LockUserRequest) (*LockUserResponse, error)
	// MoveUser Moves a user to another account in the same domain.
	MoveUser(context.Context, *MoveUserRequest) (*MoveUserResponse, error)
	// Register This command allows a user to register for the developer API, returning a secret key and an API key. This request is made through the integration API port, so it is a privileged command and must be made on behalf of a user. It is up to the implementer just how the username and password are entered, and then how that translates to an integration API request. Both secret key and API key should be returned to the user
	Register(context.Context, *RegisterRequest) (*RegisterResponse, error)
	// UpdateUser Updates a user account
	UpdateUser(context.Context, *UpdateUserRequest) (*UpdateUserResponse, error)
	// contains filtered or unexported methods
}

UserServiceServer is the server API for UserService service. All implementations must embed UnimplementedUserServiceServer for forward compatibility.

UserService provides operations for managing Users

type UserSourceType

type UserSourceType int32

UserSourceType represents the possible values for List users by their authentication source. Valid values are: native, ldap, saml2 and saml2disabled.

const (
	// Default unspecified value
	UserSourceType_USER_SOURCE_TYPE_UNSPECIFIED UserSourceType = 0
	// LDAP value
	UserSourceType_USER_SOURCE_TYPE_LDAP UserSourceType = 1
)

func (UserSourceType) Descriptor

func (UserSourceType) Enum

func (x UserSourceType) Enum() *UserSourceType

func (UserSourceType) EnumDescriptor deprecated

func (UserSourceType) EnumDescriptor() ([]byte, []int)

Deprecated: Use UserSourceType.Descriptor instead.

func (UserSourceType) Number

func (UserSourceType) String

func (x UserSourceType) String() string

func (UserSourceType) Type

Directories

Path Synopsis

Jump to

Keyboard shortcuts

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