OAuth User Authentication with Escape¶

Description¶

The 'OAuth User Credentials' preset is designed for authentication using the OAuth 2.0 framework with user password credentials:

OAuth Token Endpoint: Authentication requests are sent to the specified OAuth token endpoint of an OpenID Connect server.
Client Credentials: Includes the client ID and client secret for authenticating the OAuth request.
User Password Credentials: This preset supports the OAuth password grant type, using individual user passwords for token generation.

This method is suitable for systems that require secure, OAuth-based authentication with user credentials, especially in scenarios where direct user-password-based authentication is preferred.

Examples¶

presets:
-   type: oauth_userpass
    url: https://oauth.example.com/token
    client_id: client123
    client_secret: secretXYZ
    users:
    -   username: user1
        password: pass1
    -   username: user2
        password: pass2
    -   username: user3
        password: pass3
        scopes:
        - create
        - delete

Extensive Configuration¶

Property	Type	Required	Description
type	`Const[oauth_userpass]`	`True`
users	OAuthUserpassUserPreset	`True`	A list of users to create
url	`string`	`True`	The URL of the token endpoint of the OpenIDConnect server
client_id	`string`	`True`	The client ID to use for the OAuth requests
client_secret	`string`	`True`	The client secret to use for the OAuth requests

Objects¶

OAuthUserpassUserPreset¶

Property	Type	Required	Description
username	`string`	`True`	The username of the user.
headers	`Dict[string, string]`	`False`	Optional headers injected during the authentication process and in authentified requests.
cookies	`Dict[string, string]`	`False`	Optional cookies injected during the authentication process and in authentified requests.
password	`string`	`True`	The password of the user.
scopes	`string`	`False`	A list of scopes to request for the user. If not specified, no scope will be requested.