userauthadminapi

Documentation

Overview

Package userauthadminapi contains the logic required to manage a user's authentication settings, such as API keys.

Index

• func DeleteKey(params DeleteKeyParams) error
• func GetKey(params GetKeyParams) (*models.APIKeyResponse, error)
• func ListKeys(params ListKeysParams) (*models.APIKeysResponse, error)
• type DeleteKeyParams
  • func (params DeleteKeyParams) Validate() error
• type GetKeyParams
  • func (params GetKeyParams) Validate() error
• type ListKeysParams
  • func (params ListKeysParams) Validate() error

Functions

func DeleteKey

func DeleteKey(params DeleteKeyParams) error

DeleteKey deletes a user's API Key.

func GetKey

func GetKey(params GetKeyParams) (*models.APIKeyResponse, error)

GetKey returns the API key details for the specified key and user id.

func ListKeys

func ListKeys(params ListKeysParams) (*models.APIKeysResponse, error)

ListKeys returns the API keys for either the specified user or all the platform users

Types

type DeleteKeyParams

type DeleteKeyParams struct {
	*api.API

	ID     string
	UserID string
}

DeleteKeyParams is consumed by DeleteKey

func (DeleteKeyParams) Validate

func (params DeleteKeyParams) Validate() error

Validate ensures the parameters are usable by the consuming function.

type GetKeyParams

type GetKeyParams struct {
	*api.API

	ID     string
	UserID string
}

GetKeyParams is consumed by GetKey

func (GetKeyParams) Validate

func (params GetKeyParams) Validate() error

Validate ensures the parameters are usable by the consuming function.

type ListKeysParams

type ListKeysParams struct {
	*api.API

	UserID string
	All    bool
}

ListKeysParams is consumed by ListKeys

func (ListKeysParams) Validate

func (params ListKeysParams) Validate() error

Validate ensures the parameters are usable by the consuming function.