取消邀请
功能介绍
取消邀请，此时邀请状态将设置为已取消。此接口只能由发起邀请的账号调用。取消邀请后，此邀请信息将继续保留并出现在相关API的返回结果中，保留期限为30天。
调试
您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。
URI
POST https://{endpoint}/v1/organizations/handshakes/{handshake_id}/cancel
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
handshake_id |
是 |
String |
邀请的唯一标识符（ID）。账号在发起邀请时创建ID。 |
请求参数
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
X-Security-Token |
否 |
String |
如果正在使用临时安全凭据，则此header是必需的，该值是临时安全凭据的安全令牌（会话令牌）。 |
响应参数
状态码： 200
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
handshake |
HandshakeDto 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：邀请过期。 |
请求示例
取消邀请
POST https://{endpoint}/v1/organizations/handshakes/{handshake_id}/cancel
响应示例
状态码： 200
Successful.
{
"handshake" : {
"id" : "h-awjp43m7bz3b8jgy5v61jrfwakt3og8w",
"urn" : "organizations::0a6d25d23900d45c0faac010e0fb4de0:handshake:o-fhkmi6mek7wlqdp6nideqhb47qwtjdsv/h-awjp43m7bz3b8jgy5v61jrfwakt3og8w",
"updated_at" : "2022-08-25T08:11:53Z",
"created_at" : "2022-08-25T08:11:20Z",
"expired_at" : "2022-09-08T08:11:20Z",
"management_account_id" : "0a6d25d23900d45c0faac010e0fb4de0",
"management_account_name" : "paas_iam_573331",
"organization_id" : "o-fhkmi6mek7wlqdp6nideqhb47qwtjdsv",
"notes" : "test-notes",
"target" : {
"type" : "account",
"entity" : "05c734152f00d4200f2bc0179ac6c5e0"
},
"status" : "cancelled"
}
}
状态码
|
状态码 |
描述 |
|---|---|
|
200 |
Successful. |
错误码
请参见错误码。
