administrativeAccounts

Documentation

Index

• Constants
• type AddAccountInput
• type AdministrativeAccountsAPI
• type AdministrativeAccountsService
  • func New(cfg *config.Config) *AdministrativeAccountsService
  • func (s *AdministrativeAccountsService) AddAccount(input *AddAccountInput) (output *models.AdministrativeAccount, resp *http.Response, err error)
  • func (s *AdministrativeAccountsService) AddAccountWithContext(ctx context.Context, input *AddAccountInput) (output *models.AdministrativeAccount, resp *http.Response, err error)
  • func (s *AdministrativeAccountsService) ChangePassword(input *ChangePasswordInput) (output *models.UserCredentials, resp *http.Response, err error)
  • func (s *AdministrativeAccountsService) ChangePasswordWithContext(ctx context.Context, input *ChangePasswordInput) (output *models.UserCredentials, resp *http.Response, err error)
  • func (s *AdministrativeAccountsService) DeleteAccount(input *DeleteAccountInput) (output *models.ApiResult, resp *http.Response, err error)
  • func (s *AdministrativeAccountsService) DeleteAccountWithContext(ctx context.Context, input *DeleteAccountInput) (output *models.ApiResult, resp *http.Response, err error)
  • func (s *AdministrativeAccountsService) GetAccount(input *GetAccountInput) (output *models.AdministrativeAccount, resp *http.Response, err error)
  • func (s *AdministrativeAccountsService) GetAccountWithContext(ctx context.Context, input *GetAccountInput) (output *models.AdministrativeAccount, resp *http.Response, err error)
  • func (s *AdministrativeAccountsService) GetAccounts() (output *models.AdministrativeAccounts, resp *http.Response, err error)
  • func (s *AdministrativeAccountsService) GetAccountsWithContext(ctx context.Context) (output *models.AdministrativeAccounts, resp *http.Response, err error)
  • func (s *AdministrativeAccountsService) ResetPassword(input *ResetPasswordInput) (output *models.UserCredentials, resp *http.Response, err error)
  • func (s *AdministrativeAccountsService) ResetPasswordWithContext(ctx context.Context, input *ResetPasswordInput) (output *models.UserCredentials, resp *http.Response, err error)
  • func (s *AdministrativeAccountsService) UpdateAccount(input *UpdateAccountInput) (output *models.AdministrativeAccount, resp *http.Response, err error)
  • func (s *AdministrativeAccountsService) UpdateAccountWithContext(ctx context.Context, input *UpdateAccountInput) (output *models.AdministrativeAccount, resp *http.Response, err error)
• type ChangePasswordInput
• type DeleteAccountInput
• type GetAccountInput
• type ResetPasswordInput
• type UpdateAccountInput

Constants

const (
	// ServiceName - The name of service.
	ServiceName = "AdministrativeAccounts"
)

Types

type AddAccountInput

type AddAccountInput struct {
	Body models.AdministrativeAccount
}

type AdministrativeAccountsAPI

type AdministrativeAccountsAPI interface {
	GetAccounts() (output *models.AdministrativeAccounts, resp *http.Response, err error)
	GetAccountsWithContext(ctx context.Context) (output *models.AdministrativeAccounts, resp *http.Response, err error)

	AddAccount(input *AddAccountInput) (output *models.AdministrativeAccount, resp *http.Response, err error)
	AddAccountWithContext(ctx context.Context, input *AddAccountInput) (output *models.AdministrativeAccount, resp *http.Response, err error)

	GetAccount(input *GetAccountInput) (output *models.AdministrativeAccount, resp *http.Response, err error)
	GetAccountWithContext(ctx context.Context, input *GetAccountInput) (output *models.AdministrativeAccount, resp *http.Response, err error)

	UpdateAccount(input *UpdateAccountInput) (output *models.AdministrativeAccount, resp *http.Response, err error)
	UpdateAccountWithContext(ctx context.Context, input *UpdateAccountInput) (output *models.AdministrativeAccount, resp *http.Response, err error)

	DeleteAccount(input *DeleteAccountInput) (output *models.ApiResult, resp *http.Response, err error)
	DeleteAccountWithContext(ctx context.Context, input *DeleteAccountInput) (output *models.ApiResult, resp *http.Response, err error)

	ResetPassword(input *ResetPasswordInput) (output *models.UserCredentials, resp *http.Response, err error)
	ResetPasswordWithContext(ctx context.Context, input *ResetPasswordInput) (output *models.UserCredentials, resp *http.Response, err error)

	ChangePassword(input *ChangePasswordInput) (output *models.UserCredentials, resp *http.Response, err error)
	ChangePasswordWithContext(ctx context.Context, input *ChangePasswordInput) (output *models.UserCredentials, resp *http.Response, err error)
}

type AdministrativeAccountsService

type AdministrativeAccountsService struct {
	*client.PfClient
}

func New

func New(cfg *config.Config) *AdministrativeAccountsService

New creates a new instance of the AdministrativeAccountsService client.

func (*AdministrativeAccountsService) AddAccount

func (s *AdministrativeAccountsService) AddAccount(input *AddAccountInput) (output *models.AdministrativeAccount, resp *http.Response, err error)

AddAccount - Add a new PingFederate native Administrative Account. RequestType: POST Input: input *AddAccountInput

func (*AdministrativeAccountsService) AddAccountWithContext

func (s *AdministrativeAccountsService) AddAccountWithContext(ctx context.Context, input *AddAccountInput) (output *models.AdministrativeAccount, resp *http.Response, err error)

AddAccountWithContext - Add a new PingFederate native Administrative Account. RequestType: POST Input: ctx context.Context, input *AddAccountInput

func (*AdministrativeAccountsService) ChangePassword

func (s *AdministrativeAccountsService) ChangePassword(input *ChangePasswordInput) (output *models.UserCredentials, resp *http.Response, err error)

ChangePassword - Change the Password of current PingFederate native Account. RequestType: POST Input: input *ChangePasswordInput

func (*AdministrativeAccountsService) ChangePasswordWithContext

func (s *AdministrativeAccountsService) ChangePasswordWithContext(ctx context.Context, input *ChangePasswordInput) (output *models.UserCredentials, resp *http.Response, err error)

ChangePasswordWithContext - Change the Password of current PingFederate native Account. RequestType: POST Input: ctx context.Context, input *ChangePasswordInput

func (*AdministrativeAccountsService) DeleteAccount

func (s *AdministrativeAccountsService) DeleteAccount(input *DeleteAccountInput) (output *models.ApiResult, resp *http.Response, err error)

DeleteAccount - Delete a PingFederate native Administrative Account information. RequestType: DELETE Input: input *DeleteAccountInput

func (*AdministrativeAccountsService) DeleteAccountWithContext

func (s *AdministrativeAccountsService) DeleteAccountWithContext(ctx context.Context, input *DeleteAccountInput) (output *models.ApiResult, resp *http.Response, err error)

DeleteAccountWithContext - Delete a PingFederate native Administrative Account information. RequestType: DELETE Input: ctx context.Context, input *DeleteAccountInput

func (*AdministrativeAccountsService) GetAccount

func (s *AdministrativeAccountsService) GetAccount(input *GetAccountInput) (output *models.AdministrativeAccount, resp *http.Response, err error)

GetAccount - Get a PingFederate native Administrative Account. RequestType: GET Input: input *GetAccountInput

func (*AdministrativeAccountsService) GetAccountWithContext

func (s *AdministrativeAccountsService) GetAccountWithContext(ctx context.Context, input *GetAccountInput) (output *models.AdministrativeAccount, resp *http.Response, err error)

GetAccountWithContext - Get a PingFederate native Administrative Account. RequestType: GET Input: ctx context.Context, input *GetAccountInput

func (*AdministrativeAccountsService) GetAccounts

func (s *AdministrativeAccountsService) GetAccounts() (output *models.AdministrativeAccounts, resp *http.Response, err error)

GetAccounts - Get all the PingFederate native Administrative Accounts. RequestType: GET Input:

func (*AdministrativeAccountsService) GetAccountsWithContext

func (s *AdministrativeAccountsService) GetAccountsWithContext(ctx context.Context) (output *models.AdministrativeAccounts, resp *http.Response, err error)

GetAccountsWithContext - Get all the PingFederate native Administrative Accounts. RequestType: GET Input: ctx context.Context,

func (*AdministrativeAccountsService) ResetPassword

func (s *AdministrativeAccountsService) ResetPassword(input *ResetPasswordInput) (output *models.UserCredentials, resp *http.Response, err error)

ResetPassword - Reset the Password of an existing PingFederate native Administrative Account. RequestType: POST Input: input *ResetPasswordInput

func (*AdministrativeAccountsService) ResetPasswordWithContext

func (s *AdministrativeAccountsService) ResetPasswordWithContext(ctx context.Context, input *ResetPasswordInput) (output *models.UserCredentials, resp *http.Response, err error)

ResetPasswordWithContext - Reset the Password of an existing PingFederate native Administrative Account. RequestType: POST Input: ctx context.Context, input *ResetPasswordInput

func (*AdministrativeAccountsService) UpdateAccount

func (s *AdministrativeAccountsService) UpdateAccount(input *UpdateAccountInput) (output *models.AdministrativeAccount, resp *http.Response, err error)

UpdateAccount - Update the information for a native Administrative Account. RequestType: PUT Input: input *UpdateAccountInput

func (*AdministrativeAccountsService) UpdateAccountWithContext

func (s *AdministrativeAccountsService) UpdateAccountWithContext(ctx context.Context, input *UpdateAccountInput) (output *models.AdministrativeAccount, resp *http.Response, err error)

UpdateAccountWithContext - Update the information for a native Administrative Account. RequestType: PUT Input: ctx context.Context, input *UpdateAccountInput

type ChangePasswordInput

type ChangePasswordInput struct {
	Body models.UserCredentials
}

type DeleteAccountInput

type DeleteAccountInput struct {
	Username string
}

type GetAccountInput

type GetAccountInput struct {
	Username string
}

type ResetPasswordInput

type ResetPasswordInput struct {
	Body     models.UserCredentials
	Username string
}

type UpdateAccountInput

type UpdateAccountInput struct {
	Body     models.AdministrativeAccount
	Username string
}