Skip to content

GetAdminScopeResponse

Source code in docs_src/capo_fms/types/get_admin_scope_response.py 
12
13
14
15
16
class GetAdminScopeResponse(TypedDict, closed=True):
    admin_scope: NotRequired["capo_fms.types.admin_scope.AdminScope"]
    """<p>Contains details about the administrative scope of the requested account.</p>"""
    status: NotRequired["capo_fms.types.organization_status.OrganizationStatus"]
    """<p>The current status of the request to onboard a member account as an Firewall Manager administrator.</p> <ul> <li> <p> <code>ONBOARDING</code> - The account is onboarding to Firewall Manager as an administrator.</p> </li> <li> <p> <code>ONBOARDING_COMPLETE</code> - Firewall Manager The account is onboarded to Firewall Manager as an administrator, and can perform actions on the resources defined in their <a>AdminScope</a>.</p> </li> <li> <p> <code>OFFBOARDING</code> - The account is being removed as an Firewall Manager administrator.</p> </li> <li> <p> <code>OFFBOARDING_COMPLETE</code> - The account has been removed as an Firewall Manager administrator.</p> </li> </ul>"""

admin_scope instance-attribute 

admin_scope: NotRequired[AdminScope]

Contains details about the administrative scope of the requested account.

status instance-attribute 

status: NotRequired[OrganizationStatus]

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.

  • OFFBOARDING - The account is being removed as an Firewall Manager administrator.

  • OFFBOARDING_COMPLETE - The account has been removed as an Firewall Manager administrator.