将用户添加到团队

在此页面上

语法

请求路径参数
请求查询参数
请求正文参数
响应
响应文档
results 嵌入式文档
请求示例
响应示例
响应标头
响应体

注意

基本 URL： https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0

语法

POST /orgs/{ORG-ID}/teams/{TEAM-ID}/users

请求路径参数

路径元素	必需/可选	说明
`ORG-ID`	必需。	要将团队与之关联的组织的唯一标识符。
`TEAM-ID`	必需	要向其中添加用户的团队的名称。

请求查询参数

以下查询参数为可选参数：

名称

类型

必要性

说明

默认

pretty

布尔

Optional

指示响应正文是否应采用 Prettyprint 的标志格式。

false

envelope

布尔

Optional

指示是否将响应包装在信封中的标志。

某些 API 客户端无法访问 HTTP 响应标头或状态代码。要解决这个问题，可在查询中设置 envelope=true。

对于返回一个结果的端点，响应体包括：

名称	说明
`status`	HTTP 响应代码
`content`	预期响应正文

false

请求正文参数

指定一个文档数组，其中每个文档代表要添加到团队中的一个用户。数组中的每个文档都必须包含以下字段：

名称	类型	说明
`id`	字符串	要添加到团队的用户的唯一 ID

响应

响应文档

响应JSON文档包括一个 result对象数组、一个link对象数组以及检索到的result对象总数。

名称	类型	说明
`results`	阵列	数组为`results`嵌入式文档部分中详细介绍的每一项包含一个对象。
`links`	阵列	数组包含一个或多个指向子资源和/或相关资源的链接。 URL 之间的关系在 Web 链接规范中进行了解释。
`totalCount`	数字	结果集中项目总数的整数计数。如果对整个结果集进行分页，则它可能大于results数组中的对象数。

`results` 嵌入式文档

result数组中的每个元素都是添加到团队中的一个用户。

名称	类型	说明
`country`	字符串	ISO3166 Alpha-2 与用户关联的国家/地区代码。
`emailAddress`	字符串	与用户关联的电子邮件地址。
`firstName`	字符串	用户的名字。
`id`	字符串	团队的唯一标识符。
`lastName`	字符串	用户的姓氏。
`links`	阵列	指向子资源和/或相关资源的一个或多个链接。响应中的所有`links`数组至少包含一个名为`self`的链接。 URL 之间的关系在 Web 链接规范中进行了解释。
`mobileNumber`	字符串	与用户关联的电话号码。
`roles`	阵列	`roles`数组中的每个对象代表用户在关联的`org_id`中所具有的 MongoDB Atlas组织角色
`roles.orgId`	字符串	为用户分配了`roles.roleName`组织角色的组织的 ID。
`roles.roleName`	字符串	针对指定`roles.orgId`分配给用户的组织角色。
`teamsId`	阵列	数组中的每个字符串都是与用户关联的一个团队。
`username`	字符串	与用户关联的用户名。

请求示例

 curl -u "username:apiKey" --digest \
 --header "Accept: application/json" \
 --header "Content-Type: application/json" \
 --request POST "https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0/orgs/{ORG-ID}/teams/{TEAM-ID}/users?pretty=true" \
 --data '[{ "id" : "{USER-ID}" }]'

响应示例

响应标头

HTTP/1.1 401 Unauthorized
Content-Type: application/json;charset=ISO-8859-1
Date: {dateInUnixFormat}
WWW-Authenticate: Digest realm="MMS Public API", domain="", nonce="{nonce}", algorithm=MD5, op="auth", stale=false
Content-Length: {requestLengthInBytes}
Connection: keep-alive

HTTP/1.1 200 OK
Vary: Accept-Encoding
Content-Type: application/json
Strict-Transport-Security: max-age=300
Date: {dateInUnixFormat}
Connection: keep-alive
Content-Length: {requestLengthInBytes}
X-MongoDB-Service-Version: gitHash={gitHash}; versionString={ApplicationVersion}

响应体

{
 "links": [
     {
         "href": "https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0/orgs/{ORG-ID}/teams/{TEAM-ID}/users?pretty=true",
         "rel": "self"
     }
 ],
 "results": [
     {
         "country": "US",
         "emailAddress": "JohnDoe@example.com",
         "firstName": "John",
         "id": "{USER-ID}",
         "lastName": "Doe",
         "links": [
             {
                 "href": "https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0/users/{USER-ID}",
                 "rel": "self"
             }
         ],
         "mobileNumber": "5555550100",
         "roles": [
             {
                 "orgId": "{ORG-ID}",
                 "roleName": "ORG_MEMBER"
             },
             ...
         ],
         "teamIds": [ "{TEAM-ID}" ],
         "username": "JohnDoe@example.com"
     }
 ],
 "totalCount": 1
}

后退

更新一个项目中的团队角色

来年

从团队中删除用户

注意

语法