iam

Documentation

Overview

Package iam contains code for exporting identity access manager configuration

Index

• Variables
• func CmdCreateIAM(_ *cli.Context) error
• func CmdCreateIAMAll(c *cli.Context) error
• func CmdCreateIAMAllowlist(c *cli.Context) error
• func CmdCreateIAMGroup(c *cli.Context) error
• func CmdCreateIAMRole(c *cli.Context) error
• func CmdCreateIAMUser(c *cli.Context) error
• type TFAllowlist
• type TFCIDRBlock
• type TFData
• type TFGroup
• type TFRole
• type TFUser
• type TFUserBasicInfo
• type TFUserNotifications

Variables

var (

	// ErrFetchingUsers is returned when fetching users fails
	ErrFetchingUsers = errors.New("unable to fetch users under this account")
	// ErrFetchingGroups is returned when fetching groups fails
	ErrFetchingGroups = errors.New("unable to fetch groups under this account")
	// ErrFetchingRoles is returned when fetching roles fails
	ErrFetchingRoles = errors.New("unable to fetch roles under this account")
	// ErrFetchingCIDRBlocks is returned when fetching CIDR blocks fails
	ErrFetchingCIDRBlocks = errors.New("unable to fetch cidr blocks under this account")
	// ErrFetchingIPAllowlistStatus is returned when fetching IP allowlist status fails
	ErrFetchingIPAllowlistStatus = errors.New("unable to fetch ip allowlist status for this account")
	// ErrFetchingUsersWithinGroup is returned when fetching users within group fails
	ErrFetchingUsersWithinGroup = errors.New("unable to fetch users within group")
	// ErrFetchingRolesWithinGroup is returned when fetching roles within group fails
	ErrFetchingRolesWithinGroup = errors.New("unable to fetch roles within group")
	// ErrFetchingRole is returned when fetching role fails
	ErrFetchingRole = errors.New("unable to fetch role by role_id")
	// ErrFetchingUser is returned when fetching user fails
	ErrFetchingUser = errors.New("unable to fetch user by email")
	// ErrUserNotExist is returned when user does not exist
	ErrUserNotExist = errors.New("user does not exist with given email")
	// ErrMarshalUserAuthGrants is returned when marshal user auth grants failed
	ErrMarshalUserAuthGrants = errors.New("unable to marshal AuthGrants ")
)

Functions

func CmdCreateIAM

func CmdCreateIAM(_ *cli.Context) error

CmdCreateIAM is an entrypoint to create-iam command. This is only for action validation purpose

func CmdCreateIAMAll

func CmdCreateIAMAll(c *cli.Context) error

CmdCreateIAMAll is an entrypoint to create-iam all command

func CmdCreateIAMAllowlist

func CmdCreateIAMAllowlist(c *cli.Context) error

CmdCreateIAMAllowlist is an entrypoint to create-iam allowlist command

func CmdCreateIAMGroup

func CmdCreateIAMGroup(c *cli.Context) error

CmdCreateIAMGroup is an entrypoint to create-iam group command

func CmdCreateIAMRole

func CmdCreateIAMRole(c *cli.Context) error

CmdCreateIAMRole is an entrypoint to create-iam role command

func CmdCreateIAMUser

func CmdCreateIAMUser(c *cli.Context) error

CmdCreateIAMUser is an entrypoint to create-iam user command

Types

type TFAllowlist

type TFAllowlist struct {
	CIDRBlocks []TFCIDRBlock
	Enabled    bool
}

TFAllowlist represents iam allowlist data used in templates

type TFCIDRBlock

type TFCIDRBlock struct {
	CIDRBlockID int64
	CIDRBlock   string
	Enabled     bool
	Comments    *string
}

TFCIDRBlock represent iam cidr blocks data used in templates

type TFData

type TFData struct {
	TFUsers     []*TFUser
	TFRoles     []TFRole
	TFGroups    []TFGroup
	TFAllowlist TFAllowlist
	Section     string
	Subcommand  string
}

TFData represents the iam data used in templates

type TFGroup

type TFGroup struct {
	GroupID       int
	ParentGroupID int
	GroupName     string
}

TFGroup represents a group used in templates

type TFRole

type TFRole struct {
	RoleID          int64
	RoleName        string
	RoleDescription string
	GrantedRoles    []int
}

TFRole represents a role used in templates

type TFUser

type TFUser struct {
	TFUserBasicInfo
	IsLocked          bool
	AuthGrants        string
	UserNotifications TFUserNotifications
}

TFUser represents the user data used in templates

type TFUserBasicInfo

type TFUserBasicInfo struct {
	ID                       string
	FirstName                string
	LastName                 string
	Email                    string
	Country                  string
	Phone                    string
	TFAEnabled               bool
	ContactType              string
	JobTitle                 string
	TimeZone                 string
	SecondaryEmail           string
	MobilePhone              string
	Address                  string
	City                     string
	State                    string
	ZipCode                  string
	PreferredLanguage        string
	SessionTimeOut           *int
	AdditionalAuthentication string
}

TFUserBasicInfo represents user basic info data used in templates

type TFUserNotifications

type TFUserNotifications struct {
	EnableEmailNotifications              bool
	APIClientCredentialExpiryNotification bool
	NewUserNotification                   bool
	PasswordExpiry                        bool
	Proactive                             []string
	Upgrade                               []string
}

TFUserNotifications represents a user's notifications