updateuserprofiledata

package
v8.18.1 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Jun 17, 2025 License: Apache-2.0 Imports: 13 Imported by: 4

Documentation

Overview

Update user profile data.

Update specific data for the user profile that is associated with a unique ID.

NOTE: The user profile feature is designed only for use by Kibana and Elastic's Observability, Enterprise Search, and Elastic Security solutions. Individual users and external applications should not call this API directly. Elastic reserves the right to change or remove this feature in future releases without prior notice.

To use this API, you must have one of the following privileges:

* The `manage_user_profile` cluster privilege. * The `update_profile_data` global privilege for the namespaces that are referenced in the request.

This API updates the `labels` and `data` fields of an existing user profile document with JSON objects. New keys and their values are added to the profile document and conflicting keys are replaced by data that's included in the request.

For both labels and data, content is namespaced by the top-level fields. The `update_profile_data` global privilege grants privileges for updating only the allowed namespaces.

Index

Constants

This section is empty.

Variables

View Source 
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 NewUpdateUserProfileData 

type NewUpdateUserProfileData func(uid string) *UpdateUserProfileData

NewUpdateUserProfileData type alias for index.

func NewUpdateUserProfileDataFunc 

func NewUpdateUserProfileDataFunc(tp elastictransport.Interface) NewUpdateUserProfileData

NewUpdateUserProfileDataFunc returns a new instance of UpdateUserProfileData 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 {

	// Data Non-searchable data that you want to associate with the user profile.
	// This field supports a nested data structure.
	// Within the `data` object, top-level keys cannot begin with an underscore
	// (`_`) or contain a period (`.`).
	// The data object is not searchable, but can be retrieved with the get user
	// profile API.
	Data map[string]json.RawMessage `json:"data,omitempty"`
	// Labels Searchable data that you want to associate with the user profile.
	// This field supports a nested data structure.
	// Within the labels object, top-level keys cannot begin with an underscore
	// (`_`) or contain a period (`.`).
	Labels map[string]json.RawMessage `json:"labels,omitempty"`
}

Request holds the request body struct for the package updateuserprofiledata

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/security/update_user_profile_data/Request.ts#L27-L98

func NewRequest added in v8.5.0 

func NewRequest() *Request

NewRequest returns a Request

func (*Request) FromJSON added in v8.5.0 

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

FromJSON allows to load an arbitrary json into the request structure

type Response added in v8.7.0 

type Response struct {

	// Acknowledged For a successful response, this value is always true. On failure, an
	// exception is returned instead.
	Acknowledged bool `json:"acknowledged"`
}

Response holds the response body struct for the package updateuserprofiledata

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/security/update_user_profile_data/Response.ts#L22-L24

func NewResponse added in v8.7.0 

func NewResponse() *Response

NewResponse returns a Response

type UpdateUserProfileData 

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

func New 

func New(tp elastictransport.Interface) *UpdateUserProfileData

Update user profile data.

Update specific data for the user profile that is associated with a unique ID.

NOTE: The user profile feature is designed only for use by Kibana and Elastic's Observability, Enterprise Search, and Elastic Security solutions. Individual users and external applications should not call this API directly. Elastic reserves the right to change or remove this feature in future releases without prior notice.

To use this API, you must have one of the following privileges:

* The `manage_user_profile` cluster privilege. * The `update_profile_data` global privilege for the namespaces that are referenced in the request.

This API updates the `labels` and `data` fields of an existing user profile document with JSON objects. New keys and their values are added to the profile document and conflicting keys are replaced by data that's included in the request.

For both labels and data, content is namespaced by the top-level fields. The `update_profile_data` global privilege grants privileges for updating only the allowed namespaces.

https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-update-user-profile-data.html

func (*UpdateUserProfileData) Data added in v8.9.0 

func (r *UpdateUserProfileData) Data(data map[string]json.RawMessage) *UpdateUserProfileData

Data Non-searchable data that you want to associate with the user profile. This field supports a nested data structure. Within the `data` object, top-level keys cannot begin with an underscore (`_`) or contain a period (`.`). The data object is not searchable, but can be retrieved with the get user profile API. API name: data

func (UpdateUserProfileData) Do 

func (r UpdateUserProfileData) Do(providedCtx context.Context) (*Response, error)

Do runs the request through the transport, handle the response and returns a updateuserprofiledata.Response

func (*UpdateUserProfileData) ErrorTrace added in v8.14.0 

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

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

func (*UpdateUserProfileData) FilterPath added in v8.14.0 

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

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

func (*UpdateUserProfileData) Header 

func (r *UpdateUserProfileData) Header(key, value string) *UpdateUserProfileData

Header set a key, value pair in the UpdateUserProfileData headers map.

func (*UpdateUserProfileData) HttpRequest 

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

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

func (*UpdateUserProfileData) Human added in v8.14.0 

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

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 (*UpdateUserProfileData) IfPrimaryTerm 

func (r *UpdateUserProfileData) IfPrimaryTerm(ifprimaryterm string) *UpdateUserProfileData

IfPrimaryTerm Only perform the operation if the document has this primary term. API name: if_primary_term

func (*UpdateUserProfileData) IfSeqNo 

func (r *UpdateUserProfileData) IfSeqNo(sequencenumber string) *UpdateUserProfileData

IfSeqNo Only perform the operation if the document has this sequence number. API name: if_seq_no

func (*UpdateUserProfileData) Labels added in v8.9.0 

func (r *UpdateUserProfileData) Labels(labels map[string]json.RawMessage) *UpdateUserProfileData

Labels Searchable data that you want to associate with the user profile. This field supports a nested data structure. Within the labels object, top-level keys cannot begin with an underscore (`_`) or contain a period (`.`). API name: labels

func (UpdateUserProfileData) Perform added in v8.7.0 

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

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

func (*UpdateUserProfileData) Pretty added in v8.14.0 

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

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

func (*UpdateUserProfileData) Raw 

func (r *UpdateUserProfileData) Raw(raw io.Reader) *UpdateUserProfileData

Raw takes a json payload as input which is then passed to the http.Request If specified Raw takes precedence on Request method.

func (*UpdateUserProfileData) Refresh 

func (r *UpdateUserProfileData) Refresh(refresh refresh.Refresh) *UpdateUserProfileData

Refresh If 'true', Elasticsearch refreshes the affected shards to make this operation visible to search. If 'wait_for', it waits for a refresh to make this operation visible to search. If 'false', nothing is done with refreshes. API name: refresh

func (*UpdateUserProfileData) Request 

func (r *UpdateUserProfileData) Request(req *Request) *UpdateUserProfileData

Request allows to set the request property with the appropriate payload.

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.