api_key

Documentation

Index

• Variables
• type ProductScope
• type ScopeFile
• type ScopesFromIDMagalu

Variables

var GetGroup = utils.NewLazyLoader(func() core.Grouper {
	return core.NewStaticGroup(
		core.DescriptorSpec{
			Name:    "api-key",
			Summary: "Manage your ID Magalu API keys",
			Description: `ID Magalu API Keys are used for authentication across various platforms (CLI, SDK, Terraform, API requests). An API key has three components:

API Key: Used for Magalu API, CLI, SDK, and Terraform authentication.
Key Pair ID: Used for Object Storage authentication.
Key Pair Secret: Works with Key Pair ID for Object Storage authentication.

The API Key authenticates with the main Magalu services, while the Key Pair ID and Secret are specifically for Object Storage. Using these components correctly allows secure interaction with Magalu services and resources.`,
		},
		func() []core.Descriptor {
			return []core.Descriptor{
				getCreate(),
				getGet(),
				getList(),
				getRevoke(),
			}
		},
	)
})

Types

type ProductScope

type ProductScope struct {
	UUID   string      `json:"uuid"`
	Name   string      `json:"name"`
	Scopes []ScopeFile `json:"scopes"`
}

type ScopeFile

type ScopeFile struct {
	UUID  string `json:"uuid"`
	Title string `json:"title"`
}

type ScopesFromIDMagalu

type ScopesFromIDMagalu []struct {
	UUID        string `json:"uuid"`
	Name        string `json:"name"`
	Icon        string `json:"icon"`
	APIProducts []struct {
		UUID   string `json:"uuid"`
		Name   string `json:"name"`
		Icon   string `json:"icon"`
		Scopes []struct {
			UUID  string `json:"uuid"`
			Title string `json:"title"`
		} `json:"scopes"`
	} `json:"api_products"`
}