ApiKeyCredentials Class

Represent the ApiKey feature of Swagger.

Dict should be dict[str,str] to be accepted by requests.

Inheritance
ApiKeyCredentials

Constructor

ApiKeyCredentials(in_headers=None, in_query=None)

Parameters

in_headers
dict[<xref:str,str>]
Required

Headers part of the ApiKey

in_query
dict[<xref:str,str>]
Required

ApiKey in the query as parameters

Methods

signed_session

Create requests session with ApiKey.

If a session object is provided, configure it directly. Otherwise, create a new session and return it.

signed_session

Create requests session with ApiKey.

If a session object is provided, configure it directly. Otherwise, create a new session and return it.

signed_session(session=None)

Parameters

session
<xref:requests.Session>
default value: None

The session to configure for authentication

Return type

<xref:requests.Session>