Listing Received Invitations
Function
This API is used to list all the invitations associated with the specified account. It can be called by any account.
URI
GET https://{endpoint}/v1/received-handshakes
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
limit |
No |
Integer |
Maximum number of results on a page. |
marker |
No |
String |
Pagination marker. |
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. |
Response Parameters
Status code: 200
Parameter |
Type |
Description |
---|---|---|
handshakes |
Array of HandshakeDto objects |
List of invitation (handshake) objects with details about each of the invitations (handshakes) associated with the specified account. |
page_info |
PageInfoDto object |
Pagination information. |
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. |
Parameter |
Type |
Description |
---|---|---|
type |
String |
Target type. It can be account ID or name. |
entity |
String |
If you choose type:account, you must provide the account ID. If you choose type:name, you must specify the account name. |
Parameter |
Type |
Description |
---|---|---|
next_marker |
String |
Marker for the next set of results. If present, more output is available than is included in the current response. Use this value in the marker request parameter in a subsequent call to the operation to get the next part of the output. You should repeat this until the next_marker response element comes back as null. |
current_count |
Integer |
Number of items returned on the current page. |
Example Requests
Listing received invitations
GET https://{endpoint}/v1/received-handshakes
Example Responses
Status code: 200
Successful.
{ "handshakes" : [ { "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" : "pending" } ], "page_info" : { "next_marker" : "ou-taowxgy4xbme6m4x3c2iijbxw7yj8fcw", "current_count" : 100 } }
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.