Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

DescribeOrganizationConfiguration

Returns information about the Organizations configuration for Security Hub. Can only be called from a Security Hub administrator account.

Request Syntax


GET /organization/configuration HTTP/1.1

URI Request Parameters

The request does not use any URI parameters.

Request Body

The request does not have a request body.

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "AutoEnable": boolean,
   "AutoEnableStandards": "string",
   "MemberAccountLimitReached": boolean
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

AutoEnable

Whether to automatically enable Security Hub for new accounts in the organization.

If set to true, then Security Hub is enabled for new accounts. If set to false, then new accounts are not added automatically.

Type: Boolean

AutoEnableStandards

Whether to automatically enable Security Hub default standards for new member accounts in the organization.

The default value of this parameter is equal to DEFAULT.

If equal to DEFAULT, then Security Hub default standards are automatically enabled for new member accounts. If equal to NONE, then default standards are not automatically enabled for new member accounts.

Type: String

Valid Values: NONE | DEFAULT

MemberAccountLimitReached

Whether the maximum number of allowed member accounts are already associated with the Security Hub administrator account.

Type: Boolean

Errors

For information about the errors that are common to all actions, see Common Errors.

InternalException

Internal server error.

HTTP Status Code: 500

InvalidAccessException

The account doesn't have permission to perform this action.

HTTP Status Code: 401

InvalidInputException

The request was rejected because you supplied an invalid or out-of-range value for an input parameter.

HTTP Status Code: 400

LimitExceededException

The request was rejected because it attempted to create resources beyond the current Amazon account or throttling limits. The error code describes the limit exceeded.

HTTP Status Code: 429