userauthapi

package

v1.2.30 Latest Latest Go to latest Published: Feb 19, 2024 License: Apache-2.0 Imports: 7 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

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

This section is empty.

This section is empty.

func CreateKey(params CreateKeyParams) (*models.APIKeyResponse, error)

CreateKey creates a new API key for the current user.

func DeleteKey(params DeleteKeyParams) error

DeleteKey deletes an existing API key for the current user.

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

GetKey returns API key details for the current user.

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

ListKeys returns the available API keys for the current user.

type CreateKeyParams struct {
	*api.API

	Description string
}

CreateKeyParams is consumed by CreateKey

func (params CreateKeyParams) Validate() error

Validate ensures the parameters are usable by the consuming function.

type DeleteKeyParams struct {
	*api.API

	ID string
}

DeleteKeyParams is consumed by DeleteKey

func (params DeleteKeyParams) Validate() error

Validate ensures the parameters are usable by the consuming function.

type GetKeyParams struct {
	*api.API

	ID string
}

GetKeyParams is consumed by GetKey

func (params GetKeyParams) Validate() error

Validate ensures the parameters are usable by the consuming function.

type ListKeysParams struct {
	*api.API
}

ListKeysParams is consumed by ListKeys

func (params ListKeysParams) Validate() error

Validate ensures the parameters are usable by the consuming function.

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