bulk

Documentation

Index

• Constants
• type BulkAPI
• type BulkService
  • func New(cfg *config.Config) *BulkService
  • func (s *BulkService) ExportConfiguration(input *ExportConfigurationInput) (output *models.BulkConfig, resp *http.Response, err error)
  • func (s *BulkService) ExportConfigurationWithContext(ctx context.Context, input *ExportConfigurationInput) (output *models.BulkConfig, resp *http.Response, err error)
  • func (s *BulkService) ImportConfiguration(input *ImportConfigurationInput) (resp *http.Response, err error)
  • func (s *BulkService) ImportConfigurationWithContext(ctx context.Context, input *ImportConfigurationInput) (resp *http.Response, err error)
• type ExportConfigurationInput
• type ImportConfigurationInput

Constants

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

Types

type BulkAPI

type BulkAPI interface {
	ExportConfiguration(input *ExportConfigurationInput) (output *models.BulkConfig, resp *http.Response, err error)
	ExportConfigurationWithContext(ctx context.Context, input *ExportConfigurationInput) (output *models.BulkConfig, resp *http.Response, err error)

	ImportConfiguration(input *ImportConfigurationInput) (resp *http.Response, err error)
	ImportConfigurationWithContext(ctx context.Context, input *ImportConfigurationInput) (resp *http.Response, err error)
}

type BulkService

type BulkService struct {
	*client.PfClient
}

func New

func New(cfg *config.Config) *BulkService

New creates a new instance of the BulkService client.

func (*BulkService) ExportConfiguration

func (s *BulkService) ExportConfiguration(input *ExportConfigurationInput) (output *models.BulkConfig, resp *http.Response, err error)

ExportConfiguration - Export all API resources to a JSON file. RequestType: GET Input: input *ExportConfigurationInput

func (*BulkService) ExportConfigurationWithContext

func (s *BulkService) ExportConfigurationWithContext(ctx context.Context, input *ExportConfigurationInput) (output *models.BulkConfig, resp *http.Response, err error)

ExportConfigurationWithContext - Export all API resources to a JSON file. RequestType: GET Input: ctx context.Context, input *ExportConfigurationInput

func (*BulkService) ImportConfiguration

func (s *BulkService) ImportConfiguration(input *ImportConfigurationInput) (resp *http.Response, err error)

ImportConfiguration - Import configuration for a PingFederate deployment from a JSON file. RequestType: POST Input: input *ImportConfigurationInput

func (*BulkService) ImportConfigurationWithContext

func (s *BulkService) ImportConfigurationWithContext(ctx context.Context, input *ImportConfigurationInput) (resp *http.Response, err error)

ImportConfigurationWithContext - Import configuration for a PingFederate deployment from a JSON file. RequestType: POST Input: ctx context.Context, input *ImportConfigurationInput

type ExportConfigurationInput

type ExportConfigurationInput struct {
	IncludeExternalResources string
}

type ImportConfigurationInput

type ImportConfigurationInput struct {
	FailFast string

	Body models.BulkConfig

	BypassExternalValidation *bool
}