grantapikey

Documentation

Overview

Creates an API key on behalf of another user.

Index

• Variables
• type GrantApiKey
  • func New(tp elastictransport.Interface) *GrantApiKey
  • func (r *GrantApiKey) AccessToken(accesstoken string) *GrantApiKey
  • func (r *GrantApiKey) ApiKey(apikey *types.GrantApiKey) *GrantApiKey
  • func (r GrantApiKey) Do(ctx context.Context) (*Response, error)
  • func (r *GrantApiKey) GrantType(granttype apikeygranttype.ApiKeyGrantType) *GrantApiKey
  • func (r *GrantApiKey) Header(key, value string) *GrantApiKey
  • func (r *GrantApiKey) HttpRequest(ctx context.Context) (*http.Request, error)
  • func (r *GrantApiKey) Password(password string) *GrantApiKey
  • func (r GrantApiKey) Perform(ctx context.Context) (*http.Response, error)
  • func (r *GrantApiKey) Raw(raw io.Reader) *GrantApiKey
  • func (r *GrantApiKey) Request(req *Request) *GrantApiKey
  • func (r *GrantApiKey) RunAs(username string) *GrantApiKey
  • func (r *GrantApiKey) Username(username string) *GrantApiKey
• type NewGrantApiKey
  • func NewGrantApiKeyFunc(tp elastictransport.Interface) NewGrantApiKey
• 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 GrantApiKey

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

func New

func New(tp elastictransport.Interface) *GrantApiKey

Creates an API key on behalf of another user.

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

func (*GrantApiKey) AccessToken

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

AccessToken The user’s access token. 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 (*GrantApiKey) ApiKey

func (r *GrantApiKey) ApiKey(apikey *types.GrantApiKey) *GrantApiKey

ApiKey Defines the API key. API name: api_key

func (GrantApiKey) Do

func (r GrantApiKey) Do(ctx context.Context) (*Response, error)

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

func (*GrantApiKey) GrantType

func (r *GrantApiKey) GrantType(granttype apikeygranttype.ApiKeyGrantType) *GrantApiKey

GrantType The type of grant. Supported grant types are: `access_token`, `password`. API name: grant_type

func (*GrantApiKey) Header

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

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

func (*GrantApiKey) HttpRequest

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

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

func (*GrantApiKey) Password

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

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 (GrantApiKey) Perform

func (r GrantApiKey) Perform(ctx context.Context) (*http.Response, error)

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

func (*GrantApiKey) Raw

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

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

func (*GrantApiKey) Request

func (r *GrantApiKey) Request(req *Request) *GrantApiKey

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

func (*GrantApiKey) RunAs

func (r *GrantApiKey) RunAs(username string) *GrantApiKey

RunAs The name of the user to be impersonated. API name: run_as

func (*GrantApiKey) Username

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

Username The user name 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 NewGrantApiKey

type NewGrantApiKey func() *GrantApiKey

NewGrantApiKey type alias for index.

func NewGrantApiKeyFunc

func NewGrantApiKeyFunc(tp elastictransport.Interface) NewGrantApiKey

NewGrantApiKeyFunc returns a new instance of GrantApiKey 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 access token.
	// 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"`
	// ApiKey Defines the API key.
	ApiKey types.GrantApiKey `json:"api_key"`
	// GrantType The type of grant. Supported grant types are: `access_token`, `password`.
	GrantType apikeygranttype.ApiKeyGrantType `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"`
	// RunAs The name of the user to be impersonated.
	RunAs *string `json:"run_as,omitempty"`
	// Username The user name 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 grantapikey

https://github.com/elastic/elasticsearch-specification/blob/5fea44e006349579bf3561a82e997002e5716117/specification/security/grant_api_key/SecurityGrantApiKeyRequest.ts#L24-L75

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 {
	ApiKey     string `json:"api_key"`
	Encoded    string `json:"encoded"`
	Expiration *int64 `json:"expiration,omitempty"`
	Id         string `json:"id"`
	Name       string `json:"name"`
}

Response holds the response body struct for the package grantapikey

https://github.com/elastic/elasticsearch-specification/blob/5fea44e006349579bf3561a82e997002e5716117/specification/security/grant_api_key/SecurityGrantApiKeyResponse.ts#L23-L31

func NewResponse

func NewResponse() *Response

NewResponse returns a Response