Magidoc

HttpConnection
Object

HTTP connection configuration for external API access. Note: Auth values are stored encrypted and never exposed via GraphQL.

Fields

#

_id

ID !
Non-null

name

Non-null

description

Non-null

origin

Non-null

documentationUrl

headerKeys

queryParamKeys

bodyParamKeys

enabled

Non-null

trusted

Whether an unattended Buzz run may send a GET to this connection without asking first.

createdAt

Non-null

modifiedAt

Non-null

createdBy

ID !
Non-null

modifiedBy

ID !
Non-null

ownerId

ID !
Non-null

The current transferable owner of the connection; createdBy is the author and never moves.

authType

Authentication type: 'headers' (default), 'oauth', 'session' (cookie-based login like SAP B1), or 'sftp' (an SFTP server that Buzz snippets read with buzz.sftp; never an HTTP API). Legacy connections without this field are treated as 'headers'.

nativeProvider

Hive-managed OAuth app id when this connection uses a native provider such as Google or Microsoft. Client credentials are not user-supplied.

workspaceId

Workspace this connection belongs to. May be null for legacy connections created before workspace-level sharing.

sharingType

Sharing scope - standard Hive pattern. 'me' = only creator, 'custom' = specific users, 'everyone' = all workspace members. Defaults to 'me' for legacy connections without this field.

sharedWith

[ID !]

User IDs to share with (when sharingType = 'custom'). Empty array for legacy connections without this field.

oauthScopes

oauthAuthorizationUrl

oauthTokenUrl

oauthClientId

Resolved - only visible to creator, from oauthClientInformation

oauthClientSecret

Resolved - only visible to the creator (OAuth stays keyed to createdBy in v1), decrypted from encryptedOauthClientSecret

oauthConnected

Resolved - indicates if the connection creator has connected their OAuth account (OAuth stays keyed to createdBy in v1)

sessionLoginPath

Relative path on origin to POST credentials to (e.g. '/Login').

sessionCookieNames

Cookie names captured from the login response's Set-Cookie header(s) and attached to subsequent requests as a Cookie: header.

sessionLoginBodyKeys

UI-visible keys for the login body. Values are encrypted and not returned.

sftpUsername

Login name on the SFTP server. The password is stored encrypted and never returned.

sftpHostKeyFingerprint

The server's SHA256 host key fingerprint as OpenSSH prints it ('SHA256:' and 43 base64 characters). Every connection checks the server's key against it.

Usages

#

References

#

  • Field getAccessibleHttpConnections from Query