Skip to main content

Describe Link Account

GET 
/v1/mgmt/linkaccounts/:accountid

View the details of the account IDs associated with the FMS account.

Request​

Path Parameters

    accountid stringrequired

    The unique ID of the account.

Body

    object

Responses​

OK

Schema
    Response object

    The API call response.

    AccountId Accountid (string)

    Possible values: <= 12 characters, Value must match regular expression ^$|^[0-9]+$

    The unique ID of the account.

    CloudFormationTemplateURL Cloudformationtemplateurl (string)

    The CFT URL.

    ExternalId Externalid (string)

    A randomly generated UUID used to enable trust relationship in the role's policy.

    OnboardingStatus AccountTableEntryStatus (string)

    Possible values: [Success, Pending, Deleting, OffBoarding, DeleteFailed]

    An enumeration.

    ServiceAccountId Serviceaccountid (string)

    Possible values: <= 12 characters, Value must match regular expression ^$|^[0-9]+$

    The unique ID of the dedicated service account.

    SnsTopicArn Snstopicarn (string)

    The SNS topic ARN.

    ResponseStatus object

    The API call response status.

    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

Loading...