singer_sdk.authenticators.OAuthJWTAuthenticator

class singer_sdk.authenticators.OAuthJWTAuthenticator

API Authenticator for OAuth 2.0 flows which utilize a JWT refresh token.

__init__(*args, private_key=None, private_key_passphrase=None, **kwargs)

Create a new JWT authenticator.

Parameters:

• args (Any)

• private_key (str | None)

• private_key_passphrase (str | None)

• kwargs (Any)

Return type:

None

property oauth_request_body: dict

Return request body for OAuth request.

Returns:

Request body mapping for OAuth.

property oauth_request_payload: dict

Return request payload for OAuth request.

Returns:

Payload object for OAuth.

Raises:

• RuntimeError – If the JWT dependencies are not installed.

• ValueError – If the private key is not set.

property private_key: str | None

Return the private key to use in encryption.

Returns:

Private key from stream config.

property private_key_passphrase: str | None

Return the private key passphrase to use in encryption.

Returns:

Passphrase for private key from stream config.