All Products
Search
Document Center

Resource Management:InviteAccountToResourceDirectory

Last Updated:Jun 05, 2024

Invites an account to join a resource directory.

Operation description

This topic provides an example on how to call the API operation to invite the account someone@example.com to join a resource directory.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

  • Operation: the value that you can use in the Action element to specify the operation on a resource.
  • Access level: the access level of each operation. The levels are read, write, and list.
  • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
    • The required resource types are displayed in bold characters.
    • If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
  • Condition Key: the condition key that is defined by the cloud service.
  • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
OperationAccess levelResource typeCondition keyAssociated operation
resourcemanager:InviteAccountToResourceDirectoryWrite
  • All Resources
    *
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
TargetEntitystringYes

The ID or logon email address of the account that you want to invite.

someone@example.com
TargetTypestringYes

The type of the account. Valid values:

  • Account: indicates the ID of the account.
  • Email: indicates the logon email address of the account.
Email
NotestringNo

The comment on the invitation.

The comment can be up to 1,024 characters in length.

Welcome
Tagobject []No

The tag key and value.

KeystringNo

A tag key.

k1
ValuestringNo

A tag value.

v1

For more information about common request parameters, see Common parameters.

Response parameters

ParameterTypeDescriptionExample
object
RequestIdstring

The ID of the request.

9B34724D-54B0-4A51-B34D-4512372FE1BE
Handshakeobject

The information of the invitation.

Statusstring

The status of the invitation.

  • Pending: The invitation is waiting for confirmation.
  • Accepted: The invitation is accepted.
  • Cancelled: The invitation is canceled.
  • Declined: The invitation is rejected.
  • Expired: The invitation expires.
Pending
ExpireTimestring

The time when the invitation expires. The time is displayed in UTC.

2018-08-24T09:55:41Z
ResourceDirectoryIdstring

The ID of the resource directory.

rd-abcdef****
CreateTimestring

The time when the invitation was created. The time is displayed in UTC.

2018-08-10T09:55:41Z
Notestring

The comment on the invitation.

Welcome
TargetEntitystring

The ID or logon email address of the invited account.

someone@example.com
MasterAccountIdstring

The ID of the management account of the resource directory.

172841235500****
MasterAccountNamestring

The name of the management account of the resource directory.

Alice
ModifyTimestring

The time when the invitation was modified. The time is displayed in UTC.

2018-08-10T09:55:41Z
TargetTypestring

The type of the invited account. Valid values:

  • Account: indicates the ID of the account.
  • Email: indicates the logon email address of the account.
Email
HandshakeIdstring

The ID of the invitation.

h-ycm4rp****

Examples

Sample success responses

JSONformat

{
  "RequestId": "9B34724D-54B0-4A51-B34D-4512372FE1BE",
  "Handshake": {
    "Status": "Pending",
    "ExpireTime": "2018-08-24T09:55:41Z",
    "ResourceDirectoryId": "rd-abcdef****",
    "CreateTime": "2018-08-10T09:55:41Z",
    "Note": "Welcome",
    "TargetEntity": "someone@example.com",
    "MasterAccountId": "172841235500****",
    "MasterAccountName": "Alice",
    "ModifyTime": "2018-08-10T09:55:41Z",
    "TargetType": "Email",
    "HandshakeId": "h-ycm4rp****"
  }
}

Error codes

HTTP status codeError codeError messageDescription
400MissingParameter.TargetEntityYou must specify TargetEntity.-
400InvalidParameter.TargetEntityThe TargetEntity is invalid.-
400MissingParameter.TargetTypeYou must specify TargetType.-
400InvalidParameter.TargetTypeThe TargetType is invalid.-
400InvalidParameter.Note.LengthThe length of the invitation note exceeds the limit.-
400InvalidParameter.NoteThe Note is invalid.-
404EntityNotExists.ResourceDirectoryThe resource directory for the account is not enabled. We recommend that you first enable the resource directory for the account.The resource directory for the account is not enabled. We recommend that you first enable the resource directory for the account.
409LimitExceeded.AccountThe maximum number of member accounts in a resource directory exceeds the limit.The maximum number of member accounts in a resource directory exceeds the limit.
409LimitExceeded.InvitationRateThe number of invitations sent exceeds the limit.-
409EntityAlreadyExists.HandshakeHandshakes with the same target entity already exist.-
409NotSupport.AccountInAnotherResourceDirectoryThe specified account is an Alibaba Cloud account or already exists in another resource directory.-
409LegalEntityMismatchYour account does not have the same legal entity as the master account.-
409Invalid.AccountTypeThe specified profile type of account is invalid.The specified AccountType is invalid.

For a list of error codes, visit the Service error codes.

Change history

Change timeSummary of changesOperation
2023-09-04The Error code has changedsee changesets
Change itemChange content
Error CodesThe Error code has changed.
    Error Codes 409 change
    delete Error Codes: 400
    delete Error Codes: 404