Documentation
¶
Overview ¶
Create SAML service provider metadata.
Generate SAML metadata for a SAML 2.0 Service Provider.
The SAML 2.0 specification provides a mechanism for Service Providers to describe their capabilities and configuration using a metadata file. This API generates Service Provider metadata based on the configuration of a SAML realm in Elasticsearch.
Index ¶
- Variables
- type NewSamlServiceProviderMetadata
- type Response
- type SamlServiceProviderMetadata
- func (r SamlServiceProviderMetadata) Do(providedCtx context.Context) (*Response, error)
- func (r *SamlServiceProviderMetadata) ErrorTrace(errortrace bool) *SamlServiceProviderMetadata
- func (r *SamlServiceProviderMetadata) FilterPath(filterpaths ...string) *SamlServiceProviderMetadata
- func (r *SamlServiceProviderMetadata) Header(key, value string) *SamlServiceProviderMetadata
- func (r *SamlServiceProviderMetadata) HttpRequest(ctx context.Context) (*http.Request, error)
- func (r *SamlServiceProviderMetadata) Human(human bool) *SamlServiceProviderMetadata
- func (r SamlServiceProviderMetadata) IsSuccess(providedCtx context.Context) (bool, error)
- func (r SamlServiceProviderMetadata) Perform(providedCtx context.Context) (*http.Response, error)
- func (r *SamlServiceProviderMetadata) Pretty(pretty bool) *SamlServiceProviderMetadata
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 ¶
type Response struct {
// Metadata An XML string that contains a SAML Service Provider's metadata for the realm.
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
Create SAML service provider metadata.
Generate SAML metadata for a SAML 2.0 Service Provider.
The SAML 2.0 specification provides a mechanism for Service Providers to describe their capabilities and configuration using a metadata file. This API generates Service Provider metadata based on the configuration of a SAML realm in Elasticsearch.
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) ErrorTrace ¶
func (r *SamlServiceProviderMetadata) ErrorTrace(errortrace bool) *SamlServiceProviderMetadata
ErrorTrace When set to `true` Elasticsearch will include the full stack trace of errors when they occur. API name: error_trace
func (*SamlServiceProviderMetadata) FilterPath ¶
func (r *SamlServiceProviderMetadata) FilterPath(filterpaths ...string) *SamlServiceProviderMetadata
FilterPath Comma-separated list of filters in dot notation which reduce the response returned by Elasticsearch. API name: filter_path
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) Human ¶
func (r *SamlServiceProviderMetadata) Human(human bool) *SamlServiceProviderMetadata
Human When set to `true` will return statistics in a format suitable for humans. For example `"exists_time": "1h"` for humans and `"eixsts_time_in_millis": 3600000` for computers. When disabled the human readable values will be omitted. This makes sense for responses being consumed only by machines. API name: human
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.
func (SamlServiceProviderMetadata) Perform ¶
Perform runs the http.Request through the provided transport and returns an http.Response.
func (*SamlServiceProviderMetadata) Pretty ¶
func (r *SamlServiceProviderMetadata) Pretty(pretty bool) *SamlServiceProviderMetadata
Pretty If set to `true` the returned JSON will be "pretty-formatted". Only use this option for debugging only. API name: pretty
Source Files