Skip to content

Returns information about the specified account's administrative scope

Description

Returns information about the specified account's administrative scope. The administrative scope defines the resources that an Firewall Manager administrator can manage.

Usage

fms_get_admin_scope(AdminAccount)

Arguments

  • AdminAccount

    [required] The administrator account that you want to get the details for.

Value

A list with the following syntax:

list(
  AdminScope = list(
    AccountScope = list(
      Accounts = list(
        "string"
      ),
      AllAccountsEnabled = TRUE|FALSE,
      ExcludeSpecifiedAccounts = TRUE|FALSE
    ),
    OrganizationalUnitScope = list(
      OrganizationalUnits = list(
        "string"
      ),
      AllOrganizationalUnitsEnabled = TRUE|FALSE,
      ExcludeSpecifiedOrganizationalUnits = TRUE|FALSE
    ),
    RegionScope = list(
      Regions = list(
        "string"
      ),
      AllRegionsEnabled = TRUE|FALSE
    ),
    PolicyTypeScope = list(
      PolicyTypes = list(
        "WAF"|"WAFV2"|"SHIELD_ADVANCED"|"SECURITY_GROUPS_COMMON"|"SECURITY_GROUPS_CONTENT_AUDIT"|"SECURITY_GROUPS_USAGE_AUDIT"|"NETWORK_FIREWALL"|"DNS_FIREWALL"|"THIRD_PARTY_FIREWALL"|"IMPORT_NETWORK_FIREWALL"|"NETWORK_ACL_COMMON"
      ),
      AllPolicyTypesEnabled = TRUE|FALSE
    )
  ),
  Status = "ONBOARDING"|"ONBOARDING_COMPLETE"|"OFFBOARDING"|"OFFBOARDING_COMPLETE"
)

Request syntax

svc$get_admin_scope(
  AdminAccount = "string"
)