POST

/detector/{detectorId}/admin

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

Configures the delegated administrator account with the provided values. You must provide the value for either <code>autoEnableOrganizationMembers</code> or <code>autoEnable</code>. There might be regional differences because some data sources might not be available in all the Amazon Web Services Regions where GuardDuty is presently supported. For more information, see <a href="https://docs.aws.amazon.com/guardduty/latest/ug/guardduty_regions.html">Regions and endpoints</a>.

Access Token Required: API Key

Path Parameters

detectorIdstringrequired

The ID of the detector that configures the delegated administrator.

Body Params

featuresarray

A list of features that will be configured for the organization.

autoEnableboolean

Indicates whether to automatically enable member accounts in the organization. Even though this is still supported, we recommend using <code>AutoEnableOrganizationMembers</code> to achieve the similar results.

dataSourcesobject

An object that contains information on which data sources will be configured to be automatically enabled for new members within the organization.

autoEnableOrganizationMembersstring

Indicates the auto-enablement configuration of GuardDuty for the member accounts in the organization. <ul> <li> <code>NEW</code>: Indicates that when a new account joins the organization, they will have GuardDuty enabled automatically. </li> <li> <code>ALL</code>: Indicates that all accounts in the Amazon Web Services Organization have GuardDuty enabled automatically. This includes <code>NEW</code> accounts that join the organization and accounts that may have been suspended or removed from the organization in GuardDuty. </li> <li> <code>NONE</code>: Indicates that GuardDuty will not be automatically enabled for any accounts in the organization. GuardDuty must be managed for each account individually by the administrator. </li> </ul>

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}/admin' \
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}