[DOCS-9859] Atlas API Docs: "Atlas User" Section Requires Update Created: 03/Feb/17  Updated: 04/Feb/17  Resolved: 04/Feb/17

Status: Closed
Project: Documentation
Component/s: Atlas
Affects Version/s: None
Fix Version/s: None

Type: Task Priority: Critical - P2
Reporter: Luke Phillippi Assignee: Ravind Kumar (Inactive)
Resolution: Done Votes: 0
Labels: None
Remaining Estimate: Not Specified
Time Spent: Not Specified
Original Estimate: Not Specified

Participants:
Days since reply: 7 years, 1 week, 4 days ago

 Description   

The Atlas Users section of the Atlas API documentation contains the following example:

Get All Users in a Group

Retrieve all users in a group.

GET /api/atlas/v1.0/groups/GROUP-ID/users

However, this endpoint does not exist within the Atlas API; the documentation should be updated to accurately reflect this.



 Comments   
Comment by Ravind Kumar (Inactive) [ 04/Feb/17 ]

Thanks Kay! luke.phillippi thank you for the heads up on the error.

Comment by Ravind Kumar (Inactive) [ 04/Feb/17 ]

Taken from a comment by michael.benoit here

This is a documentation error. We don't support this feature for Atlas yet. So this endpoint should be removed from the docs:
/api/atlas/v1.0/groups/GROUP-ID/users

kay.kim does the following sound good:

  • remove page from TOC
  • create redirect to push users to /api-resources

Mike, just so we have an idea, is progress on having this endpoint documented anywhere, so we can track it better?

Generated at Thu Feb 08 07:59:18 UTC 2024 using Jira 9.7.1#970001-sha1:2222b88b221c4928ef0de3161136cc90c8356a66.