Skip to main content

OAuth User Password Authentication with Escape

Description

The 'OAuth User Password' 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

PropertyTypeRequiredDescriptionReference
typeConst[oauth_userpass]True
usersOAuthUserpassUserPresetTrueA list of users to createOAuthUserpassUserPreset
urlstringTrueThe URL of the token endpoint of the OpenIDConnect server
client_idstringTrueThe client ID to use for the OAuth requests
client_secretstringTrueThe client secret to use for the OAuth requests

Objects

OAuthUserpassUserPreset

PropertyTypeRequiredDescriptionReference
usernamestringTrueThe username of the user.
headersDict[string, string]FalseOptional headers injected during the authentication process and in authentified requests.
cookiesDict[string, string]FalseOptional cookies injected during the authentication process and in authentified requests.
passwordstringTrueThe password of the user.
scopesstringFalseA list of scopes to request for the user. If not specified, no scope will be requested.