Skip to content

Latest commit

 

History

History
42 lines (37 loc) · 4.11 KB

Connection.md

File metadata and controls

42 lines (37 loc) · 4.11 KB
Raw

Connection

Properties

Name Type Description Notes
id str The unique identifier of the connection. [optional] [readonly]
service_id str The ID of the service this connection belongs to. [optional] [readonly]
name str The name of the connection [optional] [readonly]
tag_line str [optional] [readonly]
unified_api str The unified API category where the connection belongs to. [optional] [readonly]
state ConnectionState [optional]
integration_state IntegrationState [optional]
auth_type AuthType [optional]
oauth_grant_type OAuthGrantType [optional]
status str Status of the connection. [optional] [readonly]
enabled bool Whether the connection is enabled or not. You can enable or disable a connection using the Update Connection API. [optional]
website str The website URL of the connection [optional] [readonly]
icon str A visual icon of the connection, that will be shown in the Vault [optional] [readonly]
logo str The logo of the connection, that will be shown in the Vault [optional] [readonly]
authorize_url str, none_type 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] [readonly]
revoke_url str, none_type 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] [readonly]
settings {str: (bool, date, datetime, dict, float, int, list, str, none_type)}, none_type Connection settings. Values will persist to `form_fields` with corresponding id [optional]
metadata {str: (bool, date, datetime, dict, float, int, list, str, none_type)}, none_type Attach your own consumer specific metadata [optional]
form_fields [FormField] The settings that are wanted to create a connection. [optional] [readonly]
configuration [ConnectionConfiguration] [optional]
configurable_resources [str] [optional] [readonly]
resource_schema_support [str] [optional] [readonly]
resource_settings_support [str] [optional] [readonly]
validation_support bool [optional] [readonly]
schema_support bool [optional] [readonly]
settings_required_for_authorization [str] List of settings that are required to be configured on integration before authorization can occur [optional] [readonly]
subscriptions [WebhookSubscription] [optional] [readonly]
has_guide bool Whether the connector has a guide available in the developer docs or not (https://docs.apideck.com/connectors/{service_id}/docs/consumer+connection). [optional] [readonly]
created_at float [optional] [readonly]
custom_mappings [CustomMapping] List of custom mappings configured for this connection [optional]
updated_at float, none_type [optional] [readonly]
any string name bool, date, datetime, dict, float, int, list, str, none_type any string name can be used but the value must be the correct type [optional]

[Back to Model list] [Back to API list] [Back to README]