connections
konigle.models.core.connections
¶
Connection models for the Konigle SDK.
This module provides models for third-party API integrations and connections including OAuth and API key based connections.
Connection
¶
Bases: TimestampedResource
Connection resource model.
Represents a third-party API integration connection with OAuth or API key authentication. Connections are site-specific and store credentials, tokens, and metadata for external service integrations.
provider = Field(..., title='Provider Code', description='Provider code identifying the third-party service.')
class-attribute
instance-attribute
¶
Provider code identifying the third-party service.
root_resource_id = Field(default=None, title='Root Resource ID', description='Authorized resource ID (e.g., account ID, email).')
class-attribute
instance-attribute
¶
Authorized resource ID (e.g., account ID, email).
root_resource_name = Field(default=None, title='Root Resource Name', description='Authorized resource name (e.g., account name).')
class-attribute
instance-attribute
¶
Authorized resource name (e.g., account name).
scopes = Field(default_factory=list, title='OAuth Scopes', description='List of OAuth scopes authorized for this connection.')
class-attribute
instance-attribute
¶
List of OAuth scopes authorized for this connection.
status = Field(default=(ConnectionStatus.ACTIVE), title='Connection Status', description='Current status of the connection.')
class-attribute
instance-attribute
¶
Current status of the connection.
token_expires_at = Field(default=None, title='Token Expiry', description='Expiration timestamp for the access token.')
class-attribute
instance-attribute
¶
Expiration timestamp for the access token.
ConnectionStatus
¶
Bases: str, Enum
Status of a connection.