Skip to main content
Version: devel

sources.helpers.rest_client.auth

TApiKeyLocation

Alias for scheme "in" field

AuthConfigBase Objects

class AuthConfigBase(AuthBase, CredentialsConfiguration)

[view_source]

Authenticator base which is both requests friendly AuthBase and dlt SPEC configurable via env variables or toml files

BearerTokenAuth Objects

@configspec
class BearerTokenAuth(AuthConfigBase)

[view_source]

Uses token for Bearer authentication in "Authorization" header.

APIKeyAuth Objects

@configspec
class APIKeyAuth(AuthConfigBase)

[view_source]

Uses provided api_key to create authorization data in the specified location (query, param, header, cookie) under specified name

HttpBasicAuth Objects

@configspec
class HttpBasicAuth(AuthConfigBase)

[view_source]

Uses HTTP basic authentication

OAuth2AuthBase Objects

@configspec
class OAuth2AuthBase(AuthConfigBase)

[view_source]

Base class for oauth2 authenticators. requires access_token

OAuth2ClientCredentials Objects

@configspec
class OAuth2ClientCredentials(OAuth2AuthBase)

[view_source]

This class implements OAuth2 Client Credentials flow where the authorization service gives permission without the end user approving. This is often used for machine-to-machine authorization. The client sends its client ID and client secret to the authorization service which replies with a temporary access token. With the access token, the client can access resource services.

OAuthJWTAuth Objects

@configspec
class OAuthJWTAuth(BearerTokenAuth)

[view_source]

This is a form of Bearer auth, actually there's not standard way to declare it in openAPI

This demo works on codespaces. Codespaces is a development environment available for free to anyone with a Github account. You'll be asked to fork the demo repository and from there the README guides you with further steps.
The demo uses the Continue VSCode extension.

Off to codespaces!

DHelp

Ask a question

Welcome to "Codex Central", your next-gen help center, driven by OpenAI's GPT-4 model. It's more than just a forum or a FAQ hub – it's a dynamic knowledge base where coders can find AI-assisted solutions to their pressing problems. With GPT-4's powerful comprehension and predictive abilities, Codex Central provides instantaneous issue resolution, insightful debugging, and personalized guidance. Get your code running smoothly with the unparalleled support at Codex Central - coding help reimagined with AI prowess.