Updated on 2024-03-15 GMT+08:00

Accepting a Resource Sharing Invitation

Function

This API is used to accept a resource sharing invitation from other accounts.

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/resource-share-invitations/{resource_share_invitation_id}/accept

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

resource_share_invitation_id

Yes

String

ID of the resource sharing invitation.

Minimum: 0

Maximum: 36

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

X-Security-Token

No

String

Security token (session token) for temporary security credentials. This parameter is mandatory when you make an API call using temporary security credentials.

Response Parameters

Status code: 200

Table 3 Response body parameters

Parameter

Type

Description

resource_share_invitation

ResourceShareInvitation object

Details about the resource sharing invitation.

Table 4 ResourceShareInvitation

Parameter

Type

Description

receiver_account_id

String

ID of the account that receives the resource sharing invitation.

Minimum: 0

Maximum: 36

resource_share_id

String

ID of the resource share.

Minimum: 0

Maximum: 36

resource_share_name

String

Name of the resource share.

Minimum: 0

Maximum: 64

resource_share_invitation_id

String

ID of the resource sharing invitation.

Minimum: 0

Maximum: 36

sender_account_id

String

ID of the account that sends a resource sharing invitation.

Minimum: 0

Maximum: 36

status

String

Status of the resource sharing invitation.

Minimum: 0

Maximum: 64

created_at

String

Time when the invitation was created.

updated_at

String

Time when the invitation was last updated.

Example Requests

Accepting resource sharing invitations from other accounts

POST https://{hostname}/v1/resource-share-invitations/{resource_share_invitation_id}/accept

Example Responses

Status code: 200

Request succeeded.

{
  "resource_share_invitation" : {
    "receiver_account_id" : "string",
    "resource_share_id" : "string",
    "resource_share_name" : "string",
    "resource_share_invitation_id" : "string",
    "sender_account_id" : "string",
    "status" : "string",
    "created_at" : "2022-08-22T12:28:26.631Z",
    "updated_at" : "2022-08-22T12:28:26.631Z"
  }
}

Status Codes

Status Code

Description

200

Request succeeded.

Error Codes

See Error Codes.