getrolemapping

Documentation

Overview

Get role mappings.

Role mappings define which roles are assigned to each user. The role mapping APIs are generally the preferred way to manage role mappings rather than using role mapping files. The get role mappings API cannot retrieve role mappings that are defined in role mapping files.

Index

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

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

func New

func New(tp elastictransport.Interface) *GetRoleMapping

Get role mappings.

Role mappings define which roles are assigned to each user. The role mapping APIs are generally the preferred way to manage role mappings rather than using role mapping files. The get role mappings API cannot retrieve role mappings that are defined in role mapping files.

https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-get-role-mapping.html

func (GetRoleMapping) Do

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

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

func (*GetRoleMapping) ErrorTrace

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

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

func (*GetRoleMapping) FilterPath

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

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

func (*GetRoleMapping) Header

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

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

func (*GetRoleMapping) HttpRequest

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

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

func (*GetRoleMapping) Human

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

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

func (r GetRoleMapping) 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 (*GetRoleMapping) Name

func (r *GetRoleMapping) Name(name string) *GetRoleMapping

Name The distinct name that identifies the role mapping. The name is used solely as an identifier to facilitate interaction via the API; it does not affect the behavior of the mapping in any way. You can specify multiple mapping names as a comma-separated list. If you do not specify this parameter, the API returns information about all role mappings. API Name: name

func (GetRoleMapping) Perform

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

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

func (*GetRoleMapping) Pretty

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

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

type NewGetRoleMapping

type NewGetRoleMapping func() *GetRoleMapping

NewGetRoleMapping type alias for index.

func NewGetRoleMappingFunc

func NewGetRoleMappingFunc(tp elastictransport.Interface) NewGetRoleMapping

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

type Response

type Response map[string]types.SecurityRoleMapping

func NewResponse

func NewResponse() Response

NewResponse returns a Response