邀请账号加入组织 - InviteAccount

功能介绍

向另一个账号发送邀请，受邀账号将以成员账号加入您的组织。此操作只能由组织的管理账号调用。

调试

您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。

授权信息

账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。

如果使用角色与策略授权，具体权限要求请参见权限和授权项。
如果使用身份策略授权，需具备如下身份策略权限。
授权项
访问级别
资源类型（*为必须）
条件键
别名
依赖的授权项
organizations:accounts:invite
Write
-
g:RequestTag/<tag-key>
g:TagKeys
-
organizations:resources:tag

授权项	访问级别	资源类型（*为必须）	条件键	别名	依赖的授权项
organizations:accounts:invite	Write	-	g:RequestTag/<tag-key> g:TagKeys	-	organizations:resources:tag

URI

POST /v1/organizations/accounts/invite

请求参数

表1 请求Header参数
参数	是否必选	参数类型	描述
X-Security-Token	否	String	如果正在使用临时安全凭据，则此header是必需的，该值是临时安全凭据的安全令牌（会话令牌）。

表2 请求Body参数
参数	是否必选	参数类型	描述
target	是	TargetDto object	要邀请加入组织的账号的标识符（ID）。
notes	是	String	给收件账号所有者的邮件中的附加信息。
tags	否	Array of TagDto objects	要绑定到新创建的账号的标签列表。

表3 TargetDto
参数	是否必选	参数类型	描述
type	是	String	目标类型，account：账户id，name：账户名称。
entity	是	String	如果指定 'type:account'，则必须提供账号ID作为实体。如果指定 'type:name'，则必须指定账号名称作为实体。

表4 TagDto
参数	是否必选	参数类型	描述
key	是	String	标签键的密钥标识符或名称。
value	是	String	与标签键关联的字符串值。您可以将标签的值设置为空字符串，但不能将标签的值设置为NULL。

响应参数

状态码：200

表5 响应Body参数
参数	参数类型	描述
handshake	HandshakeDto object	两个账号（发起者和接收者）之间为了能安全地建立关系，所需要交换的信息。例如，当管理账号（发起者）邀请另一个账号（接收者）加入其组织时，两个账号一系列邀请（握手）请求和响应交换信息。

表6 HandshakeDto
参数	参数类型	描述
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：邀请过期。

表7 TargetDto
参数	参数类型	描述
type	String	目标类型，account：账户id，name：账户名称。
entity	String	如果指定 'type:account'，则必须提供账号ID作为实体。如果指定 'type:name'，则必须指定账号名称作为实体。

请求示例

邀请账号加入组织

POST https://{endpoint}/v1/organizations/accounts/invite

{
  "target" : {
    "type" : "account",
    "entity" : "05c734152f00d4200f2bc0179ac6c5e0"
  },
  "notes" : "test-notes",
  "tags" : [ {
    "key" : "keystring",
    "value" : "valuestring"
  } ]
}

响应示例

状态码：200

Successful.

{
  "handshake" : {
    "id" : "h-awjp43m7bz3b8jgy5v61jrfwakt3og8w",
    "urn" : "organizations::0a6d25d23900d45c0faac010e0fb4de0:policy:o-fhkmi6mek7wlqdp6nideqhb47qwtjdsv/service_control_policy/p-b4wpejd02o66g0pvfinvsatp4t9krfum",
    "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" : "pending"
  }
}