用户和身份验证提供者配置文件

在此页面上

对提供商进行身份验证

配置
自定义用户数据

Atlas Device Sync 、 Atlas Edge Server 、 Data API和HTTPS endpoints均已弃用。有关详细信息，请参阅弃用页面。

注意

本页介绍一种旧版配置文件格式。仅当使用已弃用的 realm-cli时才应使用此信息。

使用 App Services CLI 拉取或从用户界面导出的任何配置文件都使用最新配置版本。有关当前配置文件格式的详细信息，请参阅应用程序配置。

app/
└── auth/
    ├── providers.json
    └── custom_user_data.json

对提供商进行身份验证

配置

您可以在/auth/providers.json中启用和配置身份验证提供者。

配置的每个字段都是提供程序类型的名称，并包含该提供程序的配置对象。身份验证提供者配置具有通用结构，但每种提供商类型都使用一组唯一的字段。

提示

您可以在特定提供商的参考页面上找到该提供商配置的详细信息。有关所有提供商参考页面的列表，请参阅身份验证提供者。

/auth/providers.json

{
  "<Provider Name>": {
    "name": "<Provider Name>",
    "type": "<Provider Type>",
    "disabled": <Boolean>,
    "config": {
      "<Configuration Option>": "<Configuration Value>"
    },
    "secret_config": {
      "<Configuration Option>": "<Secret Name>"
    },
    "metadata_fields": [
      {
        "required": <Boolean>,
        "name": "Field Name"
      },
      ...
    ],
    "redirect_uris": ["<Application Redirect URI>", ...]
  },
  ...
}

字段	说明
`name` String	身份验证提供者的名称。它始终与提供商的`type`相同。
`type` String	身份验证提供者类型。有效选项： `"anon-user"` 用于匿名身份验证。 `"local-userpass"` 用于电子邮件/密码身份验证。 `"api-key"` 用于API 密钥身份验证。 `"custom-token"` 用于自定义 JSON web token身份验证。 `"custom-function"` 用于自定义函数身份验证。 `"oauth2-google"` 用于Google身份验证。 `"oauth2-facebook"` 用于Facebook身份验证。 `"oauth2-apple"` 用于Apple ID身份验证。
`disabled` Boolean	如果`true` ，则表示未为您的应用程序启用此身份验证提供者。用户无法使用已禁用的提供商的凭据登录。
`config` Document	包含特定于身份验证提供者的配置值的文档。以下提供者配置包括`config` ：电子邮件/密码自定义 JWT 自定义函数 Google Facebook Apple ID
`secret_config` Document	一个文档，其中每个字段名称都是提供商的私有配置字段，每个字段的值都是存储配置值的密钥的名称。以下提供者配置包括`redirect_uris` ：自定义 JWT Google Facebook Apple ID
`metadata_fields` Array<Document>	文档数组，其中每个文档定义一个描述用户的元数据字段。该字段是否存在以及每个元数据字段文档的确切格式取决于提供商类型。以下提供者配置包括`metadata_fields` ：自定义 JWT Google Facebook
`redirect_uris` Array<String>	Atlas App Services 在用户完成 OAuth 授权后可能会将用户重定向回的 URL 列表。以下提供者配置包括`redirect_uris` ： Google Facebook Apple ID

自定义用户数据

您可以在/auth/custom_user_data.json中为您的应用配置自定义用户数据集合。

/auth/custom_user_data.json

{
  "enabled": <Boolean>,
  "mongo_service_name": "<MongoDB Data Source Name>",
  "database_name": "<Database Name>",
  "collection_name": "<Collection Name>",
  "user_id_field": "<Field Name>",
  "on_user_creation_function_name": "<Function Name>"
}

字段名称	说明
`enabled` Boolean	如果`true`，App Services将每个用户与指定collection中包含其自定义数据的文档相关联。
`mongo_service_name` String	包含自定义用户数据集合的数据源的名称。
`database_name` String	包含自定义用户数据集合的数据库的名称。
`collection_name` String	包含自定义用户数据的集合的名称。
`user_id_field` String	自定义用户数据文档中包含该文档描述的应用程序用户的用户ID的字段的名称。
`on_user_creation_function_name` String	用户创建函数的名称。

来年

什么是 Atlas App Services？