Skip to content

Latest commit

 

History

History
94 lines (52 loc) · 4.17 KB

Connection.md

File metadata and controls

94 lines (52 loc) · 4.17 KB
Raw

Apideck.Connection

Description

Properties

Name Type Description Notes
id string The unique identifier of the connection. [optional]
service_id string The ID of the service this connection belongs to. [optional]
name string The name of the connection [optional]
tag_line string [optional]
unified_api string The unified API category where the connection belongs to. [optional]
state ConnectionState [optional]
integration_state IntegrationState [optional]
auth_type AuthType [optional]
oauth_grant_type OAuthGrantType [optional]
status string Status of the connection. [optional]
enabled boolean Whether the connection is enabled or not. You can enable or disable a connection using the Update Connection API. [optional]
website string The website URL of the connection [optional]
icon string A visual icon of the connection, that will be shown in the Vault [optional]
logo string The logo of the connection, that will be shown in the Vault [optional]
authorize_url string The OAuth redirect URI. Redirect your users to this URI to let them authorize your app in the connector's UI. Before you can use this URI, you must add `redirect_uri` as a query parameter to the `authorize_url`. Be sure to URL encode the `redirect_uri` part. Your users will be redirected to this `redirect_uri` after they granted access to your app in the connector's UI. [optional]
revoke_url string The OAuth revoke URI. Redirect your users to this URI to revoke this connection. Before you can use this URI, you must add `redirect_uri` as a query parameter. Your users will be redirected to this `redirect_uri` after they granted access to your app in the connector's UI. [optional]
settings { [key: string]: object; } Connection settings. Values will persist to `form_fields` with corresponding id [optional]
metadata { [key: string]: object; } Attach your own consumer specific metadata [optional]
form_fields Array<FormField> The settings that are wanted to create a connection. [optional]
configuration Array<ConnectionConfiguration> [optional]
configurable_resources Array<string> [optional]
resource_schema_support Array<string> [optional]
resource_settings_support Array<string> [optional]
validation_support boolean [optional]
schema_support boolean [optional]
settings_required_for_authorization Array<string> List of settings that are required to be configured on integration before authorization can occur [optional]
subscriptions Array<WebhookSubscription> [optional]
has_guide boolean Whether the connector has a guide available in the developer docs or not (https://docs.apideck.com/connectors/{service_id}/docs/consumer+connection). [optional]
created_at number [optional]
custom_mappings Array<CustomMapping> List of custom mappings configured for this connection [optional]
updated_at number [optional]

Enum: Connection.status

  • live (value: 'live')

  • upcoming (value: 'upcoming')

  • requested (value: 'requested')

Referenced Types:

[Back to top] [Back to API list] [Back to README]