openiddict-documentation/integrations/mongodb.md

MongoDB integration

Basic configuration

To configure OpenIddict to use MongoDB as the database for applications, authorizations, scopes and tokens, you'll need to:

• Reference the OpenIddict.MongoDb package:

  <PackageReference Include="OpenIddict.MongoDb" Version="3.1.1" />
  

• Configure OpenIddict to use the MongoDB stores:

  services.AddOpenIddict()
      .AddCore(options =>
      {
          // Note: to use a remote server, call the MongoClient constructor overload
          // that accepts a connection string or an instance of MongoClientSettings.
          options.UseMongoDb()
                 .UseDatabase(new MongoClient().GetDatabase("openiddict"));
      });
  

  Alternatively, you can register the IMongoDatabase instance as a service:

  services.AddOpenIddict()
      .AddCore(options =>
      {
          options.UseMongoDb();
      });
  
  // Note: to use a remote server, call the MongoClient constructor overload
  // that accepts a connection string or an instance of MongoClientSettings.
  services.AddSingleton(new MongoClient().GetDatabase("shared-database-instance"));
  

• Create indexes to improve performance (recommended): for that, you can use the following script to initialize the database and create the indexes used by the OpenIddict entities:

  using System.Threading;
  using Microsoft.Extensions.DependencyInjection;
  using Microsoft.Extensions.Options;
  using MongoDB.Driver;
  using OpenIddict.MongoDb;
  using OpenIddict.MongoDb.Models;
  
  var services = new ServiceCollection();
  services.AddOpenIddict()
      .AddCore(options => options.UseMongoDb());
  
  services.AddSingleton(new MongoClient("mongodb://localhost:27017").GetDatabase("openiddict"));
  
  var provider = services.BuildServiceProvider();
  var context = provider.GetRequiredService<IOpenIddictMongoDbContext>();
  var options = provider.GetRequiredService<IOptionsMonitor<OpenIddictMongoDbOptions>>().CurrentValue;
  var database = await context.GetDatabaseAsync(CancellationToken.None);
  
  var applications = database.GetCollection<OpenIddictMongoDbApplication>(options.ApplicationsCollectionName);
  
  await applications.Indexes.CreateManyAsync(new[]
  {
      new CreateIndexModel<OpenIddictMongoDbApplication>(
          Builders<OpenIddictMongoDbApplication>.IndexKeys.Ascending(application => application.ClientId),
          new CreateIndexOptions
          {
              Unique = true
          }),
  
      new CreateIndexModel<OpenIddictMongoDbApplication>(
          Builders<OpenIddictMongoDbApplication>.IndexKeys.Ascending(application => application.PostLogoutRedirectUris),
          new CreateIndexOptions
          {
              Background = true
          }),
  
      new CreateIndexModel<OpenIddictMongoDbApplication>(
          Builders<OpenIddictMongoDbApplication>.IndexKeys.Ascending(application => application.RedirectUris),
          new CreateIndexOptions
          {
              Background = true
          })
  });
  
  var authorizations = database.GetCollection<OpenIddictMongoDbAuthorization>(options.AuthorizationsCollectionName);
  
  await authorizations.Indexes.CreateOneAsync(
      new CreateIndexModel<OpenIddictMongoDbAuthorization>(
          Builders<OpenIddictMongoDbAuthorization>.IndexKeys
              .Ascending(authorization => authorization.ApplicationId)
              .Ascending(authorization => authorization.Scopes)
              .Ascending(authorization => authorization.Status)
              .Ascending(authorization => authorization.Subject)
              .Ascending(authorization => authorization.Type),
          new CreateIndexOptions
          {
              Background = true
          }));
  
  var scopes = database.GetCollection<OpenIddictMongoDbScope>(options.ScopesCollectionName);
  
  await scopes.Indexes.CreateOneAsync(new CreateIndexModel<OpenIddictMongoDbScope>(
      Builders<OpenIddictMongoDbScope>.IndexKeys.Ascending(scope => scope.Name),
      new CreateIndexOptions
      {
          Unique = true
      }));
  
  var tokens = database.GetCollection<OpenIddictMongoDbToken>(options.TokensCollectionName);
  
  await tokens.Indexes.CreateManyAsync(new[]
  {
      new CreateIndexModel<OpenIddictMongoDbToken>(
          Builders<OpenIddictMongoDbToken>.IndexKeys.Ascending(token => token.ReferenceId),
          new CreateIndexOptions<OpenIddictMongoDbToken>
          {
              // Note: partial filter expressions are not supported on Azure Cosmos DB.
              // As a workaround, the expression and the unique constraint can be removed.
              PartialFilterExpression = Builders<OpenIddictMongoDbToken>.Filter.Exists(token => token.ReferenceId),
              Unique = true
          }),
  
      new CreateIndexModel<OpenIddictMongoDbToken>(
          Builders<OpenIddictMongoDbToken>.IndexKeys
              .Ascending(token => token.ApplicationId)
              .Ascending(token => token.Status)
              .Ascending(token => token.Subject)
              .Ascending(token => token.Type),
          new CreateIndexOptions
          {
              Background = true
          })
  });
  

Advanced configuration

Use custom entities

For applications that require storing additional data alongside the properties used by OpenIddict, custom entities can be used. For that, you need to:

• Create custom entities:

  public class CustomApplication : OpenIddictMongoDbApplication
  {
      public string CustomProperty { get; set; }
  }
  
  public class CustomAuthorization : OpenIddictMongoDbAuthorization
  {
      public string CustomProperty { get; set; }
  }
  
  public class CustomScope : OpenIddictMongoDbScope
  {
      public string CustomProperty { get; set; }
  }
  
  public class CustomToken : OpenIddictMongoDbToken
  {
      public string CustomProperty { get; set; }
  }
  

• Configure MongoDb to use the custom entities:

  services.AddOpenIddict()
      .AddCore(options =>
      {
          options.UseMongoDb()
                 .ReplaceDefaultApplicationEntity<CustomApplication>()
                 .ReplaceDefaultAuthorizationEntity<CustomAuthorization>()
                 .ReplaceDefaultScopeEntity<CustomScope>()
                 .ReplaceDefaultTokenEntity<CustomToken>();
      });
  

Use custom collection names

By default, OpenIddict uses the openiddict.[entity name]s pattern to determine the default collection names. Applications that require using different collection names can use the Set*CollectionName() helpers:

services.AddOpenIddict()
    .AddCore(options =>
    {
        options.UseMongoDb()
               .SetApplicationsCollectionName("custom-applications-collection")
               .SetAuthorizationsCollectionName("custom-authorizations-collection")
               .SetScopesCollectionName("custom-scopes-collection")
               .SetTokensCollectionName("custom-tokens-collection");
    });