Uploaded image for project: 'Drivers'
  1. Drivers
  2. DRIVERS-2850

Update auth.md spec file to correctly mention that username is optional for MONGODB-OIDC

    • Type: Icon: Task Task
    • Resolution: Done
    • Priority: Icon: Minor - P4 Minor - P4
    • None
    • Component/s: Authentication
    • None
    • Not Needed

      Summary

      When OIDC was added, we forgot to update the username portion to denote that it's optional for OIDC

      Motivation

      Who is the affected end user?

      spec readers

      How does this affect the end user?

      Minor

      How likely is it that this problem or use case will occur?

      Every time auth.md is read

      If the problem does occur, what are the consequences and how severe are they?

      Minor, the OIDC section properly states that username is optional

      Is this issue urgent?

      No

      Is this ticket required by a downstream team?

      No

      Is this ticket only for tests?

      No functional impact, but not only for tests

      Acceptance Criteria

      Adding MONGODB-OIDC to the list of optional username mechanisms:

      Client Implementation

      https://github.com/mongodb/specifications/blob/master/source/auth/auth.md#client-implementation

      MongoCredential

      https://github.com/mongodb/specifications/blob/master/source/auth/auth.md#mongocredential
      Drivers SHOULD contain a type called MongoCredential. It SHOULD contain some or all of the following information.

      • username (string)
        • Applies to all mechanisms.
        • Optional for MONGODB-X509 and MONGODB-AWS <--- here

            Assignee:
            steve.silvester@mongodb.com Steve Silvester
            Reporter:
            patrick.meredith@mongodb.com Patrick Meredith
            Votes:
            0 Vote for this issue
            Watchers:
            1 Start watching this issue

              Created:
              Updated:
              Resolved: