# GetAdminScope


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

## Request Syntax


```
{
   "AdminAccount": "string"
}
```

## Request Parameters


For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [AdminAccount](#API_GetAdminScope_RequestSyntax) **   <a name="fms-GetAdminScope-request-AdminAccount"></a>
The administrator account that you want to get the details for.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1024.  
Pattern: `^[0-9]+$`   
Required: Yes

## Response Syntax


```
{
   "AdminScope": { 
      "AccountScope": { 
         "Accounts": [ "string" ],
         "AllAccountsEnabled": boolean,
         "ExcludeSpecifiedAccounts": boolean
      },
      "OrganizationalUnitScope": { 
         "AllOrganizationalUnitsEnabled": boolean,
         "ExcludeSpecifiedOrganizationalUnits": boolean,
         "OrganizationalUnits": [ "string" ]
      },
      "PolicyTypeScope": { 
         "AllPolicyTypesEnabled": boolean,
         "PolicyTypes": [ "string" ]
      },
      "RegionScope": { 
         "AllRegionsEnabled": boolean,
         "Regions": [ "string" ]
      }
   },
   "Status": "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.

 ** [AdminScope](#API_GetAdminScope_ResponseSyntax) **   <a name="fms-GetAdminScope-response-AdminScope"></a>
Contains details about the administrative scope of the requested account.  
Type: [AdminScope](API_AdminScope.md) object

 ** [Status](#API_GetAdminScope_ResponseSyntax) **   <a name="fms-GetAdminScope-response-Status"></a>
The current status of the request to onboard a member account as an Firewall Manager administrator.  
+  `ONBOARDING` - The account is onboarding to Firewall Manager as an administrator.
+  `ONBOARDING_COMPLETE` - Firewall Manager The account is onboarded to Firewall Manager as an administrator, and can perform actions on the resources defined in their [AdminScope](API_AdminScope.md).
+  `OFFBOARDING` - The account is being removed as an Firewall Manager administrator.
+  `OFFBOARDING_COMPLETE` - The account has been removed as an Firewall Manager administrator.
Type: String  
Valid Values: `ONBOARDING | ONBOARDING_COMPLETE | OFFBOARDING | OFFBOARDING_COMPLETE` 

## Errors


For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InternalErrorException **   
The operation failed because of a system problem, even though the request was valid. Retry your request.  
HTTP Status Code: 400

 ** InvalidInputException **   
The parameters of the request were invalid.  
HTTP Status Code: 400

 ** InvalidOperationException **   
The operation failed because there was nothing to do or the operation wasn't possible. For example, you might have submitted an `AssociateAdminAccount` request for an account ID that was already set as the AWS Firewall Manager administrator. Or you might have tried to access a Region that's disabled by default, and that you need to enable for the Firewall Manager administrator account and for AWS Organizations before you can access it.  
HTTP Status Code: 400

 ** LimitExceededException **   
The operation exceeds a resource limit, for example, the maximum number of `policy` objects that you can create for an AWS account. For more information, see [Firewall Manager Limits](https://docs.aws.amazon.com/waf/latest/developerguide/fms-limits.html) in the * AWS WAF Developer Guide*.  
HTTP Status Code: 400

 ** ResourceNotFoundException **   
The specified resource was not found.  
HTTP Status Code: 400

## See Also


For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/fms-2018-01-01/GetAdminScope) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/fms-2018-01-01/GetAdminScope) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/fms-2018-01-01/GetAdminScope) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/fms-2018-01-01/GetAdminScope) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/fms-2018-01-01/GetAdminScope) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/fms-2018-01-01/GetAdminScope) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/fms-2018-01-01/GetAdminScope) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/fms-2018-01-01/GetAdminScope) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/fms-2018-01-01/GetAdminScope) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/fms-2018-01-01/GetAdminScope)