disableuserprofile

Documentation

Overview

Disable a user profile.

Disable user profiles so that they are not visible in user profile searches.

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.

When you activate a user profile, its automatically enabled and visible in user profile searches. You can use the disable user profile API to disable a user profile so it’s not visible in these searches. To re-enable a disabled user profile, use the enable user profile API .

Index

• Variables
• type DisableUserProfile
  • func New(tp elastictransport.Interface) *DisableUserProfile
  • func (r DisableUserProfile) Do(providedCtx context.Context) (*Response, error)
  • func (r *DisableUserProfile) ErrorTrace(errortrace bool) *DisableUserProfile
  • func (r *DisableUserProfile) FilterPath(filterpaths ...string) *DisableUserProfile
  • func (r *DisableUserProfile) Header(key, value string) *DisableUserProfile
  • func (r *DisableUserProfile) HttpRequest(ctx context.Context) (*http.Request, error)
  • func (r *DisableUserProfile) Human(human bool) *DisableUserProfile
  • func (r DisableUserProfile) IsSuccess(providedCtx context.Context) (bool, error)
  • func (r DisableUserProfile) Perform(providedCtx context.Context) (*http.Response, error)
  • func (r *DisableUserProfile) Pretty(pretty bool) *DisableUserProfile
  • func (r *DisableUserProfile) Refresh(refresh refresh.Refresh) *DisableUserProfile
• type NewDisableUserProfile
  • func NewDisableUserProfileFunc(tp elastictransport.Interface) NewDisableUserProfile
• 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 DisableUserProfile

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

func New

func New(tp elastictransport.Interface) *DisableUserProfile

Disable a user profile.

Disable user profiles so that they are not visible in user profile searches.

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.

When you activate a user profile, its automatically enabled and visible in user profile searches. You can use the disable user profile API to disable a user profile so it’s not visible in these searches. To re-enable a disabled user profile, use the enable user profile API .

https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-security-disable-user-profile

func (DisableUserProfile) Do

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

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

func (*DisableUserProfile) ErrorTrace

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

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

func (*DisableUserProfile) FilterPath

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

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

func (*DisableUserProfile) Header

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

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

func (*DisableUserProfile) HttpRequest

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

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

func (*DisableUserProfile) Human

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

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 (DisableUserProfile) IsSuccess

func (r DisableUserProfile) IsSuccess(providedCtx context.Context) (bool, error)

IsSuccess allows to run a query with a context and retrieve the result as a boolean. This only exists for endpoints without a request payload and allows for quick control flow.

func (DisableUserProfile) Perform

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

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

func (*DisableUserProfile) Pretty

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

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

func (*DisableUserProfile) Refresh

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

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', it does nothing with refreshes. API name: refresh

type NewDisableUserProfile

type NewDisableUserProfile func(uid string) *DisableUserProfile

NewDisableUserProfile type alias for index.

func NewDisableUserProfileFunc

func NewDisableUserProfileFunc(tp elastictransport.Interface) NewDisableUserProfile

NewDisableUserProfileFunc returns a new instance of DisableUserProfile with the provided transport. Used in the index of the library this allows to retrieve every apis in once place.

type Response

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 disableuserprofile

https://github.com/elastic/elasticsearch-specification/blob/52c473efb1fb5320a5bac12572d0b285882862fb/specification/security/disable_user_profile/Response.ts#L22-L25

func NewResponse

func NewResponse() *Response

NewResponse returns a Response