Documentation
¶
Overview ¶
Exchanges a SAML Response message for an Elasticsearch access token and refresh token pair
Index ¶
- Variables
- type NewSamlAuthenticate
- type Request
- type Response
- type SamlAuthenticate
- func (r *SamlAuthenticate) Content(content string) *SamlAuthenticate
- func (r SamlAuthenticate) Do(providedCtx context.Context) (*Response, error)
- func (r *SamlAuthenticate) Header(key, value string) *SamlAuthenticate
- func (r *SamlAuthenticate) HttpRequest(ctx context.Context) (*http.Request, error)
- func (r *SamlAuthenticate) Ids(ids ...string) *SamlAuthenticate
- func (r SamlAuthenticate) Perform(providedCtx context.Context) (*http.Response, error)
- func (r *SamlAuthenticate) Raw(raw io.Reader) *SamlAuthenticate
- func (r *SamlAuthenticate) Realm(realm string) *SamlAuthenticate
- func (r *SamlAuthenticate) Request(req *Request) *SamlAuthenticate
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 NewSamlAuthenticate ¶
type NewSamlAuthenticate func() *SamlAuthenticate
NewSamlAuthenticate type alias for index.
func NewSamlAuthenticateFunc ¶
func NewSamlAuthenticateFunc(tp elastictransport.Interface) NewSamlAuthenticate
NewSamlAuthenticateFunc returns a new instance of SamlAuthenticate with the provided transport. Used in the index of the library this allows to retrieve every apis in once place.
type Request ¶
type Request struct {
// Content The SAML response as it was sent by the user’s browser, usually a Base64
// encoded XML document.
Content string `json:"content"`
// Ids A json array with all the valid SAML Request Ids that the caller of the API
// has for the current user.
Ids []string `json:"ids"`
// Realm The name of the realm that should authenticate the SAML response. Useful in
// cases where many SAML realms are defined.
Realm *string `json:"realm,omitempty"`
}
Request holds the request body struct for the package samlauthenticate
func (*Request) FromJSON ¶ added in v8.5.0
FromJSON allows to load an arbitrary json into the request structure
func (*Request) UnmarshalJSON ¶ added in v8.12.1
type Response ¶ added in v8.7.0
type Response struct {
AccessToken string `json:"access_token"`
ExpiresIn int `json:"expires_in"`
Realm string `json:"realm"`
RefreshToken string `json:"refresh_token"`
Username string `json:"username"`
}
Response holds the response body struct for the package samlauthenticate
type SamlAuthenticate ¶
type SamlAuthenticate struct {
// contains filtered or unexported fields
}
func New ¶
func New(tp elastictransport.Interface) *SamlAuthenticate
Exchanges a SAML Response message for an Elasticsearch access token and refresh token pair
https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-saml-authenticate.html
func (*SamlAuthenticate) Content ¶ added in v8.9.0
func (r *SamlAuthenticate) Content(content string) *SamlAuthenticate
Content The SAML response as it was sent by the user’s browser, usually a Base64 encoded XML document. API name: content
func (SamlAuthenticate) Do ¶
func (r SamlAuthenticate) Do(providedCtx context.Context) (*Response, error)
Do runs the request through the transport, handle the response and returns a samlauthenticate.Response
func (*SamlAuthenticate) Header ¶
func (r *SamlAuthenticate) Header(key, value string) *SamlAuthenticate
Header set a key, value pair in the SamlAuthenticate headers map.
func (*SamlAuthenticate) HttpRequest ¶
HttpRequest returns the http.Request object built from the given parameters.
func (*SamlAuthenticate) Ids ¶ added in v8.9.0
func (r *SamlAuthenticate) Ids(ids ...string) *SamlAuthenticate
Ids A json array with all the valid SAML Request Ids that the caller of the API has for the current user. API name: ids
func (SamlAuthenticate) Perform ¶ added in v8.7.0
Perform runs the http.Request through the provided transport and returns an http.Response.
func (*SamlAuthenticate) Raw ¶
func (r *SamlAuthenticate) Raw(raw io.Reader) *SamlAuthenticate
Raw takes a json payload as input which is then passed to the http.Request If specified Raw takes precedence on Request method.
func (*SamlAuthenticate) Realm ¶ added in v8.9.0
func (r *SamlAuthenticate) Realm(realm string) *SamlAuthenticate
Realm The name of the realm that should authenticate the SAML response. Useful in cases where many SAML realms are defined. API name: realm
func (*SamlAuthenticate) Request ¶
func (r *SamlAuthenticate) Request(req *Request) *SamlAuthenticate
Request allows to set the request property with the appropriate payload.
Source Files