organization

Documentation

Index

• func TierTypeChoices() []string
• type Handler
• type OrganizationAuthenticationConfigGetOut
• type OrganizationAuthenticationConfigUpdateIn
• type OrganizationAuthenticationConfigUpdateOut
• type OrganizationGetOut
• type OrganizationHandler
  • func NewHandler(doer doer) OrganizationHandler
  • func (h *OrganizationHandler) OrganizationAuthenticationConfigGet(ctx context.Context, organizationId string) (*OrganizationAuthenticationConfigGetOut, error)
  • func (h *OrganizationHandler) OrganizationAuthenticationConfigUpdate(ctx context.Context, organizationId string, ...) (*OrganizationAuthenticationConfigUpdateOut, error)
  • func (h *OrganizationHandler) OrganizationGet(ctx context.Context, organizationId string) (*OrganizationGetOut, error)
  • func (h *OrganizationHandler) OrganizationUpdate(ctx context.Context, organizationId string, in *OrganizationUpdateIn) (*OrganizationUpdateOut, error)
  • func (h *OrganizationHandler) UserOrganizationCreate(ctx context.Context, in *UserOrganizationCreateIn) (*UserOrganizationCreateOut, error)
  • func (h *OrganizationHandler) UserOrganizationsList(ctx context.Context) ([]OrganizationOut, error)
• type OrganizationOut
• type OrganizationUpdateIn
• type OrganizationUpdateOut
• type TierType
• type UserOrganizationCreateIn
• type UserOrganizationCreateOut

Functions

func TierTypeChoices

func TierTypeChoices() []string

Types

type Handler

type Handler interface {
	// OrganizationAuthenticationConfigGet retrieve authentication configuration
	// GET /v1/organization/{organization_id}/config/authentication
	// https://api.aiven.io/doc/#tag/Organizations/operation/OrganizationAuthenticationConfigGet
	OrganizationAuthenticationConfigGet(ctx context.Context, organizationId string) (*OrganizationAuthenticationConfigGetOut, error)

	// OrganizationAuthenticationConfigUpdate update authentication configuration
	// PATCH /v1/organization/{organization_id}/config/authentication
	// https://api.aiven.io/doc/#tag/Organizations/operation/OrganizationAuthenticationConfigUpdate
	OrganizationAuthenticationConfigUpdate(ctx context.Context, organizationId string, in *OrganizationAuthenticationConfigUpdateIn) (*OrganizationAuthenticationConfigUpdateOut, error)

	// OrganizationGet get information about an organization
	// GET /v1/organization/{organization_id}
	// https://api.aiven.io/doc/#tag/Organizations/operation/OrganizationGet
	OrganizationGet(ctx context.Context, organizationId string) (*OrganizationGetOut, error)

	// OrganizationUpdate update organization's details
	// PATCH /v1/organization/{organization_id}
	// https://api.aiven.io/doc/#tag/Organizations/operation/OrganizationUpdate
	OrganizationUpdate(ctx context.Context, organizationId string, in *OrganizationUpdateIn) (*OrganizationUpdateOut, error)

	// UserOrganizationCreate create an organization
	// POST /v1/organizations
	// https://api.aiven.io/doc/#tag/Organizations/operation/UserOrganizationCreate
	UserOrganizationCreate(ctx context.Context, in *UserOrganizationCreateIn) (*UserOrganizationCreateOut, error)

	// UserOrganizationsList list organizations the user belongs to
	// GET /v1/organizations
	// https://api.aiven.io/doc/#tag/Organizations/operation/UserOrganizationsList
	UserOrganizationsList(ctx context.Context) ([]OrganizationOut, error)
}

type OrganizationAuthenticationConfigGetOut

type OrganizationAuthenticationConfigGetOut struct {
	OauthEnabled                           *bool `json:"oauth_enabled,omitempty"`
	PasswordAuthEnabled                    *bool `json:"password_auth_enabled,omitempty"`
	PersonalTokensEnabled                  *bool `json:"personal_tokens_enabled,omitempty"`
	PersonalTokensRequireAllowedAuthMethod *bool `json:"personal_tokens_require_allowed_auth_method,omitempty"`
	SamlAllowExternal                      *bool `json:"saml_allow_external,omitempty"`
	SamlEnabled                            *bool `json:"saml_enabled,omitempty"`
	TwoFactorRequired                      *bool `json:"two_factor_required,omitempty"`
}

type OrganizationAuthenticationConfigUpdateIn

type OrganizationAuthenticationConfigUpdateIn struct {
	OauthEnabled                           *bool `json:"oauth_enabled,omitempty"`
	PasswordAuthEnabled                    *bool `json:"password_auth_enabled,omitempty"`
	PersonalTokensEnabled                  *bool `json:"personal_tokens_enabled,omitempty"`
	PersonalTokensRequireAllowedAuthMethod *bool `json:"personal_tokens_require_allowed_auth_method,omitempty"`
	SamlAllowExternal                      *bool `json:"saml_allow_external,omitempty"`
	SamlEnabled                            *bool `json:"saml_enabled,omitempty"`
	TwoFactorRequired                      *bool `json:"two_factor_required,omitempty"`
}

type OrganizationAuthenticationConfigUpdateOut

type OrganizationAuthenticationConfigUpdateOut struct {
	OauthEnabled                           *bool `json:"oauth_enabled,omitempty"`
	PasswordAuthEnabled                    *bool `json:"password_auth_enabled,omitempty"`
	PersonalTokensEnabled                  *bool `json:"personal_tokens_enabled,omitempty"`
	PersonalTokensRequireAllowedAuthMethod *bool `json:"personal_tokens_require_allowed_auth_method,omitempty"`
	SamlAllowExternal                      *bool `json:"saml_allow_external,omitempty"`
	SamlEnabled                            *bool `json:"saml_enabled,omitempty"`
	TwoFactorRequired                      *bool `json:"two_factor_required,omitempty"`
}

type OrganizationGetOut

type OrganizationGetOut struct {
	AccountId                    string    `json:"account_id"`
	CreateTime                   time.Time `json:"create_time"`
	DefaultGovernanceUserGroupId string    `json:"default_governance_user_group_id,omitempty"`
	OrganizationId               string    `json:"organization_id"`
	OrganizationName             string    `json:"organization_name"`
	Tier                         TierType  `json:"tier"`
	UpdateTime                   time.Time `json:"update_time"`
}

type OrganizationHandler

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

func NewHandler

func NewHandler(doer doer) OrganizationHandler

func (*OrganizationHandler) OrganizationAuthenticationConfigGet

func (h *OrganizationHandler) OrganizationAuthenticationConfigGet(ctx context.Context, organizationId string) (*OrganizationAuthenticationConfigGetOut, error)

func (*OrganizationHandler) OrganizationAuthenticationConfigUpdate

func (h *OrganizationHandler) OrganizationAuthenticationConfigUpdate(ctx context.Context, organizationId string, in *OrganizationAuthenticationConfigUpdateIn) (*OrganizationAuthenticationConfigUpdateOut, error)

func (*OrganizationHandler) OrganizationGet

func (h *OrganizationHandler) OrganizationGet(ctx context.Context, organizationId string) (*OrganizationGetOut, error)

func (*OrganizationHandler) OrganizationUpdate

func (h *OrganizationHandler) OrganizationUpdate(ctx context.Context, organizationId string, in *OrganizationUpdateIn) (*OrganizationUpdateOut, error)

func (*OrganizationHandler) UserOrganizationCreate

func (h *OrganizationHandler) UserOrganizationCreate(ctx context.Context, in *UserOrganizationCreateIn) (*UserOrganizationCreateOut, error)

func (*OrganizationHandler) UserOrganizationsList

func (h *OrganizationHandler) UserOrganizationsList(ctx context.Context) ([]OrganizationOut, error)

type OrganizationOut

type OrganizationOut struct {
	AccountId                    string    `json:"account_id"`
	CreateTime                   time.Time `json:"create_time"`
	DefaultGovernanceUserGroupId string    `json:"default_governance_user_group_id,omitempty"`
	OrganizationId               string    `json:"organization_id"`
	OrganizationName             string    `json:"organization_name"`
	Tier                         TierType  `json:"tier"`
	UpdateTime                   time.Time `json:"update_time"`
}

type OrganizationUpdateIn

type OrganizationUpdateIn struct {
	DefaultGovernanceUserGroupId string   `json:"default_governance_user_group_id,omitempty"`
	KafkaGovernanceEnabled       *bool    `json:"kafka_governance_enabled,omitempty"`
	Name                         string   `json:"name,omitempty"`
	Tier                         TierType `json:"tier,omitempty"`
}

type OrganizationUpdateOut

type OrganizationUpdateOut struct {
	AccountId                    string    `json:"account_id"`
	CreateTime                   time.Time `json:"create_time"`
	DefaultGovernanceUserGroupId string    `json:"default_governance_user_group_id,omitempty"`
	OrganizationId               string    `json:"organization_id"`
	OrganizationName             string    `json:"organization_name"`
	Tier                         TierType  `json:"tier"`
	UpdateTime                   time.Time `json:"update_time"`
}

type TierType

type TierType string

const (
	TierTypeBusiness TierType = "business"
	TierTypePersonal TierType = "personal"
)

type UserOrganizationCreateIn

type UserOrganizationCreateIn struct {
	OrganizationName      string   `json:"organization_name"`
	PrimaryBillingGroupId string   `json:"primary_billing_group_id,omitempty"`
	Tier                  TierType `json:"tier"`
}

type UserOrganizationCreateOut

type UserOrganizationCreateOut struct {
	AccountId                    string    `json:"account_id"`
	CreateTime                   time.Time `json:"create_time"`
	DefaultGovernanceUserGroupId string    `json:"default_governance_user_group_id,omitempty"`
	OrganizationId               string    `json:"organization_id"`
	OrganizationName             string    `json:"organization_name"`
	Tier                         TierType  `json:"tier"`
	UpdateTime                   time.Time `json:"update_time"`
}