列出发送的邀请
功能介绍
列出所属组织发送的邀请。此操作只能由组织的管理账号或作为服务委托管理员的成员账号调用。
调试
您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。
URI
GET https://{endpoint}/v1/organizations/handshakes
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
limit |
否 |
Integer |
页面中最大结果数量。 |
|
marker |
否 |
String |
分页标记。 |
请求参数
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
X-Security-Token |
否 |
String |
如果正在使用临时安全凭据，则此header是必需的，该值是临时安全凭据的安全令牌（会话令牌）。 |
响应参数
状态码： 200
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
handshakes |
Array of HandshakeDto objects |
邀请（握手）对象的列表，其中包含与指定账号关联的每个邀请（握手）的详细信息。 |
|
page_info |
PageInfoDto object |
分页信息 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
id |
String |
邀请（握手）的唯一标识符（ID）。源账号在发起邀请（握手）时创建ID。 |
|
urn |
String |
邀请（握手）的统一资源名称。 |
|
updated_at |
String |
邀请（握手）请求被接受、取消、拒绝或到期的日期和时间。 |
|
created_at |
String |
提出邀请（握手）请求的日期和时间。 |
|
expired_at |
String |
邀请（握手）过期的日期和时间。 |
|
management_account_id |
String |
组织管理账号的唯一标识符（ID）。 |
|
management_account_name |
String |
组织管理账号的名称。 |
|
organization_id |
String |
组织的唯一标识符（ID）。 |
|
notes |
String |
给收件账号所有者的邮件中的附加信息。 |
|
target |
TargetDto object |
要邀请加入组织的账号的标识符（ID）。 |
|
status |
String |
邀请（握手）的当前状态, pending：邀请中；accepted：接受邀请；cancelled：取消邀请；declined：拒绝邀请；expired：邀请过期。 |
请求示例
列出发送的邀请
GET https://{endpoint}/v1/organizations/handshakes
响应示例
状态码： 200
Successful.
{
"handshakes" : [ {
"id" : "h-2tnfkrhe64qokwripd2kqrhd7d3079u5",
"urn" : "organizations::0a6d25d23900d45c0faac010e0fb4de0:ou:o-fhkmi6mek7wlqdp6nideqhb47qwtjdsv/ou-fi0rv9jbjgc6nifokh65jjo8c24fnujv",
"updated_at" : "2022-09-23T07:38:15Z",
"created_at" : "2022-09-23T07:38:15Z",
"management_account_id" : "0a6d25d23900d45c0faac010e0fb4de0",
"management_account_name" : "paas_iam_573331",
"organization_id" : "o-fhkmi6mek7wlqdp6nideqhb47qwtjdsv",
"notes" : "test-notes",
"target" : {
"type" : "account",
"entity" : "644c579bea6d473e8ce386e0e8ec449d"
},
"status" : "cancelled"
} ],
"page_info" : {
"next_marker" : "ou-taowxgy4xbme6m4x3c2iijbxw7yj8fcw",
"current_count" : 100
}
}
状态码
|
状态码 |
描述 |
|---|---|
|
200 |
Successful. |
错误码
请参见错误码。
