Bug 1391329

Summary:	"REST API Authorization information" is missing in the "Red Hat CloudForms REST API" guide.
Product:	Red Hat CloudForms Management Engine	Reporter:	Prasad Mukhedkar <pmukhedk>
Component:	Documentation	Assignee:	Red Hat CloudForms Documentation <cloudforms-docs>
Status:	CLOSED WONTFIX	QA Contact:	Red Hat CloudForms Documentation <cloudforms-docs>
Severity:	high	Docs Contact:
Priority:	unspecified
Version:	5.7.0	CC:	adahms, hhudgeon, jhardy, obarenbo
Target Milestone:	GA
Target Release:	cfme-future
Hardware:	x86_64
OS:	Linux
Whiteboard:	doc
Fixed In Version:		Doc Type:	If docs needed, set a value
Doc Text:		Story Points:	---
Clone Of:		Environment:
Last Closed:	2018-10-08 23:35:27 UTC	Type:	Bug
Regression:	---	Mount Type:	---
Documentation:	---	CRM:
Verified Versions:		Category:	---
oVirt Team:	---	RHEL 7.3 requirements from Atomic Host:
Cloudforms Team:	---	Target Upstream Version:

Description Prasad Mukhedkar 2016-11-03 06:40:16 UTC

Document URL: 

https://access.redhat.com/documentation/en/red-hat-cloudforms/4.2-beta/single/red-hat-cloudforms-rest-api/


Describe the issue: 

No information about API authorization is documented 
the guide. The upstream documentation[1] has detail 
information on the subject. If I search "X-MIQ-Group"
header in the documentation, get zero result. 

This header facilitates the authorization. Give a way
to select the group through which api call is made
when an account has multiple groups. 

Suggestions for improvement: 

Add section on API Authorization with example 

Additional information: 

[1]http://manageiq.org/docs/reference/latest/api/overview/authorization

Comment 2 Andrew Dahms 2018-10-08 23:35:27 UTC

Thank you for raising this bug.

We have evaluated this request, and while we recognize that it is a valid request for the documentation, we do not expect this to be implemented in the product in the foreseeable future. We are therefore closing this out as WONTFIX. 

If you have any concerns about this, please feel free to contact Andrew Dahms.