InviteAccountToResourceDirectory の呼び出し - Resource Management

アカウントをリソースディレクトリに招待します。

今すぐお試しください

この API を OpenAPI Explorer でお試しください。手作業による署名は必要ありません。呼び出しに成功すると、入力したパラメーターに基づき、資格情報が組み込まれた SDK コードが自動的に生成されます。このコードをダウンロードしてローカルで使用できます。

テスト

RAM 認証

この操作の認証情報はありません。問題が発生した場合は、アカウントマネージャーにご連絡ください。

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
TargetEntity	string	必須	招待するアカウントの ID またはログインメールアドレス。	someone@example.com
TargetType	string	必須	招待されたアカウントのタイプ。有効な値： Account：アカウントの ID を示します。 Email：アカウントのログインメールアドレスを示します。	Email
Note	string	任意	招待の説明。説明は最大 1,024 文字です。	Welcome
Tag	array<object>	任意	タグ。
	object	任意	タグ。
Key	string	任意	タグキー。	k1
Value	string	任意	タグ値。	v1
ParentFolderId	string	任意	親フォルダの ID。	r-b1****

レスポンスフィールド

フィールド	型	説明	例
	object	返された結果。
RequestId	string	リクエストの ID。	9B34724D-54B0-4A51-B34D-4512372FE1BE
Handshake	object	招待に関する情報。
Status	string	招待のステータス。有効な値： Pending Accepted Cancelled Declined Expired	Pending
ExpireTime	string	招待の有効期限が切れる時刻。時刻は UTC で表示されます。	2018-08-24T09:55:41Z
ResourceDirectoryId	string	リソースディレクトリの ID。	rd-abcdef****
CreateTime	string	招待が作成された時刻。時刻は UTC で表示されます。	2018-08-10T09:55:41Z
Note	string	招待の説明。	Welcome
TargetEntity	string	招待されたアカウントの ID またはログインメールアドレス。	someone@example.com
MasterAccountId	string	リソースディレクトリの管理アカウントの ID。	172841235500****
MasterAccountName	string	リソースディレクトリの管理アカウントの名前。	Alice
ModifyTime	string	招待が変更された時刻。時刻は UTC で表示されます。	2018-08-10T09:55:41Z
TargetType	string	招待されたアカウントのタイプ。有効な値： Account：アカウントの ID を示します。 Email：アカウントのログインメールアドレスを示します。	Email
HandshakeId	string	招待の ID。	h-ycm4rp****

例

成功レスポンス

JSONJSON

{
  "RequestId": "9B34724D-54B0-4A51-B34D-4512372FE1BE",
  "Handshake": {
    "Status": "Pending",
    "ExpireTime": "2018-08-24T09:55:41Z",
    "ResourceDirectoryId": "rd-abcdef****",
    "CreateTime": "2018-08-10T09:55:41Z",
    "Note": "Welcome\n",
    "TargetEntity": "someone@example.com",
    "MasterAccountId": "172841235500****",
    "MasterAccountName": "Alice",
    "ModifyTime": "2018-08-10T09:55:41Z",
    "TargetType": "Email",
    "HandshakeId": "h-ycm4rp****"
  }
}

エラーコード

HTTP ステータスコード	エラーコード	エラーメッセージ
400	MissingParameter.TargetEntity	You must specify TargetEntity.
400	InvalidParameter.TargetEntity	The TargetEntity is invalid.
400	MissingParameter.TargetType	You must specify TargetType.
400	InvalidParameter.TargetType	The TargetType is invalid.
400	InvalidParameter.Note.Length	The length of the invitation note exceeds the limit.
400	InvalidParameter.Note	The Note is invalid.
400	InvalidParameter.ParentFolderId	The ParentFolderId is invalid.
400	InvalidParameter.AccountId	The AccountId is invalid.
404	EntityNotExists.ResourceDirectory	The resource directory for the account is not enabled. We recommend that you first enable the resource directory for the account.
404	EntityNotExists.Folder	The resource directory folder does not exist.
409	LimitExceeded.Account	The maximum number of member accounts in a resource directory exceeds the limit.
409	LimitExceeded.InvitationRate	The number of invitations sent exceeds the limit.
409	EntityAlreadyExists.Handshake	Handshakes with the same target entity already exist.
409	Invalid.AccountType	The specified profile type of account is invalid.
409	EntityAlreadyExists.ResourceDir.Account	This resource directory account already exists.
409	LimitExceeded.Invitation.InvalidTarget	The maximum number of invalid targets that can be invited by a single account is exceeded.
409	NotSupport.AccountInAnotherResourceDirectory	The invited account already belongs to another resource directory. To continue, remove the account from the other resource directory.
409	LegalEntityMismatch	The account does not have the same legal entity as the management account.

完全なリストについては、「エラーコード」をご参照ください。

変更履歴

完全なリストについては、「変更履歴」をご参照ください。