Documentation
¶
Overview ¶
Generates SAML metadata for the Elastic stack SAML 2.0 Service Provider
Index ¶
- Variables
- type NewSamlServiceProviderMetadata
- type Response
- type SamlServiceProviderMetadata
- func (r SamlServiceProviderMetadata) Do(providedCtx context.Context) (*Response, error)
- func (r *SamlServiceProviderMetadata) Header(key, value string) *SamlServiceProviderMetadata
- func (r *SamlServiceProviderMetadata) HttpRequest(ctx context.Context) (*http.Request, error)
- func (r SamlServiceProviderMetadata) IsSuccess(providedCtx context.Context) (bool, error)
- func (r SamlServiceProviderMetadata) Perform(providedCtx context.Context) (*http.Response, error)
Constants ¶
This section is empty.
Variables ¶
var ErrBuildPath = errors.New("cannot build path, check for missing path parameters")
ErrBuildPath is returned in case of missing parameters within the build of the request.
Functions ¶
This section is empty.
Types ¶
type NewSamlServiceProviderMetadata ¶
type NewSamlServiceProviderMetadata func(realmname string) *SamlServiceProviderMetadata
NewSamlServiceProviderMetadata type alias for index.
func NewSamlServiceProviderMetadataFunc ¶
func NewSamlServiceProviderMetadataFunc(tp elastictransport.Interface) NewSamlServiceProviderMetadata
NewSamlServiceProviderMetadataFunc returns a new instance of SamlServiceProviderMetadata with the provided transport. Used in the index of the library this allows to retrieve every apis in once place.
type Response ¶ added in v8.7.0
type Response struct {
Metadata string `json:"metadata"`
}
Response holds the response body struct for the package samlserviceprovidermetadata
type SamlServiceProviderMetadata ¶
type SamlServiceProviderMetadata struct {
// contains filtered or unexported fields
}
func New ¶
func New(tp elastictransport.Interface) *SamlServiceProviderMetadata
Generates SAML metadata for the Elastic stack SAML 2.0 Service Provider
https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-saml-sp-metadata.html
func (SamlServiceProviderMetadata) Do ¶
func (r SamlServiceProviderMetadata) Do(providedCtx context.Context) (*Response, error)
Do runs the request through the transport, handle the response and returns a samlserviceprovidermetadata.Response
func (*SamlServiceProviderMetadata) Header ¶
func (r *SamlServiceProviderMetadata) Header(key, value string) *SamlServiceProviderMetadata
Header set a key, value pair in the SamlServiceProviderMetadata headers map.
func (*SamlServiceProviderMetadata) HttpRequest ¶
HttpRequest returns the http.Request object built from the given parameters.
func (SamlServiceProviderMetadata) IsSuccess ¶
func (r SamlServiceProviderMetadata) IsSuccess(providedCtx context.Context) (bool, error)
IsSuccess allows to run a query with a context and retrieve the result as a boolean. This only exists for endpoints without a request payload and allows for quick control flow.
Source Files