Bug 2180375

Summary:	[DDF] Example mentioned in "3.4.2. OAuth Request Format" is missing important information or not entirely correct
Product:	Red Hat Satellite	Reporter:	Direct Docs Feedback <ddf-bot>
Component:	API	Assignee:	satellite6-bugs <satellite6-bugs>
Status:	NEW ---	QA Contact:	Satellite QE Team <sat-qe-bz-list>
Severity:	unspecified	Docs Contact:
Priority:	unspecified
Version:	6.12.0	CC:	alazik, lstejska, mjivraja, saydas
Target Milestone:	Unspecified	Keywords:	Documentation, Triaged
Target Release:	Unused	Flags:	mdolezel: needinfo? (alazik)
Hardware:	All
OS:	All
Whiteboard:
Fixed In Version:		Doc Type:	If docs needed, set a value
Doc Text:		Story Points:	---
Clone Of:		Environment:
Last Closed:		Type:	---
Regression:	---	Mount Type:	---
Documentation:	---	CRM:
Verified Versions:		Category:	---
oVirt Team:	---	RHEL 7.3 requirements from Atomic Host:
Cloudforms Team:	---	Target Upstream Version:
Embargoed:

Description Direct Docs Feedback 2023-03-21 10:19:40 UTC

The curl command mentioned in the example section does not works. We perhaps are missing the information about how to generate the oauth_signature here.

Reported by: rhn-support-saydas

https://access.redhat.com/documentation/en-us/red_hat_satellite/6.12/html/api_guide/chap-red_hat_satellite-api_guide-authenticating_api_calls#annotations:c2b9cff8-94db-458a-9d13-31e0a0e8de61

Comment 1 Sayan Das 2023-03-22 04:55:01 UTC

CC Leos and Malhar 

Here in https://access.redhat.com/documentation/en-us/red_hat_satellite/6.12/html/api_guide/chap-red_hat_satellite-api_guide-authenticating_api_calls#OAuth_Request_Format

We share this example:

curl 'https://satellite.example.com/api/architectures' \
--header 'Content-Type: application/json' \
--header 'Accept:application/json' \
--header 'FOREMAN-USER: sat_username' \
--header 'Authorization: OAuth oauth_version="1.0",oauth_consumer_key="secretkey",oauth_signature_method="hmac-sha1",oauth_timestamp=1321473112,oauth_signature=Il8hR8/ogj/XVuOqMPB9qNjSy6E='


but we don't exactly explain how to get the oauth_timestamp or even more important, the oauth_signature .  So there is no way to get this curl command working even if we want to.

We do mention "Use an OAuth client library to construct all OAuth parameters" but no such examples have been provided there. 

Python example: https://access.redhat.com/solutions/4240401 

Foreman Wiki: https://projects.theforeman.org/projects/foreman/wiki/API_OAuth

Some info about signature : https://stackoverflow.com/questions/9986533/what-does-oauth-signature-sign 

And old redmine : https://projects.theforeman.org/issues/22699 ( which seems to be not applicable any more since sat 6.11 )