users

package
v0.8.3 Latest Latest
Warning

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

 Go to latest Published: Oct 29, 2020 License: MIT Imports: 10 Imported by: 0

Documentation

Index

Constants

View Source 
const (
	// ENDFIELD is List call attribute string terminator
	ENDFIELD = ")"
	// HASHFUNCTION specifies password hash function
	HASHFUNCTION string = "SHA-1"
	// KEYNAME is name of key for processing
	KEYNAME string = "userKey"
	// STARTUSERSFIELD is List call users attribute string prefix
	STARTUSERSFIELD = "users("
)

Variables

View Source 
var QueryAttrMap = map[string]string{
	"address":           "address",
	"addresspobox":      "addressPoBox",
	"addressextended":   "addressExtended",
	"addressstreet":     "addressStreet",
	"addresslocality":   "addressLocality",
	"addressregion":     "addressRegion",
	"addresspostalcode": "addressPostalCode",
	"addresscountry":    "addressCountry",
	"christianname":     "givenName",
	"directmanager":     "directManager",
	"directmanagerid":   "directManagerId",
	"email":             "email",
	"externalid":        "externalId",
	"familyname":        "familyName",
	"firstname":         "givenName",
	"givenname":         "givenName",
	"im":                "im",
	"isadmin":           "isAdmin",
	"isdelegatedadmin":  "isDelegatedAdmin",
	"isenrolledin2sv":   "isEnrolledIn2Sv",
	"isenforcedin2sv":   "isEnforcedIn2Sv",
	"issuspended":       "isSuspended",
	"lastname":          "familyName",
	"manager":           "manager",
	"managerid":         "managerId",
	"name":              "name",
	"orgcostcenter":     "orgCostCenter",
	"orgdepartment":     "orgDepartment",
	"orgdescription":    "orgDescription",
	"orgname":           "orgName",
	"orgtitle":          "orgTitle",
	"orgunitpath":       "orgUnitPath",
	"phone":             "phone",
	"surname":           "familyName",
}

QueryAttrMap provides lowercase mappings to valid admin.User query attributes

View Source 
var UserAttrMap = map[string]string{}/* 103 elements not displayed */

UserAttrMap provides lowercase mappings to valid admin.User attributes

View Source 
var ValidOrderByStrs = []string{
	"email",
	"familyname",
	"firstname",
	"givenname",
	"lastname",
}

ValidOrderByStrs provide valid strings to be used to set admin.UsersListCall OrderBy

View Source 
var ValidProjections = []string{
	"basic",
	"custom",
	"full",
}

ValidProjections provide valid strings to be used to set admin.UsersListCall Projection

View Source 
var ValidViewTypes = []string{
	"admin_view",
	"domain_public",
}

ValidViewTypes provide valid strings to be used to set admin.UsersListCall ViewType

Functions

func AddCustomFieldMask added in v0.5.0 

func AddCustomFieldMask(callObj interface{}, attrs string) interface{}

AddCustomFieldMask adds CustomFieldMask to be used with get and list admin calls with custom projections

func AddCustomer 

func AddCustomer(ulc *admin.UsersListCall, customerID string) *admin.UsersListCall

AddCustomer adds Customer to admin calls

func AddDomain 

func AddDomain(ulc *admin.UsersListCall, domain string) *admin.UsersListCall

AddDomain adds domain to admin calls

func AddFields 

func AddFields(callObj interface{}, attrs string) interface{}

AddFields adds fields to be returned from admin calls

func AddMaxResults 

func AddMaxResults(ulc *admin.UsersListCall, maxResults int64) *admin.UsersListCall

AddMaxResults adds MaxResults to admin calls

func AddOrderBy 

func AddOrderBy(ulc *admin.UsersListCall, orderBy string) *admin.UsersListCall

AddOrderBy adds OrderBy to admin calls

func AddPageToken 

func AddPageToken(ulc *admin.UsersListCall, token string) *admin.UsersListCall

AddPageToken adds PageToken to admin calls

func AddProjection 

func AddProjection(callObj interface{}, projection string) interface{}

AddProjection adds Projection to admin calls

func AddQuery 

func AddQuery(ulc *admin.UsersListCall, query string) *admin.UsersListCall

AddQuery adds query to admin calls

func AddShowDeleted 

func AddShowDeleted(ulc *admin.UsersListCall) *admin.UsersListCall

AddShowDeleted adds ShowDeleted to admin calls

func AddSortOrder 

func AddSortOrder(ulc *admin.UsersListCall, sortorder string) *admin.UsersListCall

AddSortOrder adds SortOrder to admin calls

func AddViewType 

func AddViewType(callObj interface{}, viewType string) interface{}

AddViewType adds ViewType to admin calls

func DoGet 

func DoGet(ugc *admin.UsersGetCall) (*admin.User, error)

DoGet calls the .Do() function on the admin.UsersGetCall

func DoList 

func DoList(ulc *admin.UsersListCall) (*admin.Users, error)

DoList calls the .Do() function on the admin.UsersListCall

func HashPassword added in v0.8.0 

func HashPassword(password string) (string, error)

HashPassword creates a password hash

func PopulateUndeleteUser added in v0.8.0 

func PopulateUndeleteUser(undelUser *UndeleteUser, hdrMap map[int]string, objData []interface{}) error

PopulateUndeleteUser is used in batch processing

func PopulateUser added in v0.8.0 

func PopulateUser(user *admin.User, hdrMap map[int]string, objData []interface{}) error

PopulateUser is used in batch processing

func PopulateUserForUpdate added in v0.8.0 

func PopulateUserForUpdate(userParams *UserParams, hdrMap map[int]string, objData []interface{}) error

PopulateUserForUpdate is used in batch processing

func ShowAttrValues added in v0.6.0 

func ShowAttrValues(lenArgs int, args []string, filter string) error

ShowAttrValues displays enumerated attribute values

func ShowAttrs added in v0.6.0 

func ShowAttrs(filter string)

ShowAttrs displays requested user attributes

func ShowCompAttrs added in v0.6.0 

func ShowCompAttrs(filter string)

ShowCompAttrs displays user composite attributes

func ShowFlagValues added in v0.6.0 

func ShowFlagValues(lenArgs int, args []string, filter string) error

ShowFlagValues displays enumerated flag values

func ShowSubAttrs added in v0.6.0 

func ShowSubAttrs(compAttr string, filter string) error

ShowSubAttrs displays attributes of composite attributes

Types

type Key added in v0.5.0 

type Key struct {
	UserKey string
}

Key is struct used to extract userKey

type UndeleteUser added in v0.7.0 

type UndeleteUser struct {
	UserKey     string
	OrgUnitPath string
}

UndeleteUser is struct to extract undelete data

type UserParams added in v0.8.0 

type UserParams struct {
	UserKey string
	User    *admin.User
}

UserParams is used in batch processing

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.