Uploaded image for project: 'Documentation'
  1. Documentation
  2. DOCS-16005

API docs: Get Started with the Atlas Administration API doesn't show how to use digest auth

    XMLWordPrintableJSON

Details

    • Icon: Task Task
    • Resolution: Done
    • Icon: Major - P3 Major - P3
    • None
    • None
    • API, Atlas
    • None
    • 3

    Description

      The current API docs dont give a clear example of how to get started with our API, particularly how to use digest auth for authentication.

       

      Our https://www.mongodb.com/docs/atlas/configure-api-access/#get-started-with-the-atlas-administration-api guide goes into great detail on how to setup an API key, but shows no usage/example of what to do with the API key.

      Our old docs were better here, giving a full curl example for each resource: https://www.mongodb.com/docs/atlas/reference/api/project-get-all/#example 

      Our users are struggling to use the current API docs to setup digest, for example, https://www.mongodb.com/community/forums/t/how-to-prepare-auth-for-mongodb-atlas-administration-api/194273 where they went to the old docs to setup auth.

       

      Proposal

      • Extend getting started with a worked example of using the API with curl
      • In our OpenAPI spec, add a note on the general curl syntax for using digest, with a link to getting started for full details on how to setup the API-key

      Attachments

        Activity

          People

            david.hou@mongodb.com David Hou
            colm.quinn@mongodb.com Colm Quinn
            Votes:
            0 Vote for this issue
            Watchers:
            3 Start watching this issue

            Dates

              Created:
              Updated:
              Resolved:
              42 weeks, 2 days ago