cli

package

Go to main page

Versions in this module

v2

v2.11.0

Jul 14, 2025

Changes in this version

type ActionProperty

+ Disabled any

v2.10.3

Jul 13, 2025

v2.10.2

Jul 6, 2025

v2.10.1

Jul 2, 2025

v2.10.0

Jun 22, 2025

v2.9.0

Jun 19, 2025

Changes in this version

+ type ActionTitle struct

+ Description *string

+ Title string

+ Visible any

type ActionUserInputs

+ Titles map[string]ActionTitle

v2.8.2

Jun 15, 2025

Changes in this version

type BlueprintProperty

+ UnknownFields map[string]any

+ func (bp *BlueprintProperty) UnmarshalJSON(data []byte) error

+ func (bp BlueprintProperty) MarshalJSON() ([]byte, error)

v2.8.1

Jun 9, 2025

v2.8.0

Jun 9, 2025

Changes in this version

type PortClient

+ BlueprintPropertyTypeChangeProtection bool

type PortProviderModel

+ BlueprintPropertyTypeChangeProtection types.Bool

v2.7.1

May 6, 2025

v2.7.0

May 5, 2025

v2.6.2

Apr 20, 2025

v2.6.1

Apr 17, 2025

v2.6.0

Apr 15, 2025

Changes in this version

type PortClient

+ JSONEscapeHTML bool

type PortProviderModel

+ JSONEscapeHTML types.Bool

v2.5.1

Apr 1, 2025

v2.5.0

Mar 26, 2025

Changes in this version

+ const FeatureFlagUsersAndTeamsV2

+ const MissingTeamEntityError

+ type Organization struct

+ FeatureFlags []string

+ Name string

type PortBody

+ Organization *Organization

type PortClient

+ func (c *PortClient) FeatureFlags(ctx context.Context) ([]string, error)

+ func (c *PortClient) HasFeatureFlags(ctx context.Context, flags ...string) (bool, error)

+ func (c *PortClient) ReadOrganization(ctx context.Context) (*Organization, int, error)

+ type PortTeam struct

+ CreatedAt *time.Time

+ Description *string

+ Name string

+ Provider string

+ UpdatedAt *time.Time

+ Users []string

type Team

+ Identifier *string

v2.4.3

Mar 20, 2025

v2.4.2

Mar 20, 2025

v2.4.1

Mar 18, 2025

v2.4.0

Mar 9, 2025

Changes in this version

type Mappings

+ Operation any

v2.3.0

Feb 23, 2025

v2.2.2

Feb 20, 2025

Changes in this version

type Entity

+ Icon string

v2.2.1

Feb 17, 2025

Changes in this version

+ type Folder struct

+ After string

+ Identifier string

+ Parent string

+ Sidebar string

+ Title string

type PortBody

+ Folder Folder

type PortClient

+ func (c *PortClient) CreateFolder(ctx context.Context, folder *Folder) (*Folder, error)

+ func (c *PortClient) DeleteFolder(ctx context.Context, folderId string) (int, error)

+ func (c *PortClient) GetFolder(ctx context.Context, id string) (*Folder, int, error)

+ func (c *PortClient) UpdateFolder(ctx context.Context, folder *Folder) (*Folder, error)

+ type SidebarDTO struct

+ Identifier string

+ Items []SidebarItemDTO

+ type SidebarFolderItem struct

+ Identifier string

+ Title string

+ type SidebarGetResponseDTO struct

+ Ok bool

+ Sidebar *SidebarDTO

+ type SidebarItemDTO struct

+ After string

+ Identifier string

+ Parent string

+ Sidebar string

+ SidebarType string

+ Title string

+ type SidebarLocation struct

+ After string

+ Parent string

+ Sidebar string

v2.2.0

Feb 11, 2025

Changes in this version

type PortClient

+ func (c *PortClient) ReadSystemBlueprintStructure(ctx context.Context, id string) (*Blueprint, int, error)

v2.1.8

Feb 9, 2025

Changes in this version

type Ownership

+ Title *string

v2.1.7

Jan 29, 2025

v2.1.6

Jan 26, 2025

Changes in this version

type Scorecard

+ Filter *Query

v2.1.5

Jan 22, 2025

Changes in this version

type Rule

+ Description string

v2.1.4

Jan 13, 2025

v2.1.3

Jan 8, 2025

Changes in this version

type Blueprint

+ Ownership *Ownership

+ type Ownership struct

+ Path *string

+ Type string

v2.1.2

Jan 7, 2025

v2.1.1

Dec 24, 2024

v2.1.0

Dec 8, 2024

v2.0.25

Dec 5, 2024

v2.0.24

Nov 6, 2024

v2.0.23

Sep 30, 2024

Changes in this version

type ActionUserInputs

+ Steps []Step

+ type Step = struct

+ Order []string

+ Title string

v2.0.22

Sep 26, 2024

v2.0.21

Sep 9, 2024

v2.0.20

Sep 8, 2024

Changes in this version

type ActionProperty

+ Sort *EntitiesSortModel

+ type EntitiesSortModel struct

+ Order string

+ Property string

v2.0.19

Sep 5, 2024

v2.0.18

Sep 1, 2024

Changes in this version

type Relation

+ Description *string

v2.0.17

Aug 27, 2024

Changes in this version

type TriggerEvent

+ ActionIdentifier *string

v2.0.16

Aug 5, 2024

v2.0.15

Aug 5, 2024

v2.0.14

Aug 4, 2024

v2.0.13

Jul 25, 2024

v2.0.12

Jul 17, 2024

Changes in this version

+ type Level struct

+ Color string

+ Title string

type Scorecard

+ Levels []Level

v2.0.11

Jun 30, 2024

v2.0.10

Jun 29, 2024

v2.0.9

Jun 20, 2024

v2.0.8

Jun 10, 2024

Changes in this version

type InvocationMethod

+ Mapping *MappingSchema

+ type MappingSchema struct

+ Icon *string

+ Identifier *string

+ Properties map[string]any

+ Relations map[string]any

+ Team any

+ Title *string

v2.0.7

Jun 6, 2024

Changes in this version

type Entity

+ Scorecards map[string]ScorecardModel

type PortClient

+ func (c *PortClient) Search(ctx context.Context, searchRequest *SearchRequestQuery) (*SearchResult, error)

+ type ScorecardModel struct

+ Level string

+ Rules []ScorecardRulesModel

+ type ScorecardRulesModel struct

+ Identifier string

+ Level string

+ Status string

+ type SearchEntityResult struct

+ Icon *string

+ Identifier string

+ Properties map[string]any

+ Relations map[string]any

+ Team []string

+ Title string

+ type SearchRequestQuery struct

+ AttachTitleToRelation *bool

+ Exclude []string

+ ExcludeCalculatedProperties *bool

+ Include []string

+ Query *map[string]any

+ type SearchResult struct

+ Entities []Entity

+ MatchingBlueprints []string

+ OK bool

v2.0.6

Jun 6, 2024

v2.0.5

Jun 4, 2024

Changes in this version

+ type Integration struct

+ ChangelogDestination *ChangelogDestination

+ Config *map[string]any

+ InstallationAppType *string

+ InstallationId string

+ Title string

+ Version string

type PortBody

+ Webhook Webhook

+ type PortBodyForIntegration struct

+ Integration Integration

+ OK bool

type PortClient

+ func (c *PortClient) CreateIntegration(ctx context.Context, integration *Integration) (*Integration, error)

+ func (c *PortClient) DeleteIntegration(ctx context.Context, id string) (int, error)

+ func (c *PortClient) GetIntegration(ctx context.Context, id string) (*Integration, error)

+ func (c *PortClient) UpdateIntegration(ctx context.Context, id string, integration *Integration) (*Integration, error)

v2.0.4

Jun 3, 2024

Changes in this version

type TriggerCondition

+ Rules []any

v2.0.3

May 20, 2024

Changes in this version

+ type AccessTokenResponse struct

+ AccessToken string

+ ExpiresIn int64

+ Ok bool

+ TokenType string

+ type Action struct

+ ApprovalNotification *ApprovalNotification

+ Description *string

+ ID string

+ Icon *string

+ Identifier string

+ InvocationMethod *InvocationMethod

+ Publish *bool

+ RequiredApproval *bool

+ Title *string

+ Trigger *Trigger

+ type ActionApprovePermissions struct

+ Policy *map[string]any

+ Roles []string

+ Teams []string

+ Users []string

+ type ActionExecutePermissions struct

+ OwnedByTeam *bool

+ Policy *map[string]any

+ Roles []string

+ Teams []string

+ Users []string

+ type ActionPermissions struct

+ Approve ActionApprovePermissions

+ Execute ActionExecutePermissions

+ type ActionProperty struct

+ Blueprint *string

+ Dataset *Dataset

+ Default any

+ DependsOn []string

+ Description *string

+ Encryption *string

+ Enum any

+ EnumColors map[string]string

+ Format *string

+ Icon *string

+ Identifier string

+ Items map[string]any

+ MaxItems *int

+ MaxLength *int

+ Maximum *float64

+ MinItems *int

+ MinLength *int

+ Minimum *float64

+ Pattern *string

+ Spec *string

+ SpecAuthentication *SpecAuthentication

+ Title *string

+ Type string

+ Visible any

+ type ActionUserInputs = struct

+ Order []string

+ Properties map[string]ActionProperty

+ Required any

+ type ApprovalNotification struct

+ Format *string

+ Type string

+ Url string

+ type Blueprint struct

+ AggregationProperties map[string]BlueprintAggregationProperty

+ CalculationProperties map[string]BlueprintCalculationProperty

+ ChangelogDestination *ChangelogDestination

+ Description *string

+ Icon *string

+ Identifier string

+ MirrorProperties map[string]BlueprintMirrorProperty

+ Relations map[string]Relation

+ Schema BlueprintSchema

+ TeamInheritance *TeamInheritance

+ Title string

+ type BlueprintAggregationProperty struct

+ CalculationSpec map[string]string

+ Description *string

+ Icon *string

+ Query any

+ Target string

+ Title *string

+ type BlueprintCalculationProperty struct

+ Calculation string

+ Colorized *bool

+ Colors map[string]string

+ Default any

+ Description *string

+ Format *string

+ Icon *string

+ Identifier string

+ Title *string

+ Type string

+ type BlueprintMirrorProperty struct

+ Identifier string

+ Path string

+ Title *string

+ type BlueprintPermissions struct

+ Entities BlueprintPermissionsEntities

+ type BlueprintPermissionsBlock struct

+ OwnedByTeam *bool

+ Roles []string

+ Teams []string

+ Users []string

+ type BlueprintPermissionsEntities struct

+ Register BlueprintPermissionsBlock

+ Unregister BlueprintPermissionsBlock

+ Update BlueprintPermissionsBlock

+ UpdateProperties BlueprintRolesOrPropertiesPermissionsBlock

+ UpdateRelations BlueprintRolesOrPropertiesPermissionsBlock

+ type BlueprintProperty struct

+ Blueprint *string

+ Default any

+ Description *string

+ Enum []any

+ EnumColors map[string]string

+ Format *string

+ Icon *string

+ Identifier string

+ Items map[string]any

+ MaxItems *int

+ MaxLength *int

+ Maximum *float64

+ MinItems *int

+ MinLength *int

+ Minimum *float64

+ Pattern *string

+ Spec *string

+ SpecAuthentication *SpecAuthentication

+ Title *string

+ Type string

+ type BlueprintRolesOrPropertiesPermissionsBlock map[string]BlueprintPermissionsBlock

+ type BlueprintSchema struct

+ Properties map[string]BlueprintProperty

+ Required []string

+ type ChangelogDestination struct

+ Agent *bool

+ Type string

+ Url string

+ type Dataset struct

+ Combinator string

+ Rules []DatasetRule

+ type DatasetRule struct

+ Blueprint *string

+ Operator string

+ Property *string

+ Value *DatasetValue

+ type DatasetValue struct

+ JqQuery string

+ type Entity struct

+ Blueprint string

+ Identifier string

+ Properties map[string]any

+ Relations map[string]any

+ Team []string

+ Title string

+ type EntityProperty struct

+ Icon *string

+ Identifier string

+ Properties map[string]string

+ Relations map[string]string

+ Team *string

+ Title *string

+ type InvocationMethod struct

+ Agent any

+ BlueprintIdentifier *string

+ Body any

+ Branch *string

+ DefaultRef *string

+ GroupName *string

+ Headers map[string]string

+ Icon *string

+ Identifier *string

+ Method *string

+ Org *string

+ Payload any

+ PipelineVariables map[string]any

+ ProjectName *string

+ Properties map[string]any

+ Relations map[string]any

+ Repo *string

+ ReportWorkflowStatus any

+ Synchronized any

+ Team any

+ Title *string

+ Type string

+ Url *string

+ Webhook *string

+ Workflow *string

+ WorkflowInputs map[string]any

+ type Mappings struct

+ Blueprint string

+ Entity *EntityProperty

+ Filter *string

+ ItemsToParse *string

+ type Meta struct

+ CreatedAt *time.Time

+ CreatedBy string

+ UpdatedAt *time.Time

+ UpdatedBy string

+ type Migration struct

+ Actor string

+ DeleteBlueprint bool

+ DeleteEntities bool

+ FailureCount int

+ Id string

+ Mapping any

+ SourceBlueprint string

+ Status string

+ SuccessCount int

+ type Option func(*PortClient)

+ func WithClientID(clientID string) Option

+ func WithHeader(key, val string) Option

+ func WithToken(token string) Option

+ type Page struct

+ After *string

+ Blueprint *string

+ Description *string

+ Icon *string

+ Identifier string

+ Locked *bool

+ Parent *string

+ Title *string

+ Type string

+ Widgets *[]map[string]any

+ type PagePermissions struct

+ Read PageReadPermissions

+ type PageReadPermissions struct

+ Roles []string

+ Teams []string

+ Users []string

+ type PortBlueprintPermissionsBody struct

+ BlueprintPermissions BlueprintPermissions

+ OK bool

+ type PortBody struct

+ Action Action

+ ActionPermissions ActionPermissions

+ Blueprint Blueprint

+ BlueprintPermissions Blueprint

+ Entity Entity

+ Integration Webhook

+ Migration Migration

+ MigrationId string

+ OK bool

+ Page Page

+ Scorecard Scorecard

+ Team Team

+ type PortBodyDelete struct

+ Ok bool

+ type PortClient struct

+ Client *resty.Client

+ ClientID string

+ Token string

+ func New(baseURL string, opts ...Option) (*PortClient, error)

+ func (c *PortClient) Authenticate(ctx context.Context, clientID, clientSecret string) (string, error)

+ func (c *PortClient) CreateAction(ctx context.Context, action *Action) (*Action, error)

+ func (c *PortClient) CreateBlueprint(ctx context.Context, b *Blueprint) (*Blueprint, error)

+ func (c *PortClient) CreateEntity(ctx context.Context, e *Entity, runID string) (*Entity, error)

+ func (c *PortClient) CreatePage(ctx context.Context, page *Page) (*Page, error)

+ func (c *PortClient) CreatePermissions(ctx context.Context, clientID string, scopes ...string) error

+ func (c *PortClient) CreateScorecard(ctx context.Context, blueprintID string, scorecard *Scorecard) (*Scorecard, error)

+ func (c *PortClient) CreateTeam(ctx context.Context, team *Team) (*Team, error)

+ func (c *PortClient) CreateWebhook(ctx context.Context, webhook *Webhook) (*Webhook, error)

+ func (c *PortClient) DeleteAction(ctx context.Context, actionID string) error

+ func (c *PortClient) DeleteBlueprint(ctx context.Context, id string) error

+ func (c *PortClient) DeleteBlueprintWithAllEntities(ctx context.Context, id string) (*string, error)

+ func (c *PortClient) DeleteEntity(ctx context.Context, id string, blueprint string) error

+ func (c *PortClient) DeletePage(ctx context.Context, pageId string) (int, error)

+ func (c *PortClient) DeleteScorecard(ctx context.Context, blueprintID string, scorecardID string) error

+ func (c *PortClient) DeleteTeam(ctx context.Context, teamName string) error

+ func (c *PortClient) DeleteWebhook(ctx context.Context, webhookID string) error

+ func (c *PortClient) GetActionPermissions(ctx context.Context, actionID string) (*ActionPermissions, int, error)

+ func (c *PortClient) GetBlueprintPermissions(ctx context.Context, blueprintID string) (*BlueprintPermissions, int, error)

+ func (c *PortClient) GetMigration(ctx context.Context, id string) (*Migration, error)

+ func (c *PortClient) GetPage(ctx context.Context, pageId string) (*Page, int, error)

+ func (c *PortClient) GetPagePermissions(ctx context.Context, pageID string) (*PagePermissions, int, error)

+ func (c *PortClient) ReadAction(ctx context.Context, id string) (*Action, int, error)

+ func (c *PortClient) ReadBlueprint(ctx context.Context, id string) (*Blueprint, int, error)

+ func (c *PortClient) ReadEntity(ctx context.Context, id string, blueprint string) (*Entity, int, error)

+ func (c *PortClient) ReadScorecard(ctx context.Context, blueprintID string, scorecardID string) (*Scorecard, int, error)

+ func (c *PortClient) ReadTeam(ctx context.Context, teamName string) (*Team, int, error)

+ func (c *PortClient) ReadWebhook(ctx context.Context, webhookID string) (*Webhook, int, error)

+ func (c *PortClient) UpdateAction(ctx context.Context, actionID string, action *Action) (*Action, error)

+ func (c *PortClient) UpdateActionPermissions(ctx context.Context, actionID string, permissions *ActionPermissions) (*ActionPermissions, error)

+ func (c *PortClient) UpdateBlueprint(ctx context.Context, b *Blueprint, id string) (*Blueprint, error)

+ func (c *PortClient) UpdateBlueprintPermissions(ctx context.Context, blueprintID string, permissions *BlueprintPermissions) (*BlueprintPermissions, error)

+ func (c *PortClient) UpdateEntity(ctx context.Context, id string, blueprint string, e *Entity, runID string) (*Entity, error)

+ func (c *PortClient) UpdatePage(ctx context.Context, pageId string, page *Page) (*Page, error)

+ func (c *PortClient) UpdatePagePermissions(ctx context.Context, pageID string, permissions *PagePermissions) (*PagePermissions, error)

+ func (c *PortClient) UpdateScorecard(ctx context.Context, blueprintID string, scorecardId string, ...) (*Scorecard, error)

+ func (c *PortClient) UpdateTeam(ctx context.Context, teamName string, team *Team) (*Team, error)

+ func (c *PortClient) UpdateWebhook(ctx context.Context, webhookID string, webhook *Webhook) (*Webhook, error)

+ type PortPagePermissionsBody struct

+ OK bool

+ PagePermissions PagePermissions

+ type PortProviderModel struct

+ BaseUrl types.String

+ ClientId types.String

+ Secret types.String

+ Token types.String

+ type PortTeamBody struct

+ OK bool

+ Team TeamPortBody

+ type Query struct

+ Combinator string

+ Conditions []any

+ type Relation struct

+ Identifier *string

+ Many *bool

+ Required *bool

+ Target *string

+ Title *string

+ type Rule struct

+ Identifier string

+ Level string

+ Query Query

+ Title string

+ type Scorecard struct

+ Blueprint string

+ Identifier string

+ Rules []Rule

+ Title string

+ type Security struct

+ RequestIdentifierPath *string

+ Secret *string

+ SignatureAlgorithm *string

+ SignatureHeaderName *string

+ SignaturePrefix *string

+ type SpecAuthentication struct

+ AuthorizationUrl string

+ ClientId string

+ TokenUrl string

+ type Team struct

+ CreatedAt *time.Time

+ Description *string

+ Name string

+ Provider string

+ UpdatedAt *time.Time

+ Users []string

+ type TeamInheritance struct

+ Path string

+ type TeamPortBody struct

+ CreatedAt *time.Time

+ Description *string

+ Name string

+ Provider string

+ UpdatedAt *time.Time

+ Users []TeamUserBody

+ type TeamUserBody struct

+ Email string

+ type Trigger struct

+ BlueprintIdentifier *string

+ Condition *TriggerCondition

+ Event *TriggerEvent

+ Operation *string

+ Type string

+ UserInputs *ActionUserInputs

+ type TriggerCondition struct

+ Combinator *string

+ Expressions []string

+ Type string

+ type TriggerEvent struct

+ BlueprintIdentifier *string

+ PropertyIdentifier *string

+ Type string

+ type Webhook struct

+ Description *string

+ Enabled *bool

+ Icon *string

+ Identifier string

+ Mappings []Mappings

+ Security *Security

+ Title *string

+ Url string

+ WebhookKey string

Other modules containing this package

github.com/port-labs/terraform-provider-port-labs

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