Gigya low-level authentication API Reference

Core

Gigya API.

async renault_api.gigya.get_account_info(websession, root_url, api_key, login_token)

Send POST to /accounts.getAccountInfo.

Parameters

• websession (aiohttp.client.ClientSession) –

• root_url (str) –

• api_key (str) –

• login_token (str) –

Return type

renault_api.gigya.models.GigyaGetAccountInfoResponse

async renault_api.gigya.get_jwt(websession, root_url, api_key, login_token)

Send POST to /accounts.getJWT.

Parameters

• websession (aiohttp.client.ClientSession) –

• root_url (str) –

• api_key (str) –

• login_token (str) –

Return type

renault_api.gigya.models.GigyaGetJWTResponse

async renault_api.gigya.login(websession, root_url, api_key, login_id, password)

Send POST to /accounts.login.

Parameters

• websession (aiohttp.client.ClientSession) –

• root_url (str) –

• api_key (str) –

• login_id (str) –

• password (str) –

Return type

renault_api.gigya.models.GigyaLoginResponse

async renault_api.gigya.request(websession, method, url, data, schema)

Send request to Gigya.

Parameters

• websession (aiohttp.client.ClientSession) –

• method (str) –

• url (str) –

• data (Dict[str, Any]) –

• schema (marshmallow.schema.Schema) –

Return type

renault_api.gigya.models.GigyaResponse

Data models

Gigya models.

class renault_api.gigya.models.GigyaGetAccountInfoData(raw_data, personId)

Gigya GetAccountInfo data details.

Parameters

• raw_data (Dict[str, Any]) –

• personId (Optional[str]) –

Return type

None

class renault_api.gigya.models.GigyaGetAccountInfoResponse(raw_data, errorCode, errorDetails, data)

Gigya response to POST on /accounts.getAccountInfo.

Parameters

• raw_data (Dict[str, Any]) –

• errorCode (int) –

• errorDetails (Optional[str]) –

• data (Optional[renault_api.gigya.models.GigyaGetAccountInfoData]) –

Return type

None

get_person_id()

Return person id.

Return type

str

class renault_api.gigya.models.GigyaGetJWTResponse(raw_data, errorCode, errorDetails, id_token)

Gigya response to POST on /accounts.getJWT.

Parameters

• raw_data (Dict[str, Any]) –

• errorCode (int) –

• errorDetails (Optional[str]) –

• id_token (Optional[str]) –

Return type

None

get_jwt()

Return jwt token.

Return type

str

class renault_api.gigya.models.GigyaLoginResponse(raw_data, errorCode, errorDetails, sessionInfo)

Gigya response to POST on /accounts.login.

Parameters

• raw_data (Dict[str, Any]) –

• errorCode (int) –

• errorDetails (Optional[str]) –

• sessionInfo (Optional[renault_api.gigya.models.GigyaLoginSessionInfo]) –

Return type

None

get_session_cookie()

Return cookie value from session information.

Return type

str

class renault_api.gigya.models.GigyaLoginSessionInfo(raw_data, cookieValue)

Gigya Login sessionInfo details.

Parameters

• raw_data (Dict[str, Any]) –

• cookieValue (Optional[str]) –

Return type

None

class renault_api.gigya.models.GigyaResponse(raw_data, errorCode, errorDetails)

Gigya response.

Parameters

• raw_data (Dict[str, Any]) –

• errorCode (int) –

• errorDetails (Optional[str]) –

Return type

None

raise_for_error_code()

Checks the response information.

Return type

None