users

Documentation

Overview

Package users contains methods related to Users

Index

• type UsersV1
  • func (u *UsersV1) ChangePassword(userId int64, body *models.ChangePasswordV1Request) (interface{}, *apiutils.APIError)
  • func (u *UsersV1) CreateUser(body *models.CreateUserV1Request) (*models.CreateUserResponse, *apiutils.APIError)
  • func (u *UsersV1) DeleteUser(userId int64) (interface{}, *apiutils.APIError)
  • func (u *UsersV1) ListUsers(limit *int64, start *string, filter *string) (*models.ListUsersResponse, *apiutils.APIError)
  • func (u *UsersV1) ReadUser(userId int64) (*models.ReadUserResponse, *apiutils.APIError)
  • func (u *UsersV1) UpdateUser(userId int64, body *models.UpdateUserV1Request) (*models.UpdateUserResponse, *apiutils.APIError)
  • func (u *UsersV1) UpdateUserProfile(body *models.UpdateUserProfileV1Request) (*models.EditProfileResponse, *apiutils.APIError)
• type UsersV1Client
  • func NewUsersV1(config config.Config) UsersV1Client

Types

type UsersV1

type UsersV1 struct {
	// contains filtered or unexported fields
}

UsersV1 represents a custom type struct

func (*UsersV1) ChangePassword

func (u *UsersV1) ChangePassword(
	userId int64,
	body *models.ChangePasswordV1Request) (
	interface{}, *apiutils.APIError)

ChangePassword Change the password of the specified user. Users can change their own passwords.

func (*UsersV1) CreateUser

func (u *UsersV1) CreateUser(
	body *models.CreateUserV1Request) (
	*models.CreateUserResponse, *apiutils.APIError)

CreateUser Creates a new user. Specify the user's full name and email address to generate an email message that is sent to the user with an invitation to activate their Clumio account.

func (*UsersV1) DeleteUser

func (u *UsersV1) DeleteUser(
	userId int64) (
	interface{}, *apiutils.APIError)

DeleteUser Deletes an existing user from Clumio, revoking the user's access to Clumio. A deleted user cannot be recovered.

func (*UsersV1) ListUsers

func (u *UsersV1) ListUsers(
	limit *int64,
	start *string,
	filter *string) (
	*models.ListUsersResponse, *apiutils.APIError)

ListUsers Returns a list of Clumio users.

func (*UsersV1) ReadUser

func (u *UsersV1) ReadUser(
	userId int64) (
	*models.ReadUserResponse, *apiutils.APIError)

ReadUser Returns a representation of the specified Clumio user.

func (*UsersV1) UpdateUser

func (u *UsersV1) UpdateUser(
	userId int64,
	body *models.UpdateUserV1Request) (
	*models.UpdateUserResponse, *apiutils.APIError)

UpdateUser Manages an existing user. Managing a user includes enabling or disabling the user, changing the user's full name or updating the user's role.

func (*UsersV1) UpdateUserProfile

func (u *UsersV1) UpdateUserProfile(
	body *models.UpdateUserProfileV1Request) (
	*models.EditProfileResponse, *apiutils.APIError)

UpdateUserProfile Manages the current user's profile, such as changing the user's full name.

type UsersV1Client

type UsersV1Client interface {
	//  Returns a list of Clumio users.
	ListUsers(
		limit *int64,
		start *string,
		filter *string) (
		*models.ListUsersResponse, *apiutils.APIError)

	//  Creates a new user. Specify the user's full name and email address to generate an email message that is sent to the user with an invitation to activate their Clumio account.
	CreateUser(
		body *models.CreateUserV1Request) (
		*models.CreateUserResponse, *apiutils.APIError)

	//  Manages the current user's profile, such as changing the user's full name.
	UpdateUserProfile(
		body *models.UpdateUserProfileV1Request) (
		*models.EditProfileResponse, *apiutils.APIError)

	//  Returns a representation of the specified Clumio user.
	ReadUser(
		userId int64) (
		*models.ReadUserResponse, *apiutils.APIError)

	//  Deletes an existing user from Clumio, revoking the user's access to Clumio. A deleted user cannot be recovered.
	DeleteUser(
		userId int64) (
		interface{}, *apiutils.APIError)

	//  Manages an existing user. Managing a user includes enabling or disabling the user,
	//  changing the user's full name or updating the user's role.
	UpdateUser(
		userId int64,
		body *models.UpdateUserV1Request) (
		*models.UpdateUserResponse, *apiutils.APIError)

	//  Change the password of the specified user. Users can change their own passwords.
	ChangePassword(
		userId int64,
		body *models.ChangePasswordV1Request) (
		interface{}, *apiutils.APIError)
}

UsersV1Client represents a custom type interface

func NewUsersV1

func NewUsersV1(config config.Config) UsersV1Client

NewUsersV1 returns UsersV1Client