activateuserprofile

Documentation

Overview

Activate a user profile.

Create or update a user profile on behalf of another user.

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. The calling application must have either an `access_token` or a combination of `username` and `password` for the user that the profile document is intended for. Elastic reserves the right to change or remove this feature in future releases without prior notice.

This API creates or updates a profile document for end users with information that is extracted from the user's authentication object including `username`, `full_name,` `roles`, and the authentication realm. For example, in the JWT `access_token` case, the profile user's `username` is extracted from the JWT token claim pointed to by the `claims.principal` setting of the JWT realm that authenticated the token.

When updating a profile document, the API enables the document if it was disabled. Any updates do not change existing content for either the `labels` or `data` fields.

Index

• Variables
• type ActivateUserProfile
  • func New(tp elastictransport.Interface) *ActivateUserProfile
  • func (r *ActivateUserProfile) AccessToken(accesstoken string) *ActivateUserProfile
  • func (r ActivateUserProfile) Do(providedCtx context.Context) (*Response, error)
  • func (r *ActivateUserProfile) ErrorTrace(errortrace bool) *ActivateUserProfile
  • func (r *ActivateUserProfile) FilterPath(filterpaths ...string) *ActivateUserProfile
  • func (r *ActivateUserProfile) GrantType(granttype granttype.GrantType) *ActivateUserProfile
  • func (r *ActivateUserProfile) Header(key, value string) *ActivateUserProfile
  • func (r *ActivateUserProfile) HttpRequest(ctx context.Context) (*http.Request, error)
  • func (r *ActivateUserProfile) Human(human bool) *ActivateUserProfile
  • func (r *ActivateUserProfile) Password(password string) *ActivateUserProfile
  • func (r ActivateUserProfile) Perform(providedCtx context.Context) (*http.Response, error)
  • func (r *ActivateUserProfile) Pretty(pretty bool) *ActivateUserProfile
  • func (r *ActivateUserProfile) Raw(raw io.Reader) *ActivateUserProfile
  • func (r *ActivateUserProfile) Request(req *Request) *ActivateUserProfile
  • func (r *ActivateUserProfile) Username(username string) *ActivateUserProfile
• type NewActivateUserProfile
  • func NewActivateUserProfileFunc(tp elastictransport.Interface) NewActivateUserProfile
• type Request
  • func NewRequest() *Request
  • func (r *Request) FromJSON(data string) (*Request, 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 ActivateUserProfile

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

func New

func New(tp elastictransport.Interface) *ActivateUserProfile

Activate a user profile.

Create or update a user profile on behalf of another user.

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. The calling application must have either an `access_token` or a combination of `username` and `password` for the user that the profile document is intended for. Elastic reserves the right to change or remove this feature in future releases without prior notice.

This API creates or updates a profile document for end users with information that is extracted from the user's authentication object including `username`, `full_name,` `roles`, and the authentication realm. For example, in the JWT `access_token` case, the profile user's `username` is extracted from the JWT token claim pointed to by the `claims.principal` setting of the JWT realm that authenticated the token.

When updating a profile document, the API enables the document if it was disabled. Any updates do not change existing content for either the `labels` or `data` fields.

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

func (*ActivateUserProfile) AccessToken

func (r *ActivateUserProfile) AccessToken(accesstoken string) *ActivateUserProfile

AccessToken The user's Elasticsearch access token or JWT. Both `access` and `id` JWT token types are supported and they depend on the underlying JWT realm configuration. If you specify the `access_token` grant type, this parameter is required. It is not valid with other grant types. API name: access_token

func (ActivateUserProfile) Do

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

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

func (*ActivateUserProfile) ErrorTrace

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

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

func (*ActivateUserProfile) FilterPath

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

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

func (*ActivateUserProfile) GrantType

func (r *ActivateUserProfile) GrantType(granttype granttype.GrantType) *ActivateUserProfile

GrantType The type of grant. API name: grant_type

func (*ActivateUserProfile) Header

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

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

func (*ActivateUserProfile) HttpRequest

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

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

func (*ActivateUserProfile) Human

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

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

func (r *ActivateUserProfile) Password(password string) *ActivateUserProfile

Password The user's password. If you specify the `password` grant type, this parameter is required. It is not valid with other grant types. API name: password

func (ActivateUserProfile) Perform

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

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

func (*ActivateUserProfile) Pretty

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

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

func (*ActivateUserProfile) Raw

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

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

func (*ActivateUserProfile) Request

func (r *ActivateUserProfile) Request(req *Request) *ActivateUserProfile

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

func (*ActivateUserProfile) Username

func (r *ActivateUserProfile) Username(username string) *ActivateUserProfile

Username The username that identifies the user. If you specify the `password` grant type, this parameter is required. It is not valid with other grant types. API name: username

type NewActivateUserProfile

type NewActivateUserProfile func() *ActivateUserProfile

NewActivateUserProfile type alias for index.

func NewActivateUserProfileFunc

func NewActivateUserProfileFunc(tp elastictransport.Interface) NewActivateUserProfile

NewActivateUserProfileFunc returns a new instance of ActivateUserProfile 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 {

	// AccessToken The user's Elasticsearch access token or JWT.
	// Both `access` and `id` JWT token types are supported and they depend on the
	// underlying JWT realm configuration.
	// If you specify the `access_token` grant type, this parameter is required.
	// It is not valid with other grant types.
	AccessToken *string `json:"access_token,omitempty"`
	// GrantType The type of grant.
	GrantType granttype.GrantType `json:"grant_type"`
	// Password The user's password.
	// If you specify the `password` grant type, this parameter is required.
	// It is not valid with other grant types.
	Password *string `json:"password,omitempty"`
	// Username The username that identifies the user.
	// If you specify the `password` grant type, this parameter is required.
	// It is not valid with other grant types.
	Username *string `json:"username,omitempty"`
}

Request holds the request body struct for the package activateuserprofile

https://github.com/elastic/elasticsearch-specification/blob/470b4b9aaaa25cae633ec690e54b725c6fc939c7/specification/security/activate_user_profile/Request.ts#L23-L76

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

type Response

type Response struct {
	Data             map[string]json.RawMessage   `json:"data"`
	Doc_             types.UserProfileHitMetadata `json:"_doc"`
	Enabled          *bool                        `json:"enabled,omitempty"`
	Labels           map[string]json.RawMessage   `json:"labels"`
	LastSynchronized int64                        `json:"last_synchronized"`
	Uid              string                       `json:"uid"`
	User             types.UserProfileUser        `json:"user"`
}

Response holds the response body struct for the package activateuserprofile

https://github.com/elastic/elasticsearch-specification/blob/470b4b9aaaa25cae633ec690e54b725c6fc939c7/specification/security/activate_user_profile/Response.ts#L22-L24

func NewResponse

func NewResponse() *Response

NewResponse returns a Response