What are Target Settings?
Target settings determine:- How a Target appears to your tenants
- How you and your tenants authenticate to the Target
- The underling taps and targets that your Target uses
Example Target Settings
Understanding the Target Fields
id
The id
field is a unique identifier for the Target. It is used internally to reference the Target and should be unique across all Targets.
label
The label
field is a human-readable name for the Target. This is the name that will be displayed in the user interface.
icon
The icon
field is a URL to an image that represents the Target. This icon will be displayed in the user interface alongside the Target’s label.
tags
The tags
field is an array of strings that categorize the Target. These tags can be used to filter and search for Targets.
domain
The domain
field specifies the primary domain associated with the Target. This is typically the domain of the service the Target integrates with.
type
The type
field specifies the authentication method used by the Target. Accepted values are oauth
and api
isForked
The isForked
field indicates whether this Target has been modified from the default Hotglue Target settings.
install_uri
The install_uri
field can be used to overwrite the default git repo that the Target will be installed from:
install_uri
for particular tenants by instead using:
is_private_repo
The is_private_repo
field tells hotglue to use your configured git access token when installing your Target.
formattable_fields
The formattable_fields
flag allows you to set a list of config flags that can be used as variables for your auth URLs.
auth_url
when completing the OAuth flow:
connect_ui_params
are used as formattable_fields
by default.