Skip to main content

Entity

Entity is an input type used to reference existing entities from the software catalog when triggering actions.

💡 Common entity usage

The entity input type can be used to reference any existing entity from the software catalog, for example:

  • Cloud regions
  • Clusters
  • Configurations

In the live demo self-service hub page, we can see the scaffold new service action whose Domain input is an entity input. 🎬

Entity input structure

The entity is represented by the unique entity format and the blueprint key that accompanies it, as shown in the following section:

{
"myEntityInput": {
"title": "My entity input",
"icon": "My icon",
"description": "My entity input",
"type": "string",
"format": "entity",
"blueprint": "myBlueprint"
}
}

Structure table

FieldDescriptionNotes
"format": "entity"Used to specify that this is an entity inputRequired
"blueprint": "myBlueprint"Used to specify the identifier of the target blueprint that entities will be queried fromRequired. Must specify an existing blueprint identifier

API definition

{
"myEntityInput": {
"title": "My entity input",
"icon": "My icon",
"description": "My entity input",
"type": "string",
"format": "entity",
"blueprint": "myBlueprint"
}
}

Check out Port's API reference to learn more.

Terraform definition

resource "port_action" "myAction" {
# ...action properties
user_properties = {
string_props = {
"myEntityInput" = {
title = "My entity input"
description = "My entity input"
format = "entity"
blueprint = "myBlueprint"
}
}
}
}