api

Documentation

Index

• type Api
  • func ProvideApi(ssoSettingsSvc ssosettings.Service, routeRegister routing.RouteRegister, ...) *Api
  • func (api *Api) RegisterAPIEndpoints()
• type GetProviderSettingsParams
• type GetSSOSettingsResponse
• type ListAllProvidersSettingsParams
• type ListSSOSettingsResponse
• type RemoveProviderSettingsParams
• type UpdateProviderSettingsParams

Types

type Api

type Api struct {
	Log                log.Logger
	RouteRegister      routing.RouteRegister
	AccessControl      ac.AccessControl
	Features           featuremgmt.FeatureToggles
	SSOSettingsService ssosettings.Service
}

func ProvideApi

func ProvideApi(
	ssoSettingsSvc ssosettings.Service,
	routeRegister routing.RouteRegister,
	ac ac.AccessControl,
) *Api

func (*Api) RegisterAPIEndpoints

func (api *Api) RegisterAPIEndpoints()

RegisterAPIEndpoints Registers Endpoints on Grafana Router

type GetProviderSettingsParams

type GetProviderSettingsParams struct {
	// in:path
	// required:true
	Provider string `json:"key"`
}

swagger:parameters getProviderSettings

type GetSSOSettingsResponse

type GetSSOSettingsResponse struct {
	// in: body
	Body struct {
		ID       string         `json:"id"`
		Provider string         `json:"provider"`
		Settings map[string]any `json:"settings"`
		Source   string         `json:"source"`
	} `json:"body"`
}

swagger:response getSSOSettingsResponse

type ListAllProvidersSettingsParams

type ListAllProvidersSettingsParams struct {
}

swagger:parameters listAllProvidersSettings

type ListSSOSettingsResponse

type ListSSOSettingsResponse struct {
	// in: body
	Body []struct {
		ID       string         `json:"id"`
		Provider string         `json:"provider"`
		Settings map[string]any `json:"settings"`
		Source   string         `json:"source"`
	} `json:"body"`
}

swagger:response listSSOSettingsResponse

type RemoveProviderSettingsParams

type RemoveProviderSettingsParams struct {
	// in:path
	// required:true
	Provider string `json:"key"`
}

swagger:parameters removeProviderSettings

type UpdateProviderSettingsParams

type UpdateProviderSettingsParams struct {
	// in:path
	// required:true
	Provider string `json:"key"`
	// in:body
	// required:true
	Body struct {
		ID       string         `json:"id"`
		Provider string         `json:"provider"`
		Settings map[string]any `json:"settings"`
	} `json:"body"`
}

swagger:parameters updateProviderSettings