getapikey

Documentation

Overview

Retrieves information for one or more API keys.

Index

• Variables
• type GetApiKey
  • func New(tp elastictransport.Interface) *GetApiKey
  • func (r *GetApiKey) ActiveOnly(activeonly bool) *GetApiKey
  • func (r GetApiKey) Do(providedCtx context.Context) (*Response, error)
  • func (r *GetApiKey) Header(key, value string) *GetApiKey
  • func (r *GetApiKey) HttpRequest(ctx context.Context) (*http.Request, error)
  • func (r *GetApiKey) Id(id string) *GetApiKey
  • func (r GetApiKey) IsSuccess(providedCtx context.Context) (bool, error)
  • func (r *GetApiKey) Name(name string) *GetApiKey
  • func (r *GetApiKey) Owner(owner bool) *GetApiKey
  • func (r GetApiKey) Perform(providedCtx context.Context) (*http.Response, error)
  • func (r *GetApiKey) RealmName(name string) *GetApiKey
  • func (r *GetApiKey) Username(username string) *GetApiKey
  • func (r *GetApiKey) WithLimitedBy(withlimitedby bool) *GetApiKey
• type NewGetApiKey
  • func NewGetApiKeyFunc(tp elastictransport.Interface) NewGetApiKey
• 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 GetApiKey

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

func New

func New(tp elastictransport.Interface) *GetApiKey

Retrieves information for one or more API keys.

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

func (*GetApiKey) ActiveOnly

func (r *GetApiKey) ActiveOnly(activeonly bool) *GetApiKey

ActiveOnly A boolean flag that can be used to query API keys that are currently active. An API key is considered active if it is neither invalidated, nor expired at query time. You can specify this together with other parameters such as `owner` or `name`. If `active_only` is false, the response will include both active and inactive (expired or invalidated) keys. API name: active_only

func (GetApiKey) Do

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

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

func (*GetApiKey) Header

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

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

func (*GetApiKey) HttpRequest

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

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

func (*GetApiKey) Id

func (r *GetApiKey) Id(id string) *GetApiKey

Id An API key id. This parameter cannot be used with any of `name`, `realm_name` or `username`. API name: id

func (GetApiKey) IsSuccess

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

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

Name An API key name. This parameter cannot be used with any of `id`, `realm_name` or `username`. It supports prefix search with wildcard. API name: name

func (*GetApiKey) Owner

func (r *GetApiKey) Owner(owner bool) *GetApiKey

Owner A boolean flag that can be used to query API keys owned by the currently authenticated user. The `realm_name` or `username` parameters cannot be specified when this parameter is set to `true` as they are assumed to be the currently authenticated ones. API name: owner

func (GetApiKey) Perform

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

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

func (*GetApiKey) RealmName

func (r *GetApiKey) RealmName(name string) *GetApiKey

RealmName The name of an authentication realm. This parameter cannot be used with either `id` or `name` or when `owner` flag is set to `true`. API name: realm_name

func (*GetApiKey) Username

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

Username The username of a user. This parameter cannot be used with either `id` or `name` or when `owner` flag is set to `true`. API name: username

func (*GetApiKey) WithLimitedBy

func (r *GetApiKey) WithLimitedBy(withlimitedby bool) *GetApiKey

WithLimitedBy Return the snapshot of the owner user's role descriptors associated with the API key. An API key's actual permission is the intersection of its assigned role descriptors and the owner user's role descriptors. API name: with_limited_by

type NewGetApiKey

type NewGetApiKey func() *GetApiKey

NewGetApiKey type alias for index.

func NewGetApiKeyFunc

func NewGetApiKeyFunc(tp elastictransport.Interface) NewGetApiKey

NewGetApiKeyFunc returns a new instance of GetApiKey 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 {
	ApiKeys []types.ApiKey `json:"api_keys"`
}

Response holds the response body struct for the package getapikey

https://github.com/elastic/elasticsearch-specification/blob/b2c13a00c152a97cb41193deda8ed9b37fd06796/specification/security/get_api_key/SecurityGetApiKeyResponse.ts#L22-L24

func NewResponse

func NewResponse() *Response

NewResponse returns a Response