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

DescribeOrganizationConfiguration

Returns information about the way your organization is configured in Amazon Security Hub CSPM. Only the Security Hub CSPM administrator account can invoke this operation.

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,
   "OrganizationConfiguration": { 
      "ConfigurationType": "string",
      "Status": "string",
      "StatusMessage": "string"
   }
}

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 CSPM in new member accounts when they join the organization.

If set to true, then Security Hub CSPM is automatically enabled in new accounts. If set to false, then Security Hub CSPM isn't enabled in new accounts automatically. The default value is false.

If the ConfigurationType of your organization is set to CENTRAL, then this field is set to false and can't be changed in the home Region and linked Regions. However, in that case, the delegated administrator can create a configuration policy in which Security Hub CSPM is enabled and associate the policy with new organization accounts.

Type: Boolean

AutoEnableStandards

Whether to automatically enable Security Hub CSPM default standards in new member accounts when they join the organization.

If equal to DEFAULT, then Security Hub CSPM default standards are automatically enabled for new member accounts. If equal to NONE, then default standards are not automatically enabled for new member accounts. The default value of this parameter is equal to DEFAULT.

If the ConfigurationType of your organization is set to CENTRAL, then this field is set to NONE and can't be changed in the home Region and linked Regions. However, in that case, the delegated administrator can create a configuration policy in which specific security standards are enabled and associate the policy with new organization accounts.

Type: String

Valid Values: NONE | DEFAULT

MemberAccountLimitReached

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

Type: Boolean

OrganizationConfiguration

Provides information about the way an organization is configured in Amazon Security Hub CSPM.

Type: OrganizationConfiguration object

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