adminapi

package
v0.0.0-...-e9724b5 Latest Latest
Warning

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

 Go to latest Published: Jan 28, 2018 License: BSD-3-Clause Imports: 7 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func AccountInfoMaxTime 

func AccountInfoMaxTime(maxtime int) func(*url.Values)

func AccountInfoMinTime 

func AccountInfoMinTime(mintime int) func(*url.Values)

func AdminName 

func AdminName(name string) func(*url.Values)

func AdminPhone 

func AdminPhone(phone string) func(*url.Values)

func AdminRole 

func AdminRole(role string) func(*url.Values)

func Btoa 

func Btoa(b bool) string

func GroupDesc 

func GroupDesc(desc string) func(*url.Values)

func GroupMobileOTPEnabled 

func GroupMobileOTPEnabled(mobile_otp_enabled bool) func(*url.Values)

func GroupName 

func GroupName(name string) func(*url.Values)

func GroupPushEnabled 

func GroupPushEnabled(push_enabled bool) func(*url.Values)

func GroupSMSEnabled 

func GroupSMSEnabled(sms_enabled bool) func(*url.Values)

func GroupStatus 

func GroupStatus(status string) func(*url.Values)

func GroupVoiceEnabled 

func GroupVoiceEnabled(voice_enabled bool) func(*url.Values)

func IntegrationAdminApiAdmins 

func IntegrationAdminApiAdmins(adminapi_admins bool) func(*url.Values)

func IntegrationAdminApiInfo 

func IntegrationAdminApiInfo(adminapi_info bool) func(*url.Values)

func IntegrationAdminApiIntegrations 

func IntegrationAdminApiIntegrations(adminapi_integrations bool) func(*url.Values)

func IntegrationAdminApiReadLog 

func IntegrationAdminApiReadLog(adminapi_read_log bool) func(*url.Values)

func IntegrationAdminApiReadResource 

func IntegrationAdminApiReadResource(adminapi_read_resource bool) func(*url.Values)

func IntegrationAdminApiSettings 

func IntegrationAdminApiSettings(adminapi_settings bool) func(*url.Values)

func IntegrationAdminApiWriteResource 

func IntegrationAdminApiWriteResource(adminapi_write_resource bool) func(*url.Values)

func IntegrationEnrollPolicy 

func IntegrationEnrollPolicy(enroll_policy string) func(*url.Values)

func IntegrationGreeting 

func IntegrationGreeting(greeting string) func(*url.Values)

func IntegrationGroupsAllowed 

func IntegrationGroupsAllowed(groups_allowed []string) func(*url.Values)

func IntegrationIPWhitelist 

func IntegrationIPWhitelist(ip_whitelist string) func(*url.Values)

func IntegrationIPWhitelistEnrollPolicy 

func IntegrationIPWhitelistEnrollPolicy(ip_whitelist_enroll_policy string) func(*url.Values)

func IntegrationNotes 

func IntegrationNotes(notes string) func(*url.Values)

func IntegrationResetSecretKey 

func IntegrationResetSecretKey(IntegrationResetSecretKey bool) func(*url.Values)

func IntegrationSelfServiceAllowed 

func IntegrationSelfServiceAllowed(self_service_allowed bool) func(*url.Values)

func IntegrationTrustedDeviceDays 

func IntegrationTrustedDeviceDays(trusted_device_days int) func(*url.Values)

func IntegrationUsernameNormalizationPolicy 

func IntegrationUsernameNormalizationPolicy(username_normalization_policy string) func(*url.Values)

func LogsMinTime 

func LogsMinTime(mintime int64) func(*url.Values)

func SetActivationMsg 

func SetActivationMsg(activation_msg string) func(*url.Values)

func SetAlias1 

func SetAlias1(alias1 string) func(*url.Values)

func SetAlias2 

func SetAlias2(alias2 string) func(*url.Values)

func SetAlias3 

func SetAlias3(alias3 string) func(*url.Values)

func SetAlias4 

func SetAlias4(alias4 string) func(*url.Values)

func SetBypassCodes 

func SetBypassCodes(codes string) func(*url.Values)

func SetBypassCount 

func SetBypassCount(count string) func(*url.Values)

func SetBypassReuseCount 

func SetBypassReuseCount(reuse_count string) func(*url.Values)

func SetEmail 

func SetEmail(email string) func(*url.Values)

func SetExtension 

func SetExtension(extension string) func(*url.Values)

func SetFirstname 

func SetFirstname(firstname string) func(*url.Values)

func SetInstall 

func SetInstall(install string) func(*url.Values)

func SetInstallationMsg 

func SetInstallationMsg(installation_msg string) func(*url.Values)

func SetLastName 

func SetLastName(lastname string) func(*url.Values)

func SetName 

func SetName(name string) func(*url.Values)

func SetNotes 

func SetNotes(notes string) func(*url.Values)

func SetNumber 

func SetNumber(number string) func(*url.Values)

func SetPlatform 

func SetPlatform(platform string) func(*url.Values)

func SetPostdelay 

func SetPostdelay(postdelay string) func(*url.Values)

func SetPredelay 

func SetPredelay(predelay string) func(*url.Values)

func SetRealname 

func SetRealname(realname string) func(*url.Values)

func SetStatus 

func SetStatus(status string) func(*url.Values)

func SetType 

func SetType(typestring string) func(*url.Values)

func SetUsername 

func SetUsername(username string) func(*url.Values)

Optional parameter for the Retreiveusers method.

func SetValidSeconds 

func SetValidSeconds(valid_seconds string) func(*url.Values)

func SettingsCallerID 

func SettingsCallerID(client_id string) func(*url.Values)

func SettingsFraudEmail 

func SettingsFraudEmail(fraud_email string) func(*url.Values)

func SettingsFraudEnabled 

func SettingsFraudEnabled(fraud_enabled bool) func(*url.Values)

func SettingsInactiveUserExpiration 

func SettingsInactiveUserExpiration(inactive_user_expiration int) func(*url.Values)

func SettingsKeypressConfirm 

func SettingsKeypressConfirm(keypress_confirm string) func(*url.Values)

func SettingsKeypressFraud 

func SettingsKeypressFraud(keypress_fraud string) func(*url.Values)

func SettingsLanguage 

func SettingsLanguage(language string) func(*url.Values)

func SettingsLockoutExpireDuration 

func SettingsLockoutExpireDuration(lockout_expire_duration string) func(*url.Values)

func SettingsLockoutThreshold 

func SettingsLockoutThreshold(lockout_threshold int) func(*url.Values)

func SettingsLogRetentionDays 

func SettingsLogRetentionDays(log_retention_days int) func(*url.Values)

func SettingsMinimumPasswordLength 

func SettingsMinimumPasswordLength(minimum_password_length int) func(*url.Values)

func SettingsMobileOTPEnabled 

func SettingsMobileOTPEnabled(mobile_otp_enabled bool) func(*url.Values)

func SettingsName 

func SettingsName(name string) func(*url.Values)

func SettingsPasswordRequiredLowerAlpha 

func SettingsPasswordRequiredLowerAlpha(password_requires_lower_alpha bool) func(*url.Values)

func SettingsPasswordRequiredNumeric 

func SettingsPasswordRequiredNumeric(password_requires_numeric bool) func(*url.Values)

func SettingsPasswordRequiresSpecial 

func SettingsPasswordRequiresSpecial(password_requires_special bool) func(*url.Values)

func SettingsPasswordRequiresUpperAlpha 

func SettingsPasswordRequiresUpperAlpha(password_requires_upper_alpha bool) func(*url.Values)

func SettingsPushEnabled 

func SettingsPushEnabled(push_enabled bool) func(*url.Values)

func SettingsSMSBatch 

func SettingsSMSBatch(sms_batch int) func(*url.Values)

func SettingsSMSEnabled 

func SettingsSMSEnabled(sms_enabled bool) func(*url.Values)

func SettingsSMSExpiration 

func SettingsSMSExpiration(sms_expiration int) func(*url.Values)

func SettingsSMSMessage 

func SettingsSMSMessage(sms_message string) func(*url.Values)

func SettingsSMSRefresh 

func SettingsSMSRefresh(sms_refresh int) func(*url.Values)

func SettingsTelephonyWarningMin 

func SettingsTelephonyWarningMin(telephony_warning_min int) func(*url.Values)

func SettingsTimezone 

func SettingsTimezone(timezone string) func(*url.Values)

func SettingsUserTelephonyCostMax 

func SettingsUserTelephonyCostMax(user_telephony_cost_max float32) func(*url.Values)

func SettingsVoiceEnabled 

func SettingsVoiceEnabled(voice_enabled bool) func(*url.Values)

func TokenAesKey 

func TokenAesKey(aes_key string) func(*url.Values)

func TokenCounter 

func TokenCounter(counter int64) func(*url.Values)

func TokenPrivateId 

func TokenPrivateId(private_id string) func(*url.Values)

func TokenSecret 

func TokenSecret(secret string) func(*url.Values)

func TokenSerial 

func TokenSerial(tokenserial string) func(*url.Values)

func TokenType 

func TokenType(tokentype string) func(*url.Values)

Types

type AccessDevice 

type AccessDevice struct {
	Browser                 string `json:"browser,omitempty"`
	Browser_Version         string `json:"browser_version,omitempty"`
	Flash_Version           string `json:"flash_version,omitempty"`
	Java_Version            string `json:"java_version,omitempty"`
	OS                      string `json:"os,omitempty"`
	OS_Version              string `json:"os_version,omitempty"`
	Trusted_Endpoint_Status string `json:"trusted_endpoint_status,omitempty"`
}

type ActivationCodeResponse 

type ActivationCodeResponse struct {
	Activation_URL     string
	Activation_Barcode string
	Installation_URL   string
	Valid_Secs         int64
}

type ActivationCodeResult 

type ActivationCodeResult struct {
	Stat     string
	Response ActivationCodeResponse
}

type ActivationCodeSMSResult 

type ActivationCodeSMSResult struct {
	Stat     string
	Response struct {
		Activation_Barcode string
		Activation_Msg     string
		Installation_Msg   string
		Valid_Secs         int64
	}
}

type ActivationLinkResult 

type ActivationLinkResult struct {
	Stat     string
	Response AdminActivationLink
}

type Admin 

type Admin struct {
	Name       string
	Admin_ID   string
	Email      string
	Phone      string
	Last_Login int64
	Role       string
}
type AdminActivationLink struct {
	Code       string
	Email      string
	Email_Sent int
	Link       string
	Message    string
	Valid_Days int
}

type AdminApi 

type AdminApi struct {
	duoapi.DuoApi
}

func NewAdminApi 

func NewAdminApi(api duoapi.DuoApi) *AdminApi

Build a new Duo Admin API object. api is a duoapi.DuoApi object used to make the Duo Rest API calls. Example: adminapi.NewAdminApi(*duoapi.NewDuoApi(ikey,skey,host,userAgent,duoapi.SetTimeout(10*time.second)))

func (*AdminApi) AdministratorLogs 

func (api *AdminApi) AdministratorLogs(options ...func(*url.Values)) (*AdministratorLogResult, error)

Administrator Logs Required parameters: none Optional parameters: LogsMinTime

func (*AdminApi) AssociateGroupwithUser 

func (api *AdminApi) AssociateGroupwithUser(user_id string, options ...func(*url.Values)) (*StatResult, error)

Assoicate Group with User

func (*AdminApi) AssoicateHardwareTokenwithUser 

func (api *AdminApi) AssoicateHardwareTokenwithUser(user_id string) (*StatResult, error)

Associate Hardware Token with User

func (*AdminApi) AuthenticationAttemptsReport 

func (api *AdminApi) AuthenticationAttemptsReport(options ...func(*url.Values)) (*AuthenticationAttemptsResult, error)

Authentication Attempts Report Required parameters: none Optional parameters: AccountInfoMaxTime, AccountInfoMinTime

func (*AdminApi) AuthenticationLogs 

func (api *AdminApi) AuthenticationLogs(options ...func(*url.Values)) (*AuthenticationLogsResult, error)

Authentication Logs Required parameters: none Optional parameters: LogsMinTime

func (*AdminApi) CreateActivationCode 

func (api *AdminApi) CreateActivationCode(phone_id string, options ...func(*url.Values)) (*ActivationCodeResult, error)

Create Activiation Code Required parameters - phone_id Optional parameters - SetValidSeconds, SetInstall

func (*AdminApi) CreateAdministrator 

func (api *AdminApi) CreateAdministrator(email, password, name, phone string, options ...func(*url.Values)) (*AdminResult, error)

Create Administrator Required parameters: email, password, name, phone Optional parameters: Role 

func (api *AdminApi) CreateAdministratorActivationLink(email string, options ...func(*url.Values)) (*ActivationLinkResult, error)

Create Administrator Activation Link Required parameters: email Optional parameters: AdminSendEmail, AdminValidDays

func (*AdminApi) CreateGroup 

func (api *AdminApi) CreateGroup(name string, options ...func(*url.Values)) (*GroupResult, error)

CreateGroup Required parameters - name Optional parameters - GroupDesc, GroupPushEnabled, GroupSMSEnabled, GroupVoiceEnabled, GroupMobileOTPEnabled, GroupStatus

func (*AdminApi) CreateHardwareToken 

func (api *AdminApi) CreateHardwareToken(tokentype, tokenserial string, options ...func(*url.Values)) (*TokenResult, error)

Create Hardware Token Required parameters - TokenType, TokenSerial Option parameters - TokenSecret, TokenCounter, TokenPrivateId, TokenAesKey

func (*AdminApi) CreateIntegration 

func (api *AdminApi) CreateIntegration(IntegrationName, IntegrationType string, options ...func(*url.Values)) (*IntegrationsResult, error)

Create Integration Required parameters - IntegrationName, IntegrationType Optional parameters - IntegrationEnrollPolicy, IntegrationGreeting, IntegrationGroupsAllowed, IntegrationNotes, IntegrationAdminapiAdmins, IntegrationAdminApiInfo, IntegrationAdminApiIntegrations, IntegrationAdminApiReadLog, IntegrationAdminApiReadResource, IntegrationAdminApiSettings, IntegrationAdminApiWriteResource, IntegrationTrustedDeviceDays, IntegrationIPWhitelist, IntegrationIPWhitelistEnrollPolicy, IntegrationUsernameNormalizationPolicy, IntegrationSelfServiceAllowed

func (*AdminApi) CreatePhone 

func (api *AdminApi) CreatePhone(options ...func(*url.Values)) (*PhoneIDResult, error)

Create Phone Optional parameters SetNumber, SetName, SetExtension, SetType, SetPlatform, SetPredelay and SetPostdelay

func (*AdminApi) CreateUser 

func (api *AdminApi) CreateUser(username string, options ...func(*url.Values)) (*UserResult, error)

Users - Create Users

func (*AdminApi) DeleteAdministrator 

func (api *AdminApi) DeleteAdministrator(administrator_id string) (*StatResult, error)

Delete administrator Required parameters: administrator_id Optional parameters: none 

func (api *AdminApi) DeleteDuoMobileLogo() (*StatResult, error)

Delete Duo Mobile Logo Required parameters: none Optional parameters: none

func (*AdminApi) DeleteGroup 

func (api *AdminApi) DeleteGroup(group_id string) (*StatResult, error)

DeleteGroup Required parameters - group_id Optional parameters - none

func (*AdminApi) DeleteHardwareToken 

func (api *AdminApi) DeleteHardwareToken(token_id string) (*StatResult, error)

Delete Hardware Token Required parameters - token_id Optional parameters - none

func (*AdminApi) DeleteIntegration 

func (api *AdminApi) DeleteIntegration(integration_key string) (*StatResult, error)

Delete Integration Required parameters - integration_key Optional parameters - none

func (*AdminApi) DeletePhone 

func (api *AdminApi) DeletePhone(phone_id string) (*StatResult, error)

Delete Phone Required parameters - phone_id Optional parameters - None

func (*AdminApi) DeleteU2FToken 

func (api *AdminApi) DeleteU2FToken(registration_id string) (*U2FTokenResponse, error)

Disassoicate Group from User

func (*AdminApi) DeleteUser 

func (api *AdminApi) DeleteUser(user_id string) (*StatResult, error)

DeleteUser -

func (*AdminApi) DisassociateGroupfromUser 

func (api *AdminApi) DisassociateGroupfromUser(user_id, group_id string) (*StatResult, error)

Disassoicate Group from User

func (*AdminApi) DisassociateHardwareTokenfromUser 

func (api *AdminApi) DisassociateHardwareTokenfromUser(user_id, token_id string) (*StatResult, error)

Disassociate Hardware Token from User

func (*AdminApi) DisassoicatePhonefromUser 

func (api *AdminApi) DisassoicatePhonefromUser(user_id, phone_id string) (*StatResult, error)

Disassociate Phone from User

func (*AdminApi) EnrollUser 

func (api *AdminApi) EnrollUser(username, email string, options ...func(*url.Values)) (*StatResult, error)

Enroll User

func (*AdminApi) GetBypassCodesForUser 

func (api *AdminApi) GetBypassCodesForUser(user_id string, options ...func(*url.Values)) (*BypassCodesResponse, error)

Get Bypass Codes for User

func (*AdminApi) GetGroupInfo 

func (api *AdminApi) GetGroupInfo(group_id string) (*GroupResult, error)

GetGroupInfo Required parameters - group_id Optional parameters - none

func (*AdminApi) ModifyAdministrator 

func (api *AdminApi) ModifyAdministrator(administrator_id string, options ...func(*url.Values)) (*AdminResult, error)

Modify administrator Required parameters: administrator_id Optional parameters: AdminName, AdminPhone, AdminPassword, AdminRole 

func (api *AdminApi) ModifyDuoMobileLogo(logo []byte) (*StatResult, error)

Modify Duo Mobile Logo Required parameters: logo Optional parameters: none

func (*AdminApi) ModifyIntegration 

func (api *AdminApi) ModifyIntegration(integration_key string, options ...func(*url.Values)) (*IntegrationResult, error)

Modify Integration Required parameters - integration_key Optional parameters - IntegrationName, IntegrationEnrollPolicy, IntegrationGreeting, IntegrationGroupsAllowed, IntegrationNotes, IntegrationResetSecretKey, IntegrationAdminapiAdmins, IntegrationAdminApiInfo, IntegrationAdminApiIntegrations, IntegrationAdminApiReadLog, IntegrationAdminApiReadResource, IntegrationAdminApiSettings, IntegrationAdminApiSettings, IntegrationAdminApiWriteResource, IntegrationTrustedDeviceDays, IntegrationIPWhitelist, IntegrationIPWhitelistEnrollPolicy, IntegrationUsernameNormalizationPolicy, IntegrationSelfServiceAllowed

func (*AdminApi) ModifyPhone 

func (api *AdminApi) ModifyPhone(phone_id string, options ...func(*url.Values)) (*PhoneIDResult, error)

Modify Phone Required parameters - phone_id Optional parameters - SetNumber, SetName, SetExtension, SetType, SetPlatform, SetPredelay, SetPostdelay

func (*AdminApi) ModifySettings 

func (api *AdminApi) ModifySettings(options ...func(*url.Values)) (*SettingsResult, error)

ModifySettings Required parameters: none Optional parameters: SettingsCallerID, SettingsFraudEmail, SettingsFraudEnabled, SettingsInactiveUserExpiration, SettingsKeypressConfirm, SettingsKeypressFraud, SettingsLanguage, SettingsLockoutThreshold, SettingsLogRetentionDays, SettingsMinimumPasswordLength, SettingsMobileOTPEnabled, SettingsName, SettingsPasswordRequiredLowerAlpha, SettingsPasswordRequiredNumeric, SettingsPasswordRequiresSpecial, SettingsPasswordRequiresUpperAlpha, SettingsPushEnabled, SettingsSMSBatch, SettingsSMSEnabled, SettingsSMSExpiration, SettingsSMSMessage, SettingsSMSRefresh, SettingsTelephonyWarningMin, SettingsTimezone, SettingsUserTelephonyCostMax, SettingsVoiceEnabled

func (*AdminApi) ModifyUser 

func (api *AdminApi) ModifyUser(user_id string, options ...func(*url.Values)) (*UserResult, error)

ModifyUser -

func (*AdminApi) ResetAdministratorAuthenticationAttemps 

func (api *AdminApi) ResetAdministratorAuthenticationAttemps(administrator_id string) (*StatResult, error)

Reset Administrator Authentication Attempts Required parameters: administrator_id Optional parameters: none

func (*AdminApi) ResyncHardwareToken 

func (api *AdminApi) ResyncHardwareToken(token_id, code1, code2, code3 string) (*StatResult, error)

Resync Hardware Token Required parameters - token_id, code1, code2, code3 Optional parameters - none

func (*AdminApi) RetreiveAdministrators 

func (api *AdminApi) RetreiveAdministrators() (*AdminsResult, error)

Retreive Administrators Required parameters: none Optional parameters: none

func (*AdminApi) RetreiveAdminstatorbyID 

func (api *AdminApi) RetreiveAdminstatorbyID(administrator_id string) (*AdminResult, error)

Retreive Administator by ID Required parameters: administrator_id Optional parameters: none 

func (api *AdminApi) RetreiveDuoMobileLogo() (*MobileLogoResult, error)

Retreive Duo Mobile Logo Required parameters: none Optional parameters: none

func (*AdminApi) RetreiveHardwareTokenbyUserID 

func (api *AdminApi) RetreiveHardwareTokenbyUserID(user_id string) (*TokenResult, error)

Retreive Hardware Token by UserID

func (*AdminApi) RetreivePhonesbyUserID 

func (api *AdminApi) RetreivePhonesbyUserID(user_id string) (*PhoneResult, error)

Retreive Phones by User ID

func (*AdminApi) RetreiveSettings 

func (api *AdminApi) RetreiveSettings() (*SettingsResult, error)

RetreiveSettings Require parameters: none Optional parameters: none

func (*AdminApi) RetreiveU2FTokensbyUserID 

func (api *AdminApi) RetreiveU2FTokensbyUserID(user_id string) (*U2FTokenResponse, error)

Retreive U2F Tokens by User ID

func (*AdminApi) RetrieveEndpoints 

func (api *AdminApi) RetrieveEndpoints() (*EndpointsResult, error)

RetrieveEndpoints Required parameters: None Optional parameters: None

func (*AdminApi) RetrieveEndpointsbyID 

func (api *AdminApi) RetrieveEndpointsbyID(epkey string) (*EndpointsResult, error)

Retrieve Endpoints by ID Required parameters: epkey Optional parameters: None

func (*AdminApi) RetrieveGroups 

func (api *AdminApi) RetrieveGroups() (*GroupsResult, error)

RetrieveGroups Required parameters - None Optional parameters - None

func (*AdminApi) RetrieveGroupsByUserID 

func (api *AdminApi) RetrieveGroupsByUserID(user_id string) (*UserGroupResponse, error)

Retreive Groups by User ID

func (*AdminApi) RetrieveHardwareToken 

func (api *AdminApi) RetrieveHardwareToken(options ...func(*url.Values)) (*TokensResult, error)

Retrieve Hardware Token Required parameters - none Optional parameters - TokenType, TokenSerial

func (*AdminApi) RetrieveHardwareTokenbyID 

func (api *AdminApi) RetrieveHardwareTokenbyID(token_id string) (*TokensResult, error)

Retrieve Hardware Token by ID Required parameters - token_id Option parameters - none

func (*AdminApi) RetrieveIntegrationbyKey 

func (api *AdminApi) RetrieveIntegrationbyKey(integration_key string) (*IntegrationResult, error)

Retrieve Integration by key Required parameters - integration_key Optional parameters - none

func (*AdminApi) RetrieveIntegrations 

func (api *AdminApi) RetrieveIntegrations() (*IntegrationsResult, error)

Retrieve Integrations Required parameters - none Optional parameters - none

func (*AdminApi) RetrievePhoneByID 

func (api *AdminApi) RetrievePhoneByID(phone_id string) (*PhoneIDResult, error)

Retrieve Phone by ID Required parameters - phone_id Optional parameters - None

func (*AdminApi) RetrievePhones 

func (api *AdminApi) RetrievePhones() (*PhoneUserResult, error)

Retrieve Phones Optional parameters SetNumber and SetExtension

func (*AdminApi) RetrieveSummary 

func (api *AdminApi) RetrieveSummary() (*SummaryResult, error)

RetrieveSummary Required parameters: none Optional parameters: none

func (*AdminApi) RetrieveU2FTokenByID 

func (api *AdminApi) RetrieveU2FTokenByID(registration_id string) (*U2FTokenResponse, error)

func (*AdminApi) RetrieveU2FTokens 

func (api *AdminApi) RetrieveU2FTokens() (*U2FTokenResponse, error)

func (*AdminApi) RetrieveUserByID 

func (api *AdminApi) RetrieveUserByID(userid string) (*UserResult, error)

Users - Retrive User by ID

func (*AdminApi) RetrieveUsers 

func (api *AdminApi) RetrieveUsers(options ...func(*url.Values)) (*UsersResult, error)

Users - Retreive Users

func (*AdminApi) SendActivationCodebySMS 

func (api *AdminApi) SendActivationCodebySMS(phone_id string, options ...func(*url.Values)) (*ActivationCodeSMSResult, error)

Send Activiation Code by SMS Required parameters - phone_id Optional parameters - SetValidSeconds, SetInstall, SetInstallationMsg, SetActivationMsg

func (*AdminApi) SendInstallionalURLviaSMS 

func (api *AdminApi) SendInstallionalURLviaSMS(phone_id string, options ...func(*url.Values)) (*InstallationURLviaSMSResult, error)

Send Installational URL vis SMS Required parameters - phone_id Optional parameters - SetInstallationMsg

func (*AdminApi) SendPasscodesviaSMS 

func (api *AdminApi) SendPasscodesviaSMS(phone_id string) (*StatResult, error)

Send Passcodes via SMS Required parameters - phone_id Optional Parameters - None

func (*AdminApi) TelephonyCreditsUsedReport 

func (api *AdminApi) TelephonyCreditsUsedReport(options ...func(*url.Values)) (*TelephonyCreditsUsedResult, error)

Telephony Credits Used Report Required parameters: none Optional parameters: AccountInfoMaxTime, AccountInfoMinTime

func (*AdminApi) TelephonyLogs 

func (api *AdminApi) TelephonyLogs(options ...func(*url.Values)) (*TelephonyLogResult, error)

Telephony Logs Required parameters: none Optional parameters: LogsMinTime

func (*AdminApi) UpdateGroup 

func (api *AdminApi) UpdateGroup(group_id string, options ...func(*url.Values)) (*GroupResult, error)

UpdateGroup Required parameters - group_id Optional parameters - GroupName, GroupDesc, GroupPushEnabled, GroupSMSEnabled, GroupVoiceEnabled, GroupMobileOTPEnabled, GroupStatus

func (*AdminApi) UserWithAuthenticationAttemptsReport 

func (api *AdminApi) UserWithAuthenticationAttemptsReport(options ...func(*url.Values)) (*UsersAuthenticationAttemptsResult, error)

Users with Authentication Attempts Report Required parameters: none Optional parameters: AccountInfoMaxTime, AccountInfoMinTime

type AdminResult 

type AdminResult struct {
	Stat     string
	Response Admin
}

type AdministratorLogResult 

type AdministratorLogResult struct {
	Stat     string             `json:"stat,omitempty"`
	Response []AdminsitratorLog `json:"response,omitempty"`
}

type AdminsResult 

type AdminsResult struct {
	Stat     string
	Response []Admin
}

type AdminsitratorLog 

type AdminsitratorLog struct {
	Action      string `json:"action,omitempty"`
	Description string `json:"description,omitempty"`
	Object      string `json:"object,omitempty"`
	Timestamp   int64  `json:"timestamp,omitempty"`
	Username    string `json:"username,omitempty"`
}

type AuthenticationAttemptsResult 

type AuthenticationAttemptsResult struct {
	StatResult
	Response struct {
		Maxtime                 int
		Mintime                 int
		Authentication_Attempts struct {
			Error   int
			Failure int
			Fraud   int
			Success int
		}
	}
}

Return object for the "Authentication Attempts Report" call

type AuthenticationLog 

type AuthenticationLog struct {
	Access_Device  AccessDevice `json:"access_device,omitempty"`
	Device         string       `json:"device,omitempty"`
	Factor         string       `json:"factor,omitempty"`
	Integration    string       `json:"integration,omitempty"`
	IP             string       `json:"ip,omitempty"`
	Location       Location     `json:"location,omitempty"`
	New_Enrollment bool         `json:"new_enrollment,omitempty"`
	Reason         string       `json:"reason,omitempty"`
	Result         string       `json:"result,omitempty"`
	Timestamp      int64        `json:"timestamp,omitempty"`
	Username       string       `json:"username,omitempty"`
}

type AuthenticationLogsResult 

type AuthenticationLogsResult struct {
	Stat     string              `json:"stat,omitempty"`
	Response []AuthenticationLog `json:"response,omitempty"`
}

type Browser 

type Browser struct {
	Browser_Family  string
	Browser_Version string
	Flash_Version   string
	Java_Version    string
	Last_Used       int64
}

type BypassCodesResponse 

type BypassCodesResponse struct {
	Stat     string
	Response []string
}

type Endpoint 

type Endpoint struct {
	Browsers   []Browser
	Email      string
	Epkey      string
	Model      string
	OS_Family  string
	OS_Version string
	Type       string
	Username   string
}

type EndpointsResult 

type EndpointsResult struct {
	Stat     string
	Response []Endpoint
}

type GroupResponse 

type GroupResponse struct {
	Desc               string `json:"desc,omitemtpy"`
	Push_Enabled       bool   `json:"push_enabled,omitempty"`
	SMS_Enabled        bool   `json:"sms_enabled,omitempty"`
	Voice_Enabled      bool   `json:"voice_enabled,omitempty"`
	Mobile_OTP_Enabled bool   `json:"mobile_otp_enabled,omitempty"`
	Group_ID           string `json:"group_id,omitemtpy"`
	Name               string `json:"name,omitempty"`
	Status             string `json:"status,omitempty"`
}

type GroupResult 

type GroupResult struct {
	Stat     string        `json:"stat,omitempty"`
	Response GroupResponse `json:"response,omitempty"`
}

type Groups 

type Groups struct {
	Desc string `json:"desc,omitempty"`
	Name string `json:"name,omitempyt"`
}

type GroupsResult 

type GroupsResult struct {
	Stat     string          `json:"stat,omitempty"`
	Response []GroupResponse `json:"response,omitempty"`
}

type InstallationURLviaSMSResult 

type InstallationURLviaSMSResult struct {
	Stat     string
	Response struct {
		Installation_Msg string
	}
}

type Integration 

type Integration struct {
	Enroll_Policy                 string          `json:"enroll_policy,omitempty"`
	Greeting                      string          `json:"greeting,omitempty"`
	Groups_Allowed                []GroupResponse `json:"groups_allowed,omitempty"`
	Integration_Key               string          `json:"integration_key,omitempty"`
	IP_Whitelist                  []string        `json:"ip_whitelist,omitempty"`
	IP_Whitelist_Enroll_Policy    string          `json:"ip_whitelist_enroll_policy,omitempty"`
	Name                          string          `json:"name,omitempty"`
	Notes                         string          `json:"notes,omitempty"`
	Secret_Key                    string          `json:"secret_key,omitempty"`
	Type                          string          `json:"type,omitempty"`
	Trusted_Device_Days           int64           `json:"trusted_device_days,omitempty"`
	Username_Normalization_Policy string          `json:"username_normalization_policy,omitempty"`
	AdminAPI_Admins               int64           `json:"adminapi_admins,omitempty"`
	AdminAPI_Info                 int64           `json:"adminapi_info,omitempty"`
	AdminAPI_Integrations         int64           `json:"adminapi_integrations,omitempty"`
	AdminAPI_Read_Log             int64           `json:"adminapi_read_log,omitempty"`
	AdminAPI_Read_Resource        int64           `json:"adminapi_read_resource,omitempty"`
	AdminAPI_Settings             int64           `json:"adminapi_settings,omitempty"`
	AdminAPI_Write_Resoure        int64           `json:"adminapi_write_resource,omitempty"`
	Policy_Key                    string          `json:"policy_key,omitempty"`
}

type IntegrationResult 

type IntegrationResult struct {
	Stat     string
	Response Integration
}

type IntegrationsResult 

type IntegrationsResult struct {
	Stat     string
	Response []Integration
}

type Location 

type Location struct {
	City    string `json:"city,omitempty"`
	State   string `json:"state,omitempty"`
	Country string `json:"country,omitempty"`
}

type MobileLogoResult 

type MobileLogoResult struct {
	StatResult
	// contains filtered or unexported fields
}

type Phone 

type Phone struct {
	Phone_ID           string   `json:"phone_id,omitempty"`
	Number             string   `json:"number,omitempty"`
	Extention          string   `json:"extenstion,omitempty"`
	Name               string   `json:"name,omitempty"`
	Postdelay          string   `json:"postdelay,omitempty"`
	Predelay           string   `json:"predelay,omitempty"`
	Type               string   `json:"type,omitempty"`
	Capabilities       []string `json:"capabilities,omitempty"`
	Platform           string   `json:"platform,omitempty"`
	Activated          bool     `json:"activated,omitempty"`
	SMS_Passcodes_Sent bool     `json:"sms_passcodes_sent,omitempty"`
}

type PhoneIDResult 

type PhoneIDResult struct {
	Stat     string
	Response PhoneResponse
}

type PhoneResponse 

type PhoneResponse struct {
	Activated          bool
	Capabilities       []string
	Encrypted          string
	Extension          string
	Fringerprint       string
	Name               string
	Number             string
	Phone_Id           string
	Platform           string
	Postdelay          string
	Predelay           string
	Screenlock         string
	SMS_Passcodes_Sent bool
	Type               string
	Users              []PhoneUser
}

type PhoneResult 

type PhoneResult struct {
	Stat     string  `json:"stat,omitempty"`
	Response []Phone `json:"response,omitempty"`
}

type PhoneUser 

type PhoneUser struct {
	Email      string
	Last_Login int64
	Notes      string
	Realname   string
	Status     string
	User_ID    string
	Username   string
}

type PhoneUserResult 

type PhoneUserResult struct {
	Stat     string
	Response []PhoneResponse
}

type Settings 

type Settings struct {
	Caller_ID                     string
	Fraud_Email                   string
	Fraud_Email_Enabled           bool
	Helpdesk_Bypass               string
	HelpDesk_Bypass_Expiration    int64
	Inactive_User_Expiration      int
	Keypress_Confirm              string
	Keypress_Fraud                string
	Langauge                      string
	Lockout_Expire_Duration       int
	Lockout_Threshold             int
	Log_Retention_Days            int
	Minimum_Password_Length       int
	Mobile_OTP_Enabled            bool
	Name                          string
	Password_Required_Lower_Alpha bool
	Password_Required_Numeric     bool
	Password_Required_Special     bool
	Password_Requires_Upper_Alpha bool
	Push_Enabled                  bool
	Req_Fips_Passcodes_Android    bool
	Security_Checkup_Enabled      int64
	SMS_Batch                     int
	SMS_Enabled                   bool
	SMS_Expiration                int
	SMS_Messages                  string
	SMS_Refresh                   int
	Telephony_Warning_Min         int
	Timezone                      string
	User_Telephony_Cost_Max       float32
	Voice_Enabled                 bool
}

type SettingsResult 

type SettingsResult struct {
	Stat     string
	Response Settings
}

type StatResult 

type StatResult struct {
	Stat           string
	Code           *int32
	Message        *string
	Message_Detail *string
}

type SummaryResult 

type SummaryResult struct {
	StatResult
	Response struct {
		Admin_Count                 int
		Integration_Count           int
		Telephony_Credits_Remaining int
		User_count                  int
	}
}

Return object for the "Retrieve Summary" call

type TelephonyCreditsUsedResult 

type TelephonyCreditsUsedResult struct {
	StatResult
	Response struct {
		Maxtime                int
		Mintime                int
		Telephony_Credits_Used int
	}
}

Return object for the "Telephony Credits Used Report" call

type TelephonyLog 

type TelephonyLog struct {
	Timestamp int64  `json:"timestamp,omitempty"`
	Context   string `json:"context,omitempty"`
	Type      string `json:"type,omitempty"`
	Phone     string `json:"phone,omitempty"`
	Credits   int64  `json:"credits,omitempty"`
}

type TelephonyLogResult 

type TelephonyLogResult struct {
	Stat     string         `json:"stat,omitempty"`
	Response []TelephonyLog `json:"response,omitempty"`
}

type Token 

type Token struct {
	Serial   string `json:"serial,omitempty"`
	Token_ID string `json:"token_id,omitempty"`
	Type     string `json:"type,omitempty"`
}

type TokenResponse 

type TokenResponse struct {
	Serial    string
	Token_ID  string
	Type      string
	Totp_Step string
	Users     []User
}

type TokenResult 

type TokenResult struct {
	Stat     string  `json:"stat,omitempty"`
	Response []Token `json:"response,omitempty"`
}

type TokensResult 

type TokensResult struct {
	Stat     string
	Response []TokenResponse
}

type U2FToken 

type U2FToken struct {
	Date_Added      int64  `json:"date_added,omitempty"`
	Registration_ID string `json:"registration_id,omitempty`
	User            User   `json:"user,omitempty`
}

type U2FTokenResponse 

type U2FTokenResponse struct {
	Stat     string     `json:"stat,omitempty`
	Response []U2FToken `json:"response,omitempty"`
}

type User 

type User struct {
	User_id    string
	Username   string
	Realname   string
	Email      string
	Status     string
	Last_Login int64
	Notes      string
}

type UserGroupResponse 

type UserGroupResponse struct {
	Stat     string       `json:"stat,omitempty"`
	Response []UserGroups `json:"response,omitempty"`
}

type UserGroups 

type UserGroups struct {
	Desc     string `json:"desc,omitempty"`
	Group_ID string `json:"group_id,omitempty"`
	Name     string `json:"name,omitempty"`
}

type UserResponse 

type UserResponse struct {
	User_ID             string   `json:"user_id,omitempty"`
	Username            string   `json:"username,omitempty"`
	Alias1              string   `json:"alias1,omitempty"`
	Alias2              string   `json:"alias2,omitempty"`
	Alias3              string   `json:"alias3,omitempty"`
	Alias4              string   `json:"alias4,omitempty"`
	Created             int64    `json:"created,omitempty"`
	Firstname           string   `json:"firstname,omitempty"`
	Realname            string   `json:"realname,omitempty"`
	Email               string   `json:"email,omitempty"`
	Status              string   `json:"status,omitempty"`
	Groups              []Groups `json:"groups,omitempty"`
	Last_Directory_Sync int64    `json:"last_directory_sync,omitempty"`
	Last_Login          int64    `json:"last_login,omitempty"`
	Lastname            string   `json:"lastname,omitempty"`
	Notes               string   `json:"notes,omitempty"`
	Phones              []Phone  `json:"phones,omitempty"`
	Tokens              []Token  `json:"tokens,omitempty"`
}

type UserResult 

type UserResult struct {
	Stat     string       `json:"stat,omitempty"`
	Response UserResponse `json:"response,omitempty"`
}

type UsersAuthenticationAttemptsResult 

type UsersAuthenticationAttemptsResult struct {
	StatResult
	Response struct {
		Mintime                    int
		Maxtime                    int
		UserAuthenticationAttempts struct {
			Error   int
			Failure int
			Fraud   int
			Success int
		}
	}
}

Retun object for the "Users with Authentication Attempts Report" call

type UsersResult 

type UsersResult struct {
	Stat     string         `json:"stat,omitempty"`
	Response []UserResponse `json:"response,omitempty"`
}

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.