changepassword

Documentation

Overview

Change passwords.

Change the passwords of users in the native realm and built-in users.

Index

• Variables
• type ChangePassword
  • func New(tp elastictransport.Interface) *ChangePassword
  • func (r ChangePassword) Do(providedCtx context.Context) (*Response, error)
  • func (r *ChangePassword) ErrorTrace(errortrace bool) *ChangePassword
  • func (r *ChangePassword) FilterPath(filterpaths ...string) *ChangePassword
  • func (r *ChangePassword) Header(key, value string) *ChangePassword
  • func (r *ChangePassword) HttpRequest(ctx context.Context) (*http.Request, error)
  • func (r *ChangePassword) Human(human bool) *ChangePassword
  • 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) Pretty(pretty bool) *ChangePassword
  • 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
  • func NewChangePasswordFunc(tp elastictransport.Interface) NewChangePassword
• type Request
  • func NewRequest() *Request
  • func (r *Request) FromJSON(data string) (*Request, error)
  • func (s *Request) UnmarshalJSON(data []byte) error
• type Response
  • func NewResponse() *Response

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.

Types

type ChangePassword

type ChangePassword struct {
	// contains filtered or unexported fields
}

func New

func New(tp elastictransport.Interface) *ChangePassword

Change passwords.

Change 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) ErrorTrace

func (r *ChangePassword) ErrorTrace(errortrace bool) *ChangePassword

ErrorTrace When set to `true` Elasticsearch will include the full stack trace of errors when they occur. API name: error_trace

func (*ChangePassword) FilterPath

func (r *ChangePassword) FilterPath(filterpaths ...string) *ChangePassword

FilterPath Comma-separated list of filters in dot notation which reduce the response returned by Elasticsearch. API name: filter_path

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

func (r *ChangePassword) HttpRequest(ctx context.Context) (*http.Request, error)

HttpRequest returns the http.Request object built from the given parameters.

func (*ChangePassword) Human

func (r *ChangePassword) Human(human bool) *ChangePassword

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 (*ChangePassword) Password

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

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

func (r ChangePassword) Perform(providedCtx context.Context) (*http.Response, error)

Perform runs the http.Request through the provided transport and returns an http.Response.

func (*ChangePassword) Pretty

func (r *ChangePassword) Pretty(pretty bool) *ChangePassword

Pretty If set to `true` the returned JSON will be "pretty-formatted". Only use this option for debugging only. API name: pretty

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

https://github.com/elastic/elasticsearch-specification/blob/4fcf747dfafc951e1dcf3077327e3dcee9107db3/specification/security/change_password/SecurityChangePasswordRequest.ts#L23-L54

func NewRequest

func NewRequest() *Request

NewRequest returns a Request

func (*Request) FromJSON

func (r *Request) FromJSON(data string) (*Request, error)

FromJSON allows to load an arbitrary json into the request structure

func (*Request) UnmarshalJSON

func (s *Request) UnmarshalJSON(data []byte) error

type Response

type Response struct {
}

Response holds the response body struct for the package changepassword

https://github.com/elastic/elasticsearch-specification/blob/4fcf747dfafc951e1dcf3077327e3dcee9107db3/specification/security/change_password/SecurityChangePasswordResponse.ts#L20-L22

func NewResponse

func NewResponse() *Response

NewResponse returns a Response