Palo Alto Networks User Onboarding Link Account API

The UserOnboarding-LinkAccount API from Palo Alto Networks — 2 operation(s) for useronboarding-linkaccount.

Operations 2

GET /v1/mgmt/linkaccounts List linked accounts #
GET /v1/mgmt/linkaccounts/{accountid} Retrieve linked account #

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API
curl "https://apis.io/api/v1/apis/palo-alto-networks-useronboarding-linkaccount-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

palo-alto-networks-useronboarding-linkaccount-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  contact: {}
  description: "Cloud NGFW requires you to onboard an AWS account to create and manage the resources required by Cloud NGFW. The Cloud NGFW service uses a CloudFormation template (CFT) stack to create these roles needed for Cloud NGFW to access resources in your AWS environment.  \n\nA link account is an unverified account used to onboard an AWS account to a cloud NGFW service based on your input. A link account is required to run the CFT.  \n\n>**Note:** You can add only one link account per subscription.\n\n### Permission Policies\n\n| Action                   | Local Firewall Administrator  | Local Rulestack Administrator | Global Rulestack Administrator |\n| ------------------------ | :---------------------------: | :---------------------------: | :----------------------------: | \n| Create Link Account      | ☐                       | ☐                       | ☐                        | \n| Delete Link Account      | ☐                       | ☐                       | ☐                        |                        \n| Describe Link Account    | **☑**                   | **☑**                   | **☑**                    | \n| List Link Account        | **☑**                   | **☑**                   | **☑**                    |\n"
  title: User Onboarding using Link Account User Onboarding Link Account API
  version: 1.0.0
servers:
- url: https://api.us-east-1.aws.cloudngfw.paloaltonetworks.com
tags:
- name: UserOnboarding-LinkAccount
paths:
  /v1/mgmt/linkaccounts:
    get:
      description: 'List all accounts linked with the admin account.

        '
      operationId: get-v1-mgmt-linkaccounts
      parameters: []
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ListLinkAccountsRequest'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListLinkAccountsResponse'
          description: OK
      summary: List linked accounts
      tags:
      - UserOnboarding-LinkAccount
  /v1/mgmt/linkaccounts/{accountid}:
    get:
      description: 'Retrieve the details of account IDs associated with the admin account.

        '
      operationId: get-v1-mgmt-linkaccounts-accountid
      parameters:
      - description: 'The unique ID of the account.

          '
        in: path
        name: accountid
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DescribeLinkAccountRequest'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DescribeLinkAccountResponse'
          description: OK
      summary: Retrieve linked account
      tags:
      - UserOnboarding-LinkAccount
components:
  schemas:
    ListLinkAccountsResponse.ResponseData:
      additionalProperties: false
      properties:
        AccountIds:
          items:
            maxLength: 12
            pattern: ^$|^[0-9]+$
            type: string
          title: Accountids
          type: array
      title: ResponseData
      type: object
    DescribeLinkAccountResponse.AccountTableEntryStatus:
      description: An enumeration.
      enum:
      - Success
      - Pending
      - Deleting
      - OffBoarding
      - DeleteFailed
      title: AccountTableEntryStatus
      type: string
    ListLinkAccountsRequest:
      additionalProperties: false
      properties: {}
      title: ListLinkAccountsRequest
      type: object
    ListLinkAccountsResponse:
      additionalProperties: false
      properties:
        Response:
          $ref: '#/components/schemas/ListLinkAccountsResponse.ResponseData'
        ResponseStatus:
          $ref: '#/components/schemas/ListLinkAccountsResponse.Result'
      title: ListLinkAccountsResponse
      type: object
    ListLinkAccountsResponse.Result:
      additionalProperties: false
      properties:
        ErrorCode:
          default: 0
          title: Errorcode
          type: integer
        Reason:
          title: Reason
          type: string
      title: Result
      type: object
    DescribeLinkAccountResponse:
      additionalProperties: false
      properties:
        Response:
          $ref: '#/components/schemas/DescribeLinkAccountResponse.ResponseData'
        ResponseStatus:
          $ref: '#/components/schemas/DescribeLinkAccountResponse.Result'
      title: DescribeLinkAccountResponse
      type: object
    DescribeLinkAccountRequest:
      additionalProperties: false
      properties: {}
      title: DescribeLinkAccountRequest
      type: object
    DescribeLinkAccountResponse.ResponseData:
      additionalProperties: false
      properties:
        AccountId:
          maxLength: 12
          pattern: ^$|^[0-9]+$
          title: Accountid
          type: string
        CloudFormationTemplateURL:
          title: Cloudformationtemplateurl
          type: string
        ExternalId:
          title: Externalid
          type: string
        OnboardingStatus:
          allOf:
            $ref: '#/components/schemas/DescribeLinkAccountResponse.AccountTableEntryStatus'
          default: Pending
        ServiceAccountId:
          maxLength: 12
          pattern: ^$|^[0-9]+$
          title: Serviceaccountid
          type: string
        SnsTopicArn:
          title: Snstopicarn
          type: string
      title: ResponseData
      type: object
    DescribeLinkAccountResponse.Result:
      additionalProperties: false
      properties:
        ErrorCode:
          default: 0
          title: Errorcode
          type: integer
        Reason:
          title: Reason
          type: string
      title: Result
      type: object