Document "accessToken" form of KMS providers

XMLWordPrintableJSON

    • Needed

      Summary

      Document "accessToken" form of KMS providers

      Background

      The specification describes two forms of the "azure" and "gcp" KMS providers options:

      type AzureKMSOptions = AzureKMSCredentials | AzureAccessToken;
      
      interface AzureKMSCredentials {
         tenantId: string;
         clientId: string;
         clientSecret: string;
         identityPlatformEndpoint?: string; // Defaults to login.microsoftonline.com
      };
      
      interface AzureAccessToken {
         accessToken: string;
      };
      
      type GCPKMSOptions = GCPKMSCredentials | GCPKMSAccessToken
      
      interface GCPKMSCredentials {
         email: string;
         privateKey: byte[] | string; // May be passed as a base64 encoded string.
         endpoint?: string; // Defaults to oauth2.googleapis.com
      };
      
      interface GCPKMSAccessToken {
         accessToken: string;
      }
      

      Some driver docs do not include the "accessToken" form: C, Java, PyMongo.

      Motivation

      Caused confusion in HELP-60485.

      Is this issue urgent?

      No?

              Assignee:
              Unassigned
              Reporter:
              Kevin Albertson
              Votes:
              0 Vote for this issue
              Watchers:
              4 Start watching this issue

                Created:
                Updated: