Skip to main content

Connection Object

Represents a Connection that is available on a Component.

Return fields

allowRemove (Boolean!)

Specifies whether the signed-in User can remove the Connection.

allowUpdate (Boolean!)

Specifies whether the signed-in User can update the Connection.

comments (String)

Additional notes about the Connection.

component (Component!)

The Component to which this Connection is associated.

default (Boolean!)

Specifies this Connection is the default for the Component.

iconUrl (String)

The URL that specifies where the Connection icon exists.

id (ID!)

The ID of the object

inputs (InputFieldConnection!)

The Connection to which this InputField is associated, if any.

key (String!)

A string which uniquely identifies the Connection in the context of the Action.

label (String!)

The name of the Connection.

oauth2Type (ConnectionOauth2Type)

The OAuth2 flow type, if any, for this Connection.

onPremiseAvailable (Boolean!)

If true, this connection can be used with an on-premise resource.

order (Int)

Ordering of the Connection.

templates (ConnectionTemplateConnection!)

The Connection from which this template is structured.