更新LDAP或 X.509 配置
为指定项目编辑 LDAP 配置。要使用此资源,请求的服务帐户或 API 密钥必须具有“项目所有者”角色。
更新此配置会触发数据库的滚动重启。
路径参数
-
用于标识项目的唯一 24-十六进制数字字符串。 使用 /groups 端点检索身份验证的用户有权访问权限的所有项目。
注意:群组和项目是同义词。您的群组 ID 与项目 ID 相同。对于现有群组,群组/项目 ID 保持不变。资源和相应的端点使用“群组”一词。
格式应符合以下模式:
^([a-f0-9]{24})$
。
查询参数
-
指示应用程序是否将响应包装在
envelope
JSON 对象中的标志。某些 API 客户端无法访问 HTTP 响应标头或状态代码。要修复此问题,请在查询中设置 Envelope=true。返回结果列表的端点将结果对象用作 envelope。应用程序将状态参数添加到响应正文中。默认值为
false
。 -
指示响应正文是否应采用 prettyprint 格式的标记。
默认值为
false
。Prettyprint
PATCH /API/Atlas/v1.0/groups/{groupId}/userSecurity
curl \
--request PATCH 'https://cloud.mongodb.com/api/atlas/v1.0/groups/32b6e34b3d91647abb20e7b8/userSecurity' \
--header "Authorization: Bearer $ACCESS_TOKEN" \
--header "Content-Type: application/json" \
--data '{"customerX509":{"cas":"string"},"ldap":{"authenticationEnabled":true,"authorizationEnabled":true,"authzQueryTemplate":"{USER}?memberOf?base","bindPassword":"string","bindUsername":"CN=BindUser,CN=Users,DC=myldapserver,DC=mycompany,DC=com","caCertificate":"string","hostname":"string","port":636,"userToDNMapping":[{"ldapQuery":"string","match":"(.*)","substitution":"CN={0},CN=Users,DC=my-atlas-ldap-server,DC=example,DC=com"}]}}'
请求示例
{
"customerX509": {
"cas": "string"
},
"ldap": {
"authenticationEnabled": true,
"authorizationEnabled": true,
"authzQueryTemplate": "{USER}?memberOf?base",
"bindPassword": "string",
"bindUsername": "CN=BindUser,CN=Users,DC=myldapserver,DC=mycompany,DC=com",
"caCertificate": "string",
"hostname": "string",
"port": 636,
"userToDNMapping": [
{
"ldapQuery": "string",
"match": "(.*)",
"substitution": "CN={0},CN=Users,DC=my-atlas-ldap-server,DC=example,DC=com"
}
]
}
}
响应示例 (202)
{
"customerX509": {
"cas": "string",
"links": [
{
"href": "https://cloud.mongodb.com/api/atlas",
"rel": "self"
}
]
},
"ldap": {
"authenticationEnabled": true,
"authorizationEnabled": true,
"authzQueryTemplate": "{USER}?memberOf?base",
"bindUsername": "CN=BindUser,CN=Users,DC=myldapserver,DC=mycompany,DC=com",
"caCertificate": "string",
"hostname": "string",
"links": [
{
"href": "https://cloud.mongodb.com/api/atlas",
"rel": "self"
}
],
"port": 636,
"userToDNMapping": [
{
"ldapQuery": "string",
"match": "(.*)",
"substitution": "CN={0},CN=Users,DC=my-atlas-ldap-server,DC=example,DC=com"
}
]
},
"links": [
{
"href": "https://cloud.mongodb.com/api/atlas",
"rel": "self"
}
]
}
响应示例 (400)
{
"error": 400,
"detail": "(This is just an example, the exception may not be related to this endpoint) No provider AWS exists.",
"reason": "Bad Request",
"errorCode": "VALIDATION_ERROR"
}
响应示例 (401)
{
"error": 401,
"detail": "(This is just an example, the exception may not be related to this endpoint)",
"reason": "Unauthorized",
"errorCode": "NOT_ORG_GROUP_CREATOR"
}
响应示例 (403)
{
"error": 403,
"detail": "(This is just an example, the exception may not be related to this endpoint)",
"reason": "Forbidden",
"errorCode": "CANNOT_CHANGE_GROUP_NAME"
}
响应示例 (404)
{
"error": 404,
"detail": "(This is just an example, the exception may not be related to this endpoint) Cannot find resource AWS",
"reason": "Not Found",
"errorCode": "RESOURCE_NOT_FOUND"
}
响应示例 (500)
{
"error": 500,
"detail": "(This is just an example, the exception may not be related to this endpoint)",
"reason": "Internal Server Error",
"errorCode": "UNEXPECTED_ERROR"
}