organizationgovernance

package
v0.115.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Aug 12, 2025 License: Apache-2.0 Imports: 5 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func AccessTypeChoices

func AccessTypeChoices() []string

func OperationTypeChoices

func OperationTypeChoices() []string

func OrganizationGovernanceAccessListCursor added in v0.104.0

func OrganizationGovernanceAccessListCursor(cursor string) [2]string

OrganizationGovernanceAccessListCursor Pagination cursor

func OrganizationGovernanceAccessListLimit added in v0.104.0

func OrganizationGovernanceAccessListLimit(limit int) [2]string

OrganizationGovernanceAccessListLimit Limit results to this number

func OrganizationGovernanceAccessListOwnerUserGroupId added in v0.104.0

func OrganizationGovernanceAccessListOwnerUserGroupId(ownerUserGroupId string) [2]string

OrganizationGovernanceAccessListOwnerUserGroupId Filter by owner user group ID

func OrganizationGovernanceAccessListResourceName added in v0.104.0

func OrganizationGovernanceAccessListResourceName(resourceName string) [2]string

OrganizationGovernanceAccessListResourceName Filter by resource name

func PatternTypeChoices

func PatternTypeChoices() []string

func PermissionTypeChoices

func PermissionTypeChoices() []string

func ResourceTypeChoices

func ResourceTypeChoices() []string

Types

type AccesOut added in v0.104.0

type AccesOut struct {
	AccessData          AccessDataOut `json:"access_data"`                   // access type specific data
	AccessId            string        `json:"access_id"`                     // The ID of the access
	AccessName          string        `json:"access_name"`                   // Label to describe the access
	AccessType          AccessType    `json:"access_type"`                   // An enumeration.
	CreateTime          time.Time     `json:"create_time"`                   // Timestamp of when access was created
	CreatedBy           string        `json:"created_by"`                    // The user that created the access
	CredentialsConsumed bool          `json:"credentials_consumed"`          // Wether the credentials have been reviewed
	CredentialsUserId   string        `json:"credentials_user_id"`           // The user that created is assigned to review the credentials
	OwnerUserGroupId    *string       `json:"owner_user_group_id,omitempty"` // The ID of the group that will own the access
}

type AccessDataIn

type AccessDataIn struct {
	Acls        []AclIn `json:"acls"`
	ProjectName string  `json:"project_name"` // Project name
	ServiceName string  `json:"service_name"` // Service name
	Username    string  `json:"username"`     // The service username assigned to the access
}

AccessDataIn access type specific data

type AccessDataOut

type AccessDataOut struct {
	Acls        []AclOut `json:"acls"`
	ProjectName string   `json:"project_name"` // Project name
	ServiceName string   `json:"service_name"` // Service name
	Username    string   `json:"username"`     // The service username assigned to the access
}

AccessDataOut access type specific data

type AccessType

type AccessType string
const (
	AccessTypeKafka AccessType = "KAFKA"
)

type AclIn

type AclIn struct {
	Host           string         `json:"host"`            // Acl host
	Operation      OperationType  `json:"operation"`       // An enumeration.
	PermissionType PermissionType `json:"permission_type"` // An enumeration.
	ResourceName   string         `json:"resource_name"`   // Acl resource name
	ResourceType   ResourceType   `json:"resource_type"`   // An enumeration.
}

type AclOut

type AclOut struct {
	Host           string         `json:"host"`            // Acl host
	Id             string         `json:"id"`              // Acl ID
	Operation      OperationType  `json:"operation"`       // An enumeration.
	PatternType    PatternType    `json:"pattern_type"`    // An enumeration.
	PermissionType PermissionType `json:"permission_type"` // An enumeration.
	Principal      string         `json:"principal"`       // Acl principal
	ResourceName   string         `json:"resource_name"`   // Acl resource name
	ResourceType   ResourceType   `json:"resource_type"`   // An enumeration.
}

type Handler

type Handler interface {
	// OrganizationGovernanceAccessCreate [EXPERIMENTAL] Create organization access
	// POST /v1/organization/{organization_id}/governance/access
	// https://api.aiven.io/doc/#tag/Organizations/operation/OrganizationGovernanceAccessCreate
	OrganizationGovernanceAccessCreate(ctx context.Context, organizationId string, in *OrganizationGovernanceAccessCreateIn) (*OrganizationGovernanceAccessCreateOut, error)

	// OrganizationGovernanceAccessDelete [EXPERIMENTAL] Delete organization access
	// DELETE /v1/organization/{organization_id}/governance/access/{access_id}
	// https://api.aiven.io/doc/#tag/Organizations/operation/OrganizationGovernanceAccessDelete
	OrganizationGovernanceAccessDelete(ctx context.Context, organizationId string, accessId string) (string, error)

	// OrganizationGovernanceAccessGet [EXPERIMENTAL] Get organization access details
	// GET /v1/organization/{organization_id}/governance/access/{access_id}
	// https://api.aiven.io/doc/#tag/Organizations/operation/OrganizationGovernanceAccessGet
	OrganizationGovernanceAccessGet(ctx context.Context, organizationId string, accessId string) (*OrganizationGovernanceAccessGetOut, error)

	// OrganizationGovernanceAccessList [EXPERIMENTAL] List access for organization
	// GET /v1/organization/{organization_id}/governance/access
	// https://api.aiven.io/doc/#tag/Organizations/operation/OrganizationGovernanceAccessList
	OrganizationGovernanceAccessList(ctx context.Context, organizationId string, query ...[2]string) (*OrganizationGovernanceAccessListOut, error)
}

type OperationType

type OperationType string
const (
	OperationTypeRead  OperationType = "Read"
	OperationTypeWrite OperationType = "Write"
)

type OrganizationGovernanceAccessCreateIn

type OrganizationGovernanceAccessCreateIn struct {
	AccessData       AccessDataIn `json:"access_data"`                   // access type specific data
	AccessName       string       `json:"access_name"`                   // Label to describe the access
	AccessType       AccessType   `json:"access_type"`                   // An enumeration.
	OwnerUserGroupId *string      `json:"owner_user_group_id,omitempty"` // The ID of the group that will own the access
}

OrganizationGovernanceAccessCreateIn OrganizationGovernanceAccessCreateRequestBody

type OrganizationGovernanceAccessCreateOut

type OrganizationGovernanceAccessCreateOut struct {
	AccessData          AccessDataOut `json:"access_data"`                   // access type specific data
	AccessId            string        `json:"access_id"`                     // The ID of the access
	AccessName          string        `json:"access_name"`                   // Label to describe the access
	AccessType          AccessType    `json:"access_type"`                   // An enumeration.
	CreateTime          time.Time     `json:"create_time"`                   // Timestamp of when access was created
	CreatedBy           string        `json:"created_by"`                    // The user that created the access
	CredentialsConsumed bool          `json:"credentials_consumed"`          // Wether the credentials have been reviewed
	CredentialsUserId   string        `json:"credentials_user_id"`           // The user that created is assigned to review the credentials
	OwnerUserGroupId    *string       `json:"owner_user_group_id,omitempty"` // The ID of the group that will own the access
}

OrganizationGovernanceAccessCreateOut OrganizationGovernanceAccess

type OrganizationGovernanceAccessGetOut

type OrganizationGovernanceAccessGetOut struct {
	AccessData          AccessDataOut `json:"access_data"`                   // access type specific data
	AccessId            string        `json:"access_id"`                     // The ID of the access
	AccessName          string        `json:"access_name"`                   // Label to describe the access
	AccessType          AccessType    `json:"access_type"`                   // An enumeration.
	CreateTime          time.Time     `json:"create_time"`                   // Timestamp of when access was created
	CreatedBy           string        `json:"created_by"`                    // The user that created the access
	CredentialsConsumed bool          `json:"credentials_consumed"`          // Wether the credentials have been reviewed
	CredentialsUserId   string        `json:"credentials_user_id"`           // The user that created is assigned to review the credentials
	OwnerUserGroupId    *string       `json:"owner_user_group_id,omitempty"` // The ID of the group that will own the access
}

OrganizationGovernanceAccessGetOut OrganizationGovernanceAccess

type OrganizationGovernanceAccessListOut added in v0.104.0

type OrganizationGovernanceAccessListOut struct {
	Access     []AccesOut `json:"access"`
	First      *string    `json:"first,omitempty"`       // First page
	Last       *string    `json:"last,omitempty"`        // Last page
	Next       *string    `json:"next,omitempty"`        // Next page
	Prev       *string    `json:"prev,omitempty"`        // Previous page
	TotalCount *int       `json:"total_count,omitempty"` // Total number of results
}

OrganizationGovernanceAccessListOut OrganizationGovernanceAccessListResponse

type OrganizationGovernanceHandler

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

func NewHandler

func NewHandler(doer doer) OrganizationGovernanceHandler

func (*OrganizationGovernanceHandler) OrganizationGovernanceAccessCreate

func (*OrganizationGovernanceHandler) OrganizationGovernanceAccessDelete

func (h *OrganizationGovernanceHandler) OrganizationGovernanceAccessDelete(ctx context.Context, organizationId string, accessId string) (string, error)

func (*OrganizationGovernanceHandler) OrganizationGovernanceAccessGet

func (h *OrganizationGovernanceHandler) OrganizationGovernanceAccessGet(ctx context.Context, organizationId string, accessId string) (*OrganizationGovernanceAccessGetOut, error)

func (*OrganizationGovernanceHandler) OrganizationGovernanceAccessList added in v0.104.0

func (h *OrganizationGovernanceHandler) OrganizationGovernanceAccessList(ctx context.Context, organizationId string, query ...[2]string) (*OrganizationGovernanceAccessListOut, error)

type PatternType

type PatternType string
const (
	PatternTypeLiteral PatternType = "LITERAL"
)

type PermissionType

type PermissionType string
const (
	PermissionTypeAllow PermissionType = "ALLOW"
)

type ResourceType

type ResourceType string
const (
	ResourceTypeTopic ResourceType = "Topic"
)

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL