openapi: 3.2.0
info:
  contact: {}
  description: "Subscribe to Cloud NGFW to start creating your first user; a tenant administrator.  \nA tenant administrator is the highest level of user in the Cloud NGFW service. It provides the ability to add AWS accounts to the Cloud NGFW service and onboard additional users.  \n\nFor more information, see [Subscribe to Cloud NGFW for AWS Service](https://docs.paloaltonetworks.com/cloud-ngfw/aws/cloud-ngfw-on-aws/getting-started-with-cloud-ngfw-for-aws/subscribe-to-the-cloud-ngfw-service.html).\n\n### Permission Policies\n\n| Action                   | Local Firewall Administrator  | Local Rulestack Administrator | Global Rulestack Administrator |\n| ------------------------ | :---------------------------: | :---------------------------: | :----------------------------: |\n| Create NGFW Subscription | ☐                       | ☐                       | ☐                        | \n| List Permission Policies | **☑**                   | **☑**                   | **☑**                    |                       \n"
  title: Manage Subscription API
  version: 1.0.0
servers:
- url: https://api.us-east-1.aws.cloudngfw.paloaltonetworks.com
tags:
- name: ManageSubscription
paths:
  /v1/mgmt/subscribe:
    get:
      description: ''
      operationId: get-v1-mgmt-subscribe
      parameters: []
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ListSubscriptionRequest'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListSubscriptionResponse'
          description: OK
      summary: List CloudNGFW Subscriptions
      tags:
      - ManageSubscription
components:
  schemas:
    ListSubscriptionResponse:
      additionalProperties: false
      properties:
        Response:
          $ref: '#/components/schemas/ListSubscriptionResponse.ResponseData'
        ResponseStatus:
          $ref: '#/components/schemas/ListSubscriptionResponse.Result'
      title: ListSubscriptionResponse
      type: object
    ListSubscriptionResponse.ResponseData:
      additionalProperties: false
      properties:
        Subscriptions:
          items:
            $ref: '#/components/schemas/ListSubscriptionResponse.SubscriptionDetails'
          title: Subscriptions
          type: array
      title: ResponseData
      type: object
    ListSubscriptionRequest:
      additionalProperties: false
      properties: {}
      title: ListSubscriptionRequest
      type: object
    ListSubscriptionResponse.Result:
      additionalProperties: false
      properties:
        ErrorCode:
          default: 0
          title: Errorcode
          type: integer
        Reason:
          title: Reason
          type: string
      title: Result
      type: object
    ListSubscriptionResponse.SubscriptionDetails:
      additionalProperties: false
      properties:
        SubscriptionKey:
          title: Subscriptionkey
          type: string
      required:
      - SubscriptionKey
      title: SubscriptionDetails
      type: object