Canceling an Invitation
Function
This API is used to cancel an invitation. This sets the invitation state to Canceled. This API can be called only from the account that initiated the invitation. After you cancel an invitation, the invitation information continues to appear in the results of relevant APIs for 30 days.
Debugging
You can debug this API through automatic authentication in API Explorer or use the SDK sample code generated by API Explorer.
URI
POST /v1/organizations/handshakes/{handshake_id}/cancel
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
handshake_id |
Yes |
String |
Unique ID of an invitation. The originating account creates the ID when initiating the invitation. Maximum: 34 |
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. Minimum: 1 |
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). Maximum: 34 |
urn |
String |
Uniform resource name of the invitation (handshake). Minimum: 1 Maximum: 1500 |
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. |
management_account_id |
String |
Unique ID of the organization's management account. Maximum: 64 |
management_account_name |
String |
Name of the organization's management account. Maximum: 64 |
organization_id |
String |
Unique ID of an organization. Maximum: 34 |
notes |
String |
Additional information that you want to include in the email to the recipient account owner. Maximum: 1024 |
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. Minimum: 1 Maximum: 64 |
Parameter |
Type |
Description |
---|---|---|
type |
String |
Target type. It can be account or email. Minimum: 1 Maximum: 64 |
entity |
String |
If you choose type:account, you must provide the account ID. If you choose type:email, you must specify the email address that is associated with the account. Maximum: 100 |
Example Requests
Canceling an invitation
POST https://{hostname}/v1/organizations/handshakes/{handshake_id}/cancel
Example Responses
Status code: 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", "management_account_id" : "0a6d25d23900d45c0faac010e0fb4de0", "management_account_name" : "paas_iam_573331", "organization_id" : "o-fhkmi6mek7wlqdp6nideqhb47qwtjdsv", "notes" : "test-notes", "target" : { "type" : "account", "entity" : "05c734152f00d4200f2bc0179ac6c5e0" }, "status" : "cancelled" } }
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.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot