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.

Debugging

You can debug this API through automatic authentication in API Explorer or use the SDK sample code generated by API Explorer.

Authorization Information

Each account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions.

If you are using role/policy-based authorization, see Permissions Policies and Supported Actions for details on the required permissions.
If you are using identity policy-based authorization, the following identity policy-based permissions are required.

Action

Access Level

Resource Type (*: required)

Condition Key

Alias

Dependencies

organizations:receivedHandshakes:list

List

-

-

-

-

Action	Access Level	Resource Type (*: required)	Condition Key	Alias	Dependencies
organizations:receivedHandshakes:list	List	-	-	-	-

URI

GET /v1/received-handshakes

**Table 1** Query Parameters
Parameter	Mandatory	Type	Description
limit	No	Integer	Maximum number of results on the page. If the limit is not specified, the default value is 1,000.
marker	No	String	Definition Pagination marker. Constraints N/A Range The value must comply with the regular expression ^[A-Za-z0-9+/=-_.]+$. The value contains 4 to 400 characters. Default Value No default value

Request Parameters

**Table 2** Request header parameters
Parameter	Mandatory	Type	Description
X-Security-Token	No	String	Definition Security token (session token) of your temporary security credentials. If a temporary security credential is used, this header is required. Constraints N/A Range The value contains 0 to 32,768 characters. Default Value No default value

Response Parameters

Status code: 200

**Table 3** Response body parameters
Parameter	Type	Description
handshakes	Array of HandshakeDto objects	Definition List of invitation (handshake) objects with details about each of the invitations (handshakes) associated with the specified account. Constraints Mandatory Range N/A Default Value No default value
page_info	PageInfoDto object	Definition Pagination information. Constraints N/A Range N/A Default Value No default value

**Table 4** HandshakeDto
Parameter	Type	Description
id	String	Definition Unique ID of an invitation (handshake). The originating account creates the ID when initiating the invitation (handshake). Constraints Mandatory Range The value must comply with the regular expression ^h-[0-9a-z]{8,32}$. The value contains a maximum of 34 characters. Default Value No default value
urn	String	Definition Uniform resource name of an invitation (handshake). Constraints Mandatory Range The value contains 1 to 1,500 characters. Default Value No default value
updated_at	String	Definition Date and time when an invitation (handshake) request was accepted, canceled, declined, or expired. Constraints Mandatory Range The value must be in ISO 8601 format. Default Value No default value
created_at	String	Definition Date and time when an invitation (handshake) request was made. Constraints Mandatory Range The value must be in ISO 8601 format. Default Value No default value
expired_at	String	Definition Date and time when the invitation (handshake) expired. Constraints Mandatory Range The value must be in ISO 8601 format. Default Value No default value
management_account_id	String	Definition Unique ID of the organization's management account. Constraints Mandatory Range The value must comply with the regular expression ^[\w-]+$. The value contains a maximum of 64 characters. Default Value No default value
management_account_name	String	Definition Name of the organization's management account. Constraints Mandatory Range The value must comply with the regular expression ^[\u4e00-\u9fa5a-zA-Z0-9_- ]+$. The value contains a maximum of 64 characters. Default Value No default value
organization_id	String	Definition Unique ID of an organization. Constraints Mandatory Range The value must comply with the regular expression ^o-[0-9a-z]{10,32}$. The value contains a maximum of 34 characters. Default Value No default value
notes	String	Definition Additional information that you want to include in the email to the recipient account owner. Constraints Mandatory Range The value must comply with the regular expression ^[\s\S]$. The value contains a maximum of 1,024 characters. Default Value* No default value
target	TargetDto object	Definition Information about the account to be invited to join an organization. Constraints Mandatory Range N/A Default Value No default value
status	String	Definition Current state of the invitation (handshake). The value can be pending, accepted, cancelled, declined, or expired. Constraints Mandatory Range The value contains 1 to 64 characters. Default Value No default value

**Table 5** TargetDto
Parameter	Type	Description
type	String	Definition Target type. It can be account (account ID) or name (account name). Constraints Mandatory Range The value contains 1 to 64 characters. Default Value No default value
entity	String	Definition If you set type to account, you must provide the account ID. If you set type to name, you must specify the account name. Constraints Mandatory Range The value contains 1 to 100 characters. Default Value No default value

**Table 6** PageInfoDto
Parameter	Type	Description
next_marker	String	Definition 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. Constraints Mandatory Range The value must comply with the regular expression ^[A-Za-z0-9+/=-_]+$. Default Value No default value
current_count	Integer	Definition Number of records returned on this page. Constraints N/A Range The value ranges from 1 to 2000. Default Value No default value

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
  }
}