users

Documentation

Index

• func BulkDelete(ctx context.Context, service *zscaler.Service, ids []int) (*http.Response, error)
• func Delete(ctx context.Context, service *zscaler.Service, userID int) (*http.Response, error)
• type EnrollResult
  • func EnrollUser(ctx context.Context, service *zscaler.Service, userID int, ...) (*EnrollResult, error)
• type EnrollUserRequest
• type Users
  • func Create(ctx context.Context, service *zscaler.Service, user *Users) (*Users, error)
  • func Get(ctx context.Context, service *zscaler.Service, userID int) (*Users, error)
  • func GetAllUsers(ctx context.Context, service *zscaler.Service) ([]Users, error)
  • func GetUserByName(ctx context.Context, service *zscaler.Service, userName string) (*Users, error)
  • func Update(ctx context.Context, service *zscaler.Service, userID int, users *Users) (*Users, *http.Response, error)

Functions

func BulkDelete

func BulkDelete(ctx context.Context, service *zscaler.Service, ids []int) (*http.Response, error)

func Delete

func Delete(ctx context.Context, service *zscaler.Service, userID int) (*http.Response, error)

Types

type EnrollResult

type EnrollResult struct {
	UserID int `json:"userId"`
}

func EnrollUser

func EnrollUser(ctx context.Context, service *zscaler.Service, userID int, request EnrollUserRequest) (*EnrollResult, error)

type EnrollUserRequest

type EnrollUserRequest struct {
	AuthMethods []string `json:"authMethods"`
	Password    string   `json:"password"`
}

type Users

type Users struct {
	// User ID
	ID int `json:"id"`

	// User name. This appears when choosing users for policies.
	Name string `json:"name,omitempty"`

	// User email consists of a user name and domain name. It does not have to be a valid email address, but it must be unique and its domain must belong to the organization.
	Email string `json:"email,omitempty"`

	// List of Groups a user belongs to. Groups are used in policies.
	Groups []common.IDNameExtensions `json:"groups,omitempty"`

	// Department a user belongs to
	Department *common.UserDepartment `json:"department,omitempty"`

	// Additional information about this user.
	Comments string `json:"comments,omitempty"`

	// Temporary Authentication Email. If you enabled one-time tokens or links, enter the email address to which the Zscaler service sends the tokens or links. If this is empty, the service sends the email to the User email.
	TempAuthEmail string `json:"tempAuthEmail,omitempty"`

	// Accepted Authentication Methods. Support values are "BASIC" and "DIGEST"
	AuthMethods []string `json:"authMethods,omitempty"`

	// User's password. Applicable only when authentication type is Hosted DB. Password strength must follow what is defined in the auth settings.
	Password string `json:"password,omitempty"`

	// True if this user is an Admin user
	AdminUser bool `json:"adminUser"`

	// User type. Provided only if this user is not an end user.
	Type string `json:"type,omitempty"`

	Deleted bool `json:"deleted"`
}

func Create

func Create(ctx context.Context, service *zscaler.Service, user *Users) (*Users, error)

func Get

func Get(ctx context.Context, service *zscaler.Service, userID int) (*Users, error)

func GetAllUsers

func GetAllUsers(ctx context.Context, service *zscaler.Service) ([]Users, error)

func GetUserByName

func GetUserByName(ctx context.Context, service *zscaler.Service, userName string) (*Users, error)

func Update

func Update(ctx context.Context, service *zscaler.Service, userID int, users *Users) (*Users, *http.Response, error)