getuserprivileges

Documentation

Overview

Get user privileges.

Get the security privileges for the logged in user. All users can use this API, but only to determine their own privileges. To check the privileges of other users, you must use the run as feature. To check whether a user has a specific list of privileges, use the has privileges API.

Index

• Variables
• type GetUserPrivileges
  • func New(tp elastictransport.Interface) *GetUserPrivileges
  • func (r *GetUserPrivileges) Application(name string) *GetUserPrivileges
  • func (r GetUserPrivileges) Do(providedCtx context.Context) (*Response, error)
  • func (r *GetUserPrivileges) ErrorTrace(errortrace bool) *GetUserPrivileges
  • func (r *GetUserPrivileges) FilterPath(filterpaths ...string) *GetUserPrivileges
  • func (r *GetUserPrivileges) Header(key, value string) *GetUserPrivileges
  • func (r *GetUserPrivileges) HttpRequest(ctx context.Context) (*http.Request, error)
  • func (r *GetUserPrivileges) Human(human bool) *GetUserPrivileges
  • func (r GetUserPrivileges) IsSuccess(providedCtx context.Context) (bool, error)
  • func (r GetUserPrivileges) Perform(providedCtx context.Context) (*http.Response, error)
  • func (r *GetUserPrivileges) Pretty(pretty bool) *GetUserPrivileges
  • func (r *GetUserPrivileges) Priviledge(name string) *GetUserPrivileges
  • func (r *GetUserPrivileges) Username(username string) *GetUserPrivileges
• type NewGetUserPrivileges
  • func NewGetUserPrivilegesFunc(tp elastictransport.Interface) NewGetUserPrivileges
• 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 GetUserPrivileges

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

func New

func New(tp elastictransport.Interface) *GetUserPrivileges

Get user privileges.

Get the security privileges for the logged in user. All users can use this API, but only to determine their own privileges. To check the privileges of other users, you must use the run as feature. To check whether a user has a specific list of privileges, use the has privileges API.

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

func (*GetUserPrivileges) Application

func (r *GetUserPrivileges) Application(name string) *GetUserPrivileges

Application The name of the application. Application privileges are always associated with exactly one application. If you do not specify this parameter, the API returns information about all privileges for all applications. API name: application

func (GetUserPrivileges) Do

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

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

func (*GetUserPrivileges) ErrorTrace

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

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

func (*GetUserPrivileges) FilterPath

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

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

func (*GetUserPrivileges) Header

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

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

func (*GetUserPrivileges) HttpRequest

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

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

func (*GetUserPrivileges) Human

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

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

func (r GetUserPrivileges) 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 (GetUserPrivileges) Perform

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

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

func (*GetUserPrivileges) Pretty

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

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

func (*GetUserPrivileges) Priviledge

func (r *GetUserPrivileges) Priviledge(name string) *GetUserPrivileges

Priviledge The name of the privilege. If you do not specify this parameter, the API returns information about all privileges for the requested application. API name: priviledge

func (*GetUserPrivileges) Username

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

API name: username

type NewGetUserPrivileges

type NewGetUserPrivileges func() *GetUserPrivileges

NewGetUserPrivileges type alias for index.

func NewGetUserPrivilegesFunc

func NewGetUserPrivilegesFunc(tp elastictransport.Interface) NewGetUserPrivileges

NewGetUserPrivilegesFunc returns a new instance of GetUserPrivileges 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 {
	Applications  []types.ApplicationPrivileges       `json:"applications"`
	Cluster       []string                            `json:"cluster"`
	Global        []types.GlobalPrivilege             `json:"global"`
	Indices       []types.UserIndicesPrivileges       `json:"indices"`
	RemoteCluster []types.RemoteClusterPrivileges     `json:"remote_cluster,omitempty"`
	RemoteIndices []types.RemoteUserIndicesPrivileges `json:"remote_indices,omitempty"`
	RunAs         []string                            `json:"run_as"`
}

Response holds the response body struct for the package getuserprivileges

https://github.com/elastic/elasticsearch-specification/blob/52c473efb1fb5320a5bac12572d0b285882862fb/specification/security/get_user_privileges/SecurityGetUserPrivilegesResponse.ts#L28-L38

func NewResponse

func NewResponse() *Response

NewResponse returns a Response