third_party_auth_api module#

class edgeimpulse_api.api.third_party_auth_api.ThirdPartyAuthApi(api_client=None)[source]#

Bases: object

authorize_third_party(

project_id: StrictInt[StrictInt],

auth_id: StrictInt[StrictInt],

next_url: StrictStr[StrictStr],

**kwargs,

) → None[source]#

Give access to project

Authorize a third party to access a project

Parameters:

project_id (int) – Project ID (required)
auth_id (int) – Auth ID (required)
next_url (str) – The URL to redirect to after authorization is completed. (required)
async_req (bool, optional) – Whether to execute the request asynchronously.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns:

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type:

None

create_third_party_auth(

create_third_party_auth_request: CreateThirdPartyAuthRequest,

**kwargs,

) → CreateThirdPartyAuthResponse[source]#

Create third party auth

Create a new third party authentication partner

Parameters:

create_third_party_auth_request (CreateThirdPartyAuthRequest) – (required)
async_req (bool, optional) – Whether to execute the request asynchronously.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns:

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type:

CreateThirdPartyAuthResponse

create_user_third_party(

auth_id: StrictInt[StrictInt],

create_user_third_party_request: CreateUserThirdPartyRequest,

**kwargs,

) → CreateUserThirdPartyResponse[source]#

Create or login a user

Login as a user as a third-party authentication provider. If the user does not exists, it’s automatically created. You can only log in as users that were previously created by you.

Parameters:

auth_id (int) – Auth ID (required)
create_user_third_party_request (CreateUserThirdPartyRequest) – (required)
async_req (bool, optional) – Whether to execute the request asynchronously.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns:

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type:

CreateUserThirdPartyResponse

delete_third_party_auth(

auth_id: StrictInt[StrictInt],

**kwargs,

) → GenericApiResponse[source]#

Delete third party auth

Delete a third party authentication partner

Parameters:

auth_id (int) – Auth ID (required)
async_req (bool, optional) – Whether to execute the request asynchronously.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns:

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type:

GenericApiResponse

get_all_third_party_auth(

**kwargs,

) → GetAllThirdPartyAuthResponse[source]#

Get all third party auth

Get information about all third party authentication partners

Parameters:

async_req (bool, optional) – Whether to execute the request asynchronously.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns:

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type:

GetAllThirdPartyAuthResponse

get_third_party_auth(

auth_id: StrictInt[StrictInt],

**kwargs,

) → GetThirdPartyAuthResponse[source]#

Get third party auth

Get information about a third party authentication partner

Parameters:

auth_id (int) – Auth ID (required)
async_req (bool, optional) – Whether to execute the request asynchronously.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns:

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type:

GetThirdPartyAuthResponse

update_third_party_auth(

auth_id: StrictInt[StrictInt],

update_third_party_auth_request: UpdateThirdPartyAuthRequest,

**kwargs,

) → GenericApiResponse[source]#

Update third party auth

Update a third party authentication partner

Parameters:

auth_id (int) – Auth ID (required)
update_third_party_auth_request (UpdateThirdPartyAuthRequest) – (required)
async_req (bool, optional) – Whether to execute the request asynchronously.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns:

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type:

GenericApiResponse