quick-connect.md

Quick Connect

quick_connect_controller = client.quick_connect

Class Name

QuickConnectController

Methods

• Authorize
• Connect
• Get Enabled
• Initiate

Authorize

Authorizes a pending quick connect request.

def authorize(self,
             code)

Parameters

Parameter	Type	Tags	Description
code	string	Query, Required	Quick connect code to authorize.

Response Type

bool

Example Usage

code = 'code8'

result = quick_connect_controller.authorize(code)

Errors

HTTP Status Code	Error Description	Exception Class
401	Unauthorized	APIException
403	Unknown user id.	ProblemDetailsException

Connect

Attempts to retrieve authentication information.

def connect(self,
           secret)

Parameters

Parameter	Type	Tags	Description
secret	string	Query, Required	Secret previously returned from the Initiate endpoint.

Response Type

QuickConnectResult

Example Usage

secret = 'secret4'

result = quick_connect_controller.connect(secret)

Errors

HTTP Status Code	Error Description	Exception Class
404	Unknown quick connect secret.	ProblemDetailsException

Get Enabled

Gets the current quick connect state.

def get_enabled(self)

Response Type

bool

Example Usage

result = quick_connect_controller.get_enabled()

Initiate

Initiate a new quick connect request.

def initiate(self)

Response Type

QuickConnectResult

Example Usage

result = quick_connect_controller.initiate()

Errors

HTTP Status Code	Error Description	Exception Class
401	Quick connect is not active on this server.	APIException