POST

/detector/{detectorId}/member/invite

http://guardduty.{region}.amazonaws.com/detector/{detectorId}/member/invite

Invites other Amazon Web Services accounts (created as members of the current Amazon Web Services account by CreateMembers) to enable GuardDuty, and allow the current Amazon Web Services account to view and manage these accounts' findings on their behalf as the GuardDuty administrator account.

Access Token Required: API Key

Path Parameters

detectorIdstringrequired

The unique ID of the detector of the GuardDuty account that you want to invite members with.

Body Params

messagestring

The invitation message that you want to send to the accounts that you're inviting to GuardDuty as members.

accountIdsarrayrequired

A list of account IDs of the accounts that you want to invite to GuardDuty as members.

disableEmailNotificationboolean

A Boolean value that specifies whether you want to disable email notification to the accounts that you are inviting to GuardDuty as members.

Responses

{
  "success": true,
  "data": {
    "id": "abc123",
    "created_at": "2025-01-01T00:00:00Z"
  }
}

{
  "success": false,
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "Invalid request parameters"
  }
}

Language

CredentialsAPI KEY

API Key

Enter token below to save for later

cURL Request

1curl --request POST \
2     --url 'http://guardduty.{region}.amazonaws.com/detector/{detectorId}/member/invite' \
3     --header 'accept: application/json' \
4     --header 'content-type: application/json'

Response

1{
2  "success": true,
3  "data": {
4    "id": "abc123",
5    "created_at": "2025-01-01T00:00:00Z"
6  }
7}