Documentation
¶
Overview ¶
Changes the passwords of users in the native realm and built-in users.
Index ¶
- Variables
- type ChangePassword
- func (r ChangePassword) Do(providedCtx context.Context) (*Response, error)
- func (r *ChangePassword) Header(key, value string) *ChangePassword
- func (r *ChangePassword) HttpRequest(ctx context.Context) (*http.Request, error)
- func (r *ChangePassword) Password(password string) *ChangePassword
- func (r *ChangePassword) PasswordHash(passwordhash string) *ChangePassword
- func (r ChangePassword) Perform(providedCtx context.Context) (*http.Response, error)
- func (r *ChangePassword) Raw(raw io.Reader) *ChangePassword
- func (r *ChangePassword) Refresh(refresh refresh.Refresh) *ChangePassword
- func (r *ChangePassword) Request(req *Request) *ChangePassword
- func (r *ChangePassword) Username(username string) *ChangePassword
- type NewChangePassword
- type Request
- type Response
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 ChangePassword ¶
type ChangePassword struct {
// contains filtered or unexported fields
}
func New ¶
func New(tp elastictransport.Interface) *ChangePassword
Changes the passwords of users in the native realm and built-in users.
https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-change-password.html
func (ChangePassword) Do ¶
func (r ChangePassword) Do(providedCtx context.Context) (*Response, error)
Do runs the request through the transport, handle the response and returns a changepassword.Response
func (*ChangePassword) Header ¶
func (r *ChangePassword) Header(key, value string) *ChangePassword
Header set a key, value pair in the ChangePassword headers map.
func (*ChangePassword) HttpRequest ¶
HttpRequest returns the http.Request object built from the given parameters.
func (*ChangePassword) Password ¶ added in v8.9.0
func (r *ChangePassword) Password(password string) *ChangePassword
Password The new password value. Passwords must be at least 6 characters long. API name: password
func (*ChangePassword) PasswordHash ¶ added in v8.9.0
func (r *ChangePassword) PasswordHash(passwordhash string) *ChangePassword
PasswordHash A hash of the new password value. This must be produced using the same hashing algorithm as has been configured for password storage. For more details, see the explanation of the `xpack.security.authc.password_hashing.algorithm` setting. API name: password_hash
func (ChangePassword) Perform ¶ added in v8.7.0
Perform runs the http.Request through the provided transport and returns an http.Response.
func (*ChangePassword) Raw ¶
func (r *ChangePassword) Raw(raw io.Reader) *ChangePassword
Raw takes a json payload as input which is then passed to the http.Request If specified Raw takes precedence on Request method.
func (*ChangePassword) Refresh ¶
func (r *ChangePassword) Refresh(refresh refresh.Refresh) *ChangePassword
Refresh If `true` (the default) then refresh the affected shards to make this operation visible to search, if `wait_for` then wait for a refresh to make this operation visible to search, if `false` then do nothing with refreshes. API name: refresh
func (*ChangePassword) Request ¶
func (r *ChangePassword) Request(req *Request) *ChangePassword
Request allows to set the request property with the appropriate payload.
func (*ChangePassword) Username ¶
func (r *ChangePassword) Username(username string) *ChangePassword
Username The user whose password you want to change. If you do not specify this parameter, the password is changed for the current user. API Name: username
type NewChangePassword ¶
type NewChangePassword func() *ChangePassword
NewChangePassword type alias for index.
func NewChangePasswordFunc ¶
func NewChangePasswordFunc(tp elastictransport.Interface) NewChangePassword
NewChangePasswordFunc returns a new instance of ChangePassword 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 {
// Password The new password value. Passwords must be at least 6 characters long.
Password *string `json:"password,omitempty"`
// PasswordHash A hash of the new password value. This must be produced using the same
// hashing algorithm as has been configured for password storage. For more
// details,
// see the explanation of the `xpack.security.authc.password_hashing.algorithm`
// setting.
PasswordHash *string `json:"password_hash,omitempty"`
}
Request holds the request body struct for the package changepassword
func (*Request) FromJSON ¶ added in v8.5.0
FromJSON allows to load an arbitrary json into the request structure
Source Files