Inviting an Account to Join an Organization
Function
This API is used to send an invitation to another account. The invited account will join your organization as a member account. This API can be called only from the organization's management account.
URI
POST https://{endpoint}/v1/organizations/accounts/invite
Request Parameters
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
X-Security-Token |
No |
String |
Security token (session token) of your temporary security credentials. If a temporary security credential is used, this header is required. |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
target |
Yes |
TargetDto object |
ID of the account that you want to invite to join your organization. |
notes |
Yes |
String |
Additional information that you want to include in the email to the recipient account owner. |
tags |
No |
Array of TagDto objects |
List of tags you want to attach to the new account. |
Response Parameters
Status code: 200
Parameter |
Type |
Description |
---|---|---|
handshake |
HandshakeDto object |
Information to be exchanged between two accounts (sender and receiver) for establishing a secure relationship. For example, when a management account (the sender) invites another account (the receiver) to join its organization, the two accounts exchange information as a series of invitation (handshake) requests and responses, which are contained in this structure. |
Parameter |
Type |
Description |
---|---|---|
id |
String |
Unique ID of an invitation (handshake). The originating account creates the ID when initiating the invitation (handshake). |
urn |
String |
Uniform resource name of the invitation (handshake). |
updated_at |
String |
Date and time when an invitation (handshake) request was accepted, canceled, declined, or expired. |
created_at |
String |
Date and time when an invitation (handshake) request was made. |
expired_at |
String |
The date and time the invitation (handshake) expires. |
management_account_id |
String |
Unique ID of the organization's management account. |
management_account_name |
String |
Name of the organization's management account. |
organization_id |
String |
Unique ID of an organization. |
notes |
String |
Additional information that you want to include in the email to the recipient account owner. |
target |
TargetDto object |
ID of the account that you want to invite to join your organization. |
status |
String |
Current state of the invitation (handshake). It can be pending, accepted, cancelled, declined, or expired. |
Example Requests
Inviting an account to join an organization
POST https://{endpoint}/v1/organizations/accounts/invite { "target" : { "type" : "account", "entity" : "05c734152f00d4200f2bc0179ac6c5e0" }, "notes" : "test-notes", "tags" : [ { "key" : "keystring", "value" : "valuestring" } ] }
Example Responses
Status code: 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" } }
Status Codes
Status Code |
Description |
---|---|
200 |
Successful. |
Error Codes
See Error Codes.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.