Skip to content

List Admin Accounts For Organization

fms_list_admin_accounts_for_organization R Documentation

Returns a AdminAccounts object that lists the Firewall Manager administrators within the organization that are onboarded to Firewall Manager by AssociateAdminAccount

Description

Returns a AdminAccounts object that lists the Firewall Manager administrators within the organization that are onboarded to Firewall Manager by associate_admin_account.

This operation can be called only from the organization's management account.

Usage

fms_list_admin_accounts_for_organization(NextToken, MaxResults)

Arguments

NextToken

When you request a list of objects with a MaxResults setting, if the number of objects that are still available for retrieval exceeds the maximum you requested, Firewall Manager returns a NextToken value in the response. To retrieve the next batch of objects, use the token returned from the prior request in your next request.

MaxResults

The maximum number of objects that you want Firewall Manager to return for this request. If more objects are available, in the response, Firewall Manager provides a NextToken value that you can use in a subsequent call to get the next batch of objects.

Value

A list with the following syntax:

list(
  AdminAccounts = list(
    list(
      AdminAccount = "string",
      DefaultAdmin = TRUE|FALSE,
      Status = "ONBOARDING"|"ONBOARDING_COMPLETE"|"OFFBOARDING"|"OFFBOARDING_COMPLETE"
    )
  ),
  NextToken = "string"
)

Request syntax

svc$list_admin_accounts_for_organization(
  NextToken = "string",
  MaxResults = 123
)