获取一份组织邀请

在此页面上

所需角色

资源
请求路径参数
请求查询参数
请求正文参数
响应
请求示例
响应示例
响应标头
响应体

检索指定 Ops Manager 组织的一项待处理邀请的详细信息。

所需角色

您可以使用 Organization User Admin角色成功调用此端点。

资源

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

GET /orgs/{ORG-ID}/invites/{INVITATION-ID}

请求路径参数

路径元素	类型	必要性	说明
ORG-ID	字符串	必需	标识组织的唯一 24 位十六进制数字字符串。
INVITATION-ID	字符串	必需	标识该邀请的唯一 24 位十六进制数字字符串。

请求查询参数

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

名称

类型

必要性

说明

默认

pretty

布尔

Optional

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

false

envelope

布尔

Optional

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

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

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

名称	说明
状态	HTTP 响应代码
envelope	预期响应正文

false

请求正文参数

此端点不使用 HTTP 请求正文参数。

响应

名称	类型	说明
createdAt	字符串	ISO8601 格式的时间戳 Ops Manager 发送邀请时的日期和时间（ UTC 格式）。
expiresAt	字符串	ISO8601 格式的时间戳邀请过期时的日期和时间格式（ UTC 格式）。提示用户有 30 天的时间接受 Ops Manager 项目邀请。
id	字符串	标识该邀请的唯一 24 位十六进制数字字符串。
InviterUsername	字符串	邀请用户名加入组织的 Ops Manager 用户。
orgId	字符串	标识组织的唯一 24 位十六进制数字字符串。
orgName	字符串	组织名称。
角色	字符串数组	要分配给受邀用户的 Ops Manager角色。如果用户接受邀请，Ops Manager 就会为其分配这些角色。
teamIds	字符串数组	唯一的 24 位十六进制数字字符串，用于标识用户受邀加入的团队。
用户名	字符串	Ops Manager 向其发送邀请的电子邮件地址。如果用户接受邀请，他们将使用此电子邮件地址作为 Ops Manager 用户名。

请求示例

curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest --include \
     --header "Accept: application/json" \
     --request GET "https://opsmanager.example.com/api/public/v1.0/orgs/{ORG-ID}/invites/{INVITATION-ID}?pretty=true"

响应示例

响应标头

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}

响应体

1 {
2   "createdAt": "2021-02-18T21:05:40Z",
3   "expiresAt": "2021-03-20T21:05:40Z",
4   "id": "{INVITATION-ID}",
5   "inviterUsername": "admin@example.com",
6   "orgId": "{ORG-ID}",
7   "orgName": "{ORG-NAME}",
8   "roles": [
9     "ORG_MEMBER"
10   ],
11   "teamIds": [],
12   "username": "wyatt.smith@example.com"
13 }

← 获取所有组织邀请

按邀请 ID 更新一个组织邀请 →

1	{
2	"createdAt": "2021-02-18T21:05:40Z",
3	"expiresAt": "2021-03-20T21:05:40Z",
4	"id": "{INVITATION-ID}",
5	"inviterUsername": "admin@example.com",
6	"orgId": "{ORG-ID}",
7	"orgName": "{ORG-NAME}",
8	"roles": [
9	"ORG_MEMBER"
10	],
11	"teamIds": [],
12	"username": "wyatt.smith@example.com"
13	}