Create Connection
Overview
create_connection creates a new data source connection for any integration type: DIRECT, DIRECT_IAS, IAL2, PROA, or INDIRECT_IAS.
DIRECTandDIRECT_IASare identity-based and do not require credentials.IAL2is authorized via the caller's own identity assurance level and also does not require credentials.PROAandINDIRECT_IASare OAuth-based: instead of creating the connection directly, this returns{"oauth_url": "<url>"}— present that URL to the user in a real browser/webview session to complete the connection (this cannot be completed on the user's behalf programmatically). Checkget_connection_statusafterward to confirm it succeeded.
Security note: if a specific data source genuinely requires a username and password, only pass them when the user has explicitly and knowingly provided their own login credentials for this specific purpose. No integration type is hardcoded as requiring credentials — the tool passes username/password through as optional for every type and defers to the data source itself as the source of truth for whether they're needed.
Required Parameters
connection_id (string)
- The identifier of the data source endpoint to connect to (the
endpoint.namevalue fromsearch_connectionsresults).
Optional Parameters
integration_type (string)
- Default: defaults to the data source's own default
- One of
DIRECT,DIRECT_IAS,IAL2,PROA,INDIRECT_IAS.
username (string)
- Default:
null - The user's login username for this data source, only if it requires one. Not used for the
PROA/INDIRECT_IASOAuth branch.
password (string)
- Default:
null - The user's login password for this data source, only if it requires one. Not used for the
PROA/INDIRECT_IASOAuth branch.
Returns
- For
DIRECT,DIRECT_IAS, orIAL2: the newly createdConnectionobject —id,name,category,type,is_direct,integration_type,consent_policy_url,consent_validity_duration,endpoint_status,status,sync_status,status_updated,created,disconnect_url. - For
PROAorINDIRECT_IAS:{"oauth_url": "<url>"}— an OAuth redirect URL, not a created connection.
Updated 14 days ago
Did this page help you?
