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

GetMembers

Returns the details for the Security Hub member accounts for the specified account IDs.

An administrator account can be either the delegated Security Hub administrator account for an organization or an administrator account that enabled Security Hub manually.

The results include both member accounts that are managed using Organizations and accounts that were invited manually.

Request Syntax


POST /members/get HTTP/1.1
Content-type: application/json

{
   "AccountIds": [ "string" ]
}

URI Request Parameters

The request does not use any URI parameters.

Request Body

The request accepts the following data in JSON format.

AccountIds

The list of account IDs for the Security Hub member accounts to return the details for.

Type: Array of strings

Pattern: .*\S.*

Required: Yes

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "Members": [ 
      { 
         "AccountId": "string",
         "AdministratorId": "string",
         "Email": "string",
         "InvitedAt": "string",
         "MasterId": "string",
         "MemberStatus": "string",
         "UpdatedAt": "string"
      }
   ],
   "UnprocessedAccounts": [ 
      { 
         "AccountId": "string",
         "ProcessingResult": "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.

Members

The list of details about the Security Hub member accounts.

Type: Array of Member objects

UnprocessedAccounts

The list of AWS accounts that could not be processed. For each account, the list includes the account ID and the email address.

Type: Array of Result objects

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 AWS account or throttling limits. The error code describes the limit exceeded.

HTTP Status Code: 429

ResourceNotFoundException

The request was rejected because we can't find the specified resource.

HTTP Status Code: 404