Describe Member accounts and cross account Roles

GET 
/v1/mgmt/xaccountroles/:accountid

Retrieve the information of a specific account.

Request

Path Parameters

accountid stringrequired

The unique ID of the account.

Query Parameters

describeaccount Describeaccount

Retrieve the information of a specific account.

vpcid Vpcid

The unique identifier of the VPC.

Responses

200

OK

application/json

Schema

Schema

Response object
AccountGroups string[]
Combination of multiple cloud accounts with similar or different applications.
AccountId Accountid (string)
Possible values: <= 12 characters, Value must match regular expression ^$|^[0-9]+$
The unique ID of the account.
AllowedMode Allowedmode (string)
Possible values: [ServiceManaged, CustomerManaged]
Specify the mode.
AvailabilityZones string[]
CloudTrailRole Cloudtrailrole (string)
Supports a service-linked role for integration with AWS.
DefaultRole Defaultrole (string)
The default IAM role.
Firewall object
Name of the firewall.
EndpointRole Endpointrole (string)
Endpoint role permissions.
LoggingRole Loggingrole (string)
Logging role permissions.
OnboardingStatus AccountTableEntryStatus (string)
Possible values: [Success, Pending, Deleting, OffBoarding, DeleteFailed]
The account onboarding status.
RuleStack object
Name of the rulestack.
DecryptionRole Decryptionrole (string)
Decryption role permissions.
VpcInformations object[]
Details of the VPC.
Array [
SubnetInformations object[]
Details of the subnet.
Array [
SubnetId Subnetid (string)required
The unique ID of the subnet in your VPC.
SubnetName Subnetname (string)
Name of the subnet.
]
VpcId Vpcid (string)required
The unique identifier of the VPC.
VpcName Vpcname (string)
Name of the VPC.
]
ResponseStatus object

ErrorCode Errorcode (integer)

Default value: 0

Default value of a successful response is 0. Any other number indicates an error code.

400—HTTP bad request

• InvalidOperationException—Operation failed because it is not valid. For example, when you delete an NGFW or rulestack in use.
• InvalidRequestException—Operation failed due to invalid request. For example, unsupported parameter name or value in the request.
• LimitExceededException—Operation failed due to violation in limit settings.
• ResourceNotFoundException—Unable to locate a resource using the parameters you provided.
• ThrottlingException—Operation failed due to throttling limitations.

500—Bad request

• InternalServerError—Your request is valid but Cloud NGFW could not perform the operation due to a system issue.

Reason Reason (string)

The error description

Example (from schema)

{
  "Response": {
    "AccountGroups": [
      "string"
    ],
    "AccountId": "string",
    "AllowedMode": "ServiceManaged",
    "AvailabilityZones": [
      "string"
    ],
    "CloudTrailRole": "string",
    "DefaultRole": "string",
    "Firewall": {
      "EndpointRole": "string",
      "LoggingRole": "string"
    },
    "OnboardingStatus": "Success",
    "RuleStack": {
      "DecryptionRole": "string"
    },
    "VpcInformations": [
      {
        "SubnetInformations": [
          {
            "SubnetId": "string",
            "SubnetName": "string"
          }
        ],
        "VpcId": "string",
        "VpcName": "string"
      }
    ]
  },
  "ResponseStatus": {
    "ErrorCode": 0,
    "Reason": "string"
  }
}

Loading...