Documentation
¶
Overview ¶
Adds and updates users in the native realm. These users are commonly referred to as native users.
Index ¶
- Variables
- type NewPutUser
- type PutUser
- func (r PutUser) Do(providedCtx context.Context) (*Response, error)
- func (r *PutUser) Email(email string) *PutUser
- func (r *PutUser) Enabled(enabled bool) *PutUser
- func (r *PutUser) FullName(fullname string) *PutUser
- func (r *PutUser) Header(key, value string) *PutUser
- func (r *PutUser) HttpRequest(ctx context.Context) (*http.Request, error)
- func (r *PutUser) Metadata(metadata types.Metadata) *PutUser
- func (r *PutUser) Password(password string) *PutUser
- func (r *PutUser) PasswordHash(passwordhash string) *PutUser
- func (r PutUser) Perform(providedCtx context.Context) (*http.Response, error)
- func (r *PutUser) Raw(raw io.Reader) *PutUser
- func (r *PutUser) Refresh(refresh refresh.Refresh) *PutUser
- func (r *PutUser) Request(req *Request) *PutUser
- func (r *PutUser) Roles(roles ...string) *PutUser
- 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 NewPutUser ¶
NewPutUser type alias for index.
func NewPutUserFunc ¶
func NewPutUserFunc(tp elastictransport.Interface) NewPutUser
NewPutUserFunc returns a new instance of PutUser with the provided transport. Used in the index of the library this allows to retrieve every apis in once place.
type PutUser ¶
type PutUser struct {
// contains filtered or unexported fields
}
func New ¶
func New(tp elastictransport.Interface) *PutUser
Adds and updates users in the native realm. These users are commonly referred to as native users.
https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-put-user.html
func (PutUser) Do ¶
Do runs the request through the transport, handle the response and returns a putuser.Response
func (*PutUser) HttpRequest ¶
HttpRequest returns the http.Request object built from the given parameters.
func (*PutUser) PasswordHash ¶ added in v8.9.0
API name: password_hash
func (PutUser) Perform ¶ added in v8.7.0
Perform runs the http.Request through the provided transport and returns an http.Response.
func (*PutUser) Raw ¶
Raw takes a json payload as input which is then passed to the http.Request If specified Raw takes precedence on Request method.
func (*PutUser) Refresh ¶
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
type Request ¶
type Request struct {
Email string `json:"email,omitempty"`
Enabled *bool `json:"enabled,omitempty"`
FullName string `json:"full_name,omitempty"`
Metadata types.Metadata `json:"metadata,omitempty"`
Password *string `json:"password,omitempty"`
PasswordHash *string `json:"password_hash,omitempty"`
Roles []string `json:"roles,omitempty"`
Username *string `json:"username,omitempty"`
}
Request holds the request body struct for the package putuser
func (*Request) FromJSON ¶ added in v8.5.0
FromJSON allows to load an arbitrary json into the request structure
Source Files