Skip to content

HTTP OAuth2

Parameters for HTTP connections using OAuth 2.0 with Client Credentials.


General Information:

Type ID Module Category
5 httplib api

OAuth2ConnectionParams

Parameters:

  • client_id : str

Input Parameters:

Field Type Required Description Default value Examples
url HttpUrl Service endpoint full URL PydanticUndefined https://api.example.com/endpoint
headers Optional[dict[str, str]] Additional HTTP headers to include in the request None {"Authorization": "Bearer token", "Content-Type": "application/json"}
method Literal[GET, POST, PUT, DELETE, PATCH] HTTP method to use GET POST
body Optional[dict[str, Any]] JSON body of the request None {"key": "value"}
verify_ssl bool Whether to validate the SSL certificate True True
client_id str OAuth2 client identifier PydanticUndefined client_id_value
client_secret str OAuth2 Client Secret PydanticUndefined client_secret_value
token_url HttpUrl OAuth2 token endpoint URL PydanticUndefined https://auth.example.com/token

Example:

{
  "url": "https://api.example.com/oauth2",
  "client_id": "client_id_value",
  "client_secret": "client_secret_value",
  "token_url": "https://auth.example.com/token",
  "headers": {},
  "method": "GET",
  "body": null,
  "verify_ssl": true
}

Notes:

This model supports the OAuth2 Client Credentials flow.